Docs missing info about which headers to include?
I'm new to much of boost. It is less than ideal to have to search through boost headers to find which ones to include for a class (e.g. boost::scoped_lock). Where can I find information about which headers the classes are in? It does not seem to be in the documentation, e.g.: http://www.boost.org/doc/libs/1_37_0/doc/html/boost/interprocess/scoped_lock... This is strange to me, since this type of info is pretty fundamental. In that particular case, after trying boost/thread/scoped_lock.hpp and boost/interprocess/scoped_lock.hpp, I resorted to searching through files and eventually found it in boost/interprocess/sync/scoped_lock.hpp (among other locations, but that one seems to be the most reasonable). Is there some place in the boost docs where I can find what headers to include to use the classes? Thanks, Jason
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On Tuesday 21 July 2009, Jason Cipriani wrote:
Where can I find information about which headers the classes are in? It does not seem to be in the documentation, e.g.:
http://www.boost.org/doc/libs/1_37_0/doc/html/boost/interprocess/scoped_loc k.html
Hit the "up arrow" navigation icon from linked page above, and it will take you to the synopsis of the header file. Newer versions of boostbook (like that used to generate the 1.39 documentation) do include the header file on the class synopsis page. -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.9 (GNU/Linux) iEYEARECAAYFAkpmD7wACgkQ5vihyNWuA4X5pwCgvA6h0jX4jIsMFjO0eW9XyT+W SeAAoMchLQrz0em1GY28DEFCVd1HS4eE =Sp15 -----END PGP SIGNATURE-----
On Tue, Jul 21, 2009 at 2:58 PM, Frank Mori Hess
On Tuesday 21 July 2009, Jason Cipriani wrote:
Where can I find information about which headers the classes are in? It does not seem to be in the documentation, e.g.:
http://www.boost.org/doc/libs/1_37_0/doc/html/boost/interprocess/scoped_lock...
Hit the "up arrow" navigation icon from linked page above, and it will take you to the synopsis of the header file. Newer versions of boostbook (like that used to generate the 1.39 documentation) do include the header file on the class synopsis page.
Great! This is exactly what I was looking for. Thanks, Jason
participants (2)
-
Frank Mori Hess
-
Jason Cipriani