[Performous-commit] Fredrik Klasson : [ ] Document \n vs std::endl behaviour.

[Fredrik K. <sci...@us...>]

Module: performous
Branch: master
Commit: 7479a8b266f37643cc02e1f8bb402010edff7c7a

Author: Fredrik Klasson <fr...@li...>
Date:   Wed Aug 25 12:27:54 2010 +0200

[ ] Document \n vs std::endl behaviour.

---

 game/log.cc |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

diff --git a/game/log.cc b/game/log.cc
index 648cb2a..9a28319 100644
--- a/game/log.cc
+++ b/game/log.cc
@@ -14,6 +14,7 @@
  * \brief The std::clog logger.
  *
  * The classification is \e discretionary, meaning that you can specify any message class you want but there are only 4 recommended classes: \p debug, \p info, \p warning and \p error.
+ * \attention Each new line (ended by <tt>std::endl</tt>) must be prefixed with the message classification. New lines by <tt>"\n"</tt> will belong to the previous line as far as the filter is concerned.
  *
  * The default log level is specified by logger::default_log_level.
  *