Subject: [Boost-commit] svn:boost r85374 - in trunk/boost/log: . expressions
From: andrey.semashev_at_[hidden]
Date: 2013-08-17 09:57:15
Author: andysem
Date: 2013-08-17 09:57:14 EDT (Sat, 17 Aug 2013)
New Revision: 85374
URL: http://svn.boost.org/trac/boost/changeset/85374
Log:
Docs improvements.
Text files modified:
trunk/boost/log/expressions/filter.hpp | 4 ++--
trunk/boost/log/expressions/formatter.hpp | 4 ++--
trunk/boost/log/trivial.hpp | 19 +++++++++++++++++--
3 files changed, 21 insertions(+), 6 deletions(-)
Modified: trunk/boost/log/expressions/filter.hpp
==============================================================================
--- trunk/boost/log/expressions/filter.hpp Sat Aug 17 09:51:03 2013 (r85373)
+++ trunk/boost/log/expressions/filter.hpp 2013-08-17 09:57:14 EDT (Sat, 17 Aug 2013) (r85374)
@@ -71,7 +71,7 @@
{
}
/*!
- * Move constructor
+ * Move constructor. The moved-from filter is left in an unspecified state.
*/
filter(BOOST_RV_REF(filter) that) BOOST_NOEXCEPT : m_Filter(boost::move(that.m_Filter))
{
@@ -92,7 +92,7 @@
}
/*!
- * Move assignment.
+ * Move assignment. The moved-from filter is left in an unspecified state.
*/
filter& operator= (BOOST_RV_REF(filter) that) BOOST_NOEXCEPT
{
Modified: trunk/boost/log/expressions/formatter.hpp
==============================================================================
--- trunk/boost/log/expressions/formatter.hpp Sat Aug 17 09:51:03 2013 (r85373)
+++ trunk/boost/log/expressions/formatter.hpp 2013-08-17 09:57:14 EDT (Sat, 17 Aug 2013) (r85374)
@@ -94,7 +94,7 @@
{
}
/*!
- * Move constructor
+ * Move constructor. The moved-from formatter is left in an unspecified state.
*/
basic_formatter(BOOST_RV_REF(this_type) that) BOOST_NOEXCEPT : m_Formatter(boost::move(that.m_Formatter))
{
@@ -115,7 +115,7 @@
}
/*!
- * Move assignment.
+ * Move assignment. The moved-from formatter is left in an unspecified state.
*/
basic_formatter& operator= (BOOST_RV_REF(this_type) that) BOOST_NOEXCEPT
{
Modified: trunk/boost/log/trivial.hpp
==============================================================================
--- trunk/boost/log/trivial.hpp Sat Aug 17 09:51:03 2013 (r85373)
+++ trunk/boost/log/trivial.hpp 2013-08-17 09:57:14 EDT (Sat, 17 Aug 2013) (r85374)
@@ -51,6 +51,7 @@
//! Returns stringized enumeration value or \c NULL, if the value is not valid
BOOST_LOG_API const char* to_string(severity_level lvl);
+//! Outputs stringized representation of the severity level to the stream
template< typename CharT, typename TraitsT >
inline std::basic_ostream< CharT, TraitsT >& operator<< (
std::basic_ostream< CharT, TraitsT >& strm, severity_level lvl)
@@ -63,6 +64,7 @@
return strm;
}
+//! Reads stringized representation of the severity level from the stream
template< typename CharT, typename TraitsT >
BOOST_LOG_API std::basic_istream< CharT, TraitsT >& operator>> (
std::basic_istream< CharT, TraitsT >& strm, severity_level& lvl);
@@ -74,7 +76,12 @@
typedef sources::severity_logger< severity_level > logger_type;
#endif
-//! Trivial logger tag
+/*!
+ * \brief Trivial logger tag
+ *
+ * This tag can be used to acquire the logger that is used with lrivial logging macros.
+ * This may be useful when the logger is used with other macros which require a logger.
+ */
struct logger
{
//! Logger type
@@ -93,7 +100,15 @@
#endif
};
-//! The macro is used to initiate logging
+/*!
+ * The macro is used to initiate logging. The \c lvl argument of the macro specifies one of the following
+ * severity levels: \c trace, \c debug, \c info, \c warning, \c error or \c fatal (see \c severity_level enum).
+ * Following the macro, there may be a streaming expression that composes the record message string. For example:
+ *
+ * \code
+ * BOOST_LOG_TRIVIAL(info) << "Hello, world!";
+ * \endcode
+ */
#define BOOST_LOG_TRIVIAL(lvl)\
BOOST_LOG_STREAM_WITH_PARAMS(::boost::log::trivial::logger::get(),\
(::boost::log::keywords::severity = ::boost::log::trivial::lvl))