src/MessageLog.h

changeset 650
db7146a87ae4
parent 647
b87941923eb4
--- a/src/MessageLog.h	Wed Mar 05 18:30:22 2014 +0200
+++ b/src/MessageLog.h	Wed Mar 05 18:31:22 2014 +0200
@@ -26,14 +26,14 @@
 class QTimer;
 
 //!
-//! @brief Manages the list of messages at the top-left of the renderer.
+//! \brief Manages the list of messages at the top-left of the renderer.
 //!
 //! The message manager is an object which keeps track of messages that appear
 //! on the renderer's screen. Each line is contained in a separate object which
 //! contains the text, expiry time and alpha. The message manager is doubly
 //! linked to its corresponding renderer.
 //!
-//! Message manager calls its @c tick() function regularly to update the messages,
+//! Message manager calls its \c tick() function regularly to update the messages,
 //! where each line's expiry is checked for. Lines begin to fade out when nearing
 //! their expiry. If the message manager's lines change, the renderer undergoes
 //! repainting.
@@ -44,19 +44,19 @@
 	PROPERTY (public, GLRenderer*, renderer, setRenderer, STOCK_WRITE)
 
 	public:
-		//! @class MessageManager::Line
+		//! \class MessageManager::Line
 		//! A single line of the message log.
 		class Line
 		{
 			public:
-				//! Constructs a line with the given @c text
+				//! Constructs a line with the given \c text
 				Line (QString text);
 
 				//! Check this line's expiry and update alpha accordingly.
-				//! @c changed is updated to whether the line has somehow
+				//! \c changed is updated to whether the line has somehow
 				//! changed since the last update.
-				//! @returns true if the line is to still stick around, false
-				//! @returns if it expired.
+				//! \returns true if the line is to still stick around, false
+				//! \returns if it expired.
 				bool update (bool& changed);
 
 				QString text;
@@ -67,10 +67,10 @@
 		//! Constructs the message manager.
 		explicit MessageManager (QObject* parent = null);
 
-		//! Adds a line with the given @c text to the message manager.
+		//! Adds a line with the given \c text to the message manager.
 		void addLine (QString line);
 
-		//! @returns all active lines in the message manager.
+		//! \returns all active lines in the message manager.
 		const QList<Line>& getLines() const;
 
 	private:

mercurial