rename doc macros

libs/main/core/picout.h

@@ -1,5 +1,5 @@
-/*! \file picout.h
- * \brief Universal output to console class
+/*! @file picout.h
+ * @brief Universal output to console class
 */
 /*
 	PIP - Platform Independent Primitives
@@ -27,10 +27,10 @@
 
 #ifdef DOXYGEN
 
-//! \brief Macro used for conditional (piDebug) output to PICout
+//! @brief Macro used for conditional (piDebug) output to PICout
 #  define piCout
 
-//! \relatesalso PIObject \brief Macro used for conditional (piDebug and PIObject::debug()) output to PICout for subclasses of PIObject
+//! \relatesalso PIObject @brief Macro used for conditional (piDebug and PIObject::debug()) output to PICout for subclasses of PIObject
 #  define piCoutObj
 
 #else
@@ -42,10 +42,10 @@
 class PIObject;
 
 
-//! \brief Namespace contains enums controlled PICout
+//! @brief Namespace contains enums controlled PICout
 namespace PICoutManipulators {
 
-	//! \brief Enum contains special characters
+	//! @brief Enum contains special characters
 	enum PICoutSpecialChar {
 		Null	/*! Null-character, '\\0' */,
 		NewLine	/*! New line character, '\\n' */,
@@ -54,7 +54,7 @@ namespace PICoutManipulators {
 		Quote	/*! Quote character, '"' */
 	};
 
-	//! \brief Enum contains immediate action
+	//! @brief Enum contains immediate action
 	enum PICoutAction {
 		Flush			/*! Flush the output */,
 		Backspace		/*! Remove last symbol */,
@@ -66,7 +66,7 @@ namespace PICoutManipulators {
 		RestoreControl	/*! Restore control flags, equivalent to \a restoreControl() */
 	};
 
-	//! \brief Enum contains control of PICout
+	//! @brief Enum contains control of PICout
 	enum PICoutControl {
 		AddNone			/*! No controls */ = 0x0,
 		AddSpaces		/*! Spaces will be appear after each output */ = 0x1,
@@ -77,7 +77,7 @@ namespace PICoutManipulators {
 		NoLock			/*! Don`t use mutex for output */ = 0x100,
 	};
 
-	//! \brief Enum contains output format
+	//! @brief Enum contains output format
 	enum PICoutFormat {
 		Bin			/*! Binary representation of integers */ = 0x01,
 		Oct			/*! Octal representation of integers */ = 0x02,
@@ -111,6 +111,26 @@ namespace PICoutManipulators {
 }
 
 
+/*! \class PICout
+ * @brief Class for formatted output similar std::cout
+ *
+ * \section PICout_sec0 Synopsis
+ * This class provide many stream operators for output with some features.
+ * Output to PICout is thread-sequential, i.e. doesn`t mixed from parallel
+ * threads.
+ *
+ * \section PICout_sec1 Features
+ * - insertion spaces between entries
+ * - insertion new line at the end of output
+ * - strings are quoted
+ * - custom output operator can be easily written
+ *
+ * \section PICout_ex0 Usage
+ * \snippet picout.cpp 0
+ *
+ * \section PICout_ex1 Writing your own output operator
+ * \snippet picout.cpp own
+ */
 
 class PIP_EXPORT PICout {
 public:
@@ -128,6 +148,19 @@ public:
 
 	~PICout();
 
+
+	/*! \class PICout::Notifier
+	 * @brief Class for emit notifications of PICout
+	 *
+	 * \section PICout_sec0 Synopsis
+	 * This class used as PICout events emitter. When
+	 * PICout constructs with external PIString* buffer
+	 * and some id, last copy of this PICout on delete
+	 * emit event "finished()" on object Notifier::object().
+	 * Sample:
+	 * \snippet picout.cpp notifier
+	 */
+
 	class PIP_EXPORT Notifier {
 	public:
 		static Notifier * instance();
@@ -137,7 +170,7 @@ public:
 		PIObject * o;
 	};
 
-	//! \brief Enum contains output devices of PICout
+	//! @brief Enum contains output devices of PICout
 	enum OutputDevice {
 		NoDevices  /** PICout is disabled */ = 0x0,
 		StdOut     /** Standard console output */ = 0x1,
@@ -259,17 +292,17 @@ public:
 	//! Restore control flags from internal stack \sa \a saveControl()
 	PICout & restoreControl();
 
-	/*! \brief Conditional put space character to output
+	/*! @brief Conditional put space character to output
 	 * \details If it is not a first output and control \a AddSpaces is set
 	 * space character is put \sa \a quote(), \a newLine() */
 	PICout & space();
 
-	/*! \brief Conditional put quote character to output
+	/*! @brief Conditional put quote character to output
 	 * \details If control \a AddQuotes is set
 	 * quote character is put \sa \a space(), \a newLine() */
 	PICout & quote();
 
-	/*! \brief Conditional put new line character to output
+	/*! @brief Conditional put new line character to output
 	 * \details If control \a AddNewLine is set
 	 * new line character is put \sa \a space(), \a quote() */
 	PICout & newLine();