Is there a way to view the built-in documentation in C++?

Question

I just started to learn C++ this month.

In Python, I can view the documentation of a built-in function (for example, str.find) by using help(str.find).

However, I've no idea about how to view the documentation of std::find in <algorithm>, for example.

Does anyone have ideas about a quick way to look up documentation of a function in C++?

BTW, there is no such header as `algorithm.h` in C++. So, yes, you need some documentation. — Lightness Races in Orbit, Feb 16 '13 at 13:01
Nobody else seems to really have mentioned getting a good IDE, I know that code::blocks shows some brief documentation while you type (along with autocomplete), but probably so to do other popular IDEs. — Bingo, Feb 17 '13 at 21:07

johnsyweb · Accepted Answer · 2013-02-16T13:19:51.927

C++ doesn't have built-in documentation like Python.

The most comprehensive online reference guide is C++ reference, which covers the last three standards. This is not the top hit on most search engines but the top hit is full of inaccuracies and should be avoided.

You can also download archives of the site for offline viewing (English link).

Does anyone have ideas about a quick way to look up documentation of a function in C++?

In Google Chrome, I have a search engine set up with the keyword "cpp" and the URL "http://en.cppreference.com/mwiki/index.php?title=Special%3ASearch&search=%s" so that I can type cpp std::find in the address bar to find details of std::find in my browser.

score 3 · Answer 2 · edited May 23 '17 at 12:04

C++ itself doesn't have "built-in documentation" per se. It is a language, not a system. Sure, Python is "just a language" too, but it's also an interpreter and this interpreter has certain features that C++ compilers don't have.

On Linux you may find manpages for what you need, because libstdc++ (GCC's C++ standard library implementation) installs them:

man std::string

C++ documentation may be found canonically at:

http://cppreference.com (peer-reviewed and well-regarded)
Your C++ book (peer-reviewed by SO)
The C++ standard (authoritative)

You should not use:

Wikipedia
SGI STL documentation (the SGI STL is not the same as the C++ Standard Library)
http:// cplusplus.com

To be fair, cplusplus.com has been improving too (perhaps thanks to the competition from cppreference), and is quick to react to error reports (even minute ones, like 'you said unspecified where it says undefined') — Cubbi, Apr 18 '13 at 21:37

score 1 · Answer 3 · edited Feb 16 '13 at 13:00

1

There is no such thing as builtin documentation in C++. You may have some documentation that comes with you compiler, but that is mainly for commercial products and vendor specific. You are best off using google to find your site of choice.

edited Feb 16 '13 at 13:00

Lightness Races in Orbit

378,754
76
643
1,055

answered Feb 16 '13 at 12:55

Thomas

4,980
2
15
30

Is there a way to view the built-in documentation in C++?

3 Answers3