Subject: [Boost-commit] svn:boost r71504 - sandbox/guild/mylibrary/boost/mylibrary
Date: 2011-04-26 09:24:48
Date: 2011-04-26 09:24:47 EDT (Tue, 26 Apr 2011)
New Revision: 71504
Added some PREDEFINED examples (and some minor edits).
Text files modified:
sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp | 19 +++++++++++--------
1 files changed, 11 insertions(+), 8 deletions(-)
--- sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp (original)
+++ sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp 2011-04-26 09:24:47 EDT (Tue, 26 Apr 2011)
@@ -11,6 +11,7 @@
#include <boost/config.hpp> // for workarounds.
\brief Template for Boost documentation.
@@ -25,18 +26,20 @@
but useful to allow just Doxygen manuals (no Quickbook or indexing).
These can provide a convenient compact index of the classes, files, namespaces and functions.
-They provide the Doxygen comments, but not the text from Quickbook.
+They provide the Doxygen C++ comments, but not the text from Quickbook.
These manuals are quickly produced using the Doxywizard GUI frontend.
A suitable Doxyfile holding the list of files to include etc
is conveniently placed in a /doc/doxygen sub-folder.
-Selecting this as the working directory from which doxygen will run as Step 1,
+Selecting this as the working directory from which Doxygen will run as Step 1,
and the run tab, and "run doxygen' in Step 2 should generate an html in the /doxygen sub-folder.
-The mainpage should give a hyperlink to the full html and pdf versions
+The mainpage can usefully give a hyperlink to the full html and pdf versions
that provide the full Quickbook generated information, for example:
-http://www.boost.org/doc/libs/my_library/index.html My Library Manual
+http://www.boost.org/doc/libs/my_library/index.html My Library Manual.
+https://svn.boost.org/svn/boost/sandbox/guild/mylibrary/libs/mylibrary/doc/mylibrary.pdf My Library PDF Manual.
@@ -77,17 +80,17 @@
A more detailed description of the destructor.
\warning Warning! This destructor may explode in your face!
- (The doxygen command warning will NOT be found by the index term warning,
- but words in the warning, like explode, WILL be found).
+ (The Doxygen command warning will NOT be found by the index term 'warning',
+ but words in the warning, like 'explode', WILL be found).
- //! A normal member function taking two arguments and returning an integer value.
+ //! A normal member function taking two arguments, and returning an integer value.
\param a an integer argument.
\param s a constant character pointer.
\return The test result.
- \sa Test(), ~Test(), testMeToo() and publicVar()
+ \sa Test(), ~Test(), testMeToo() and publicVar().
int test_me(int a, const char *s);
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk