GCC Bugzilla – Bug 40380
class documentation should mention include file to use
Last modified: 2012-05-02 22:56:37 UTC
I was reading the documentation for unique_ptr:
This mentions unique_ptr.h -- but that is not a user-allowed header file.
Instead the user ought to write "#include <memory>". This is not mentioned
anywhere, but IMO it should be.
Agreed. Thanks for the feedback on docs. Will put this on the docs todo list.
Add documentation keyword
Just an update on this. From 4.6.0 onward, the file documentation for things like bits/unique_ptr.h now have forwarding text:
This is an internal header file, included by other library headers. Do not attempt to use it directly. Instead, include <memory>.
Definition in file unique_ptr.h.
I think this is useful, but not as useful as saying that to use std::unique_ptr one needs to include <memory>.