Subject: [Boost-commit] svn:boost r68695 - sandbox/guild/mylibrary/boost/mylibrary
From: pbristow_at_[hidden]
Date: 2011-02-07 13:50:52
Author: pbristow
Date: 2011-02-07 13:50:48 EST (Mon, 07 Feb 2011)
New Revision: 68695
URL: http://svn.boost.org/trac/boost/changeset/68695
Log:
Typos corrected.
Text files modified:
sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp | 24 ++++++++++++------------
1 files changed, 12 insertions(+), 12 deletions(-)
Modified: sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp
==============================================================================
--- sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp (original)
+++ sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp 2011-02-07 13:50:48 EST (Mon, 07 Feb 2011)
@@ -53,13 +53,15 @@
it is more convenient to use C style.
*/
public:
- //! An enum.
- /*! More detailed enum description.
- needing more than one line so using C style comment markers. */
+ //! An fully useless enum with 3 values.
+ /*! More detailed enum description,
+ needing more than one line,
+ so using C style comment markers.
+ */
enum test_enum {
- test_enum_val1, //!< Enum value TVal1 (not the < to link to the same line).
+ test_enum_val1, //!< Enum value TVal1 (Note: the use of < to link this Doxygen comment to the same line).
test_enum_val2, //!< Enum value TVal2.
- test_enum_val3 /*!< Enum value TVal3. (using C style comment markers).*/
+ test_enum_val3 /*!< Enum value TVal3. (Note: using C style comment markers).*/
};
//! A constructor.
@@ -107,14 +109,12 @@
}; // class myclass
int donowt(int i)
- { /*! Non-member free function that does nowt useful at all.
-
+ { /*!
+ Non-member free function that does nowt useful at all.
\param i is an argument that is ignored completely.
-
- \returns -1 always
- \pre No preconditions.
- \post No side effects.
-
+ \returns -1 always.
+ \pre No preconditions.
+ \post No side effects.
*/
return -1;
} // int donowt(int i)