TONY: Cleaned up the @defgroup comments

scummvm · Jun 16, 2012 · a91553e · a91553e
1 parent 8335c25
commit a91553e
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 4 deletions.
diff --git a/engines/tony/custom.cpp b/engines/tony/custom.cpp
@@ -131,14 +131,15 @@ void LoadChangedHotspot(Common::InSaveFile *f) {
 
 
 /**
- * @defgroup Classes required for custom functions
+ * Classes required for custom functions
  *
  * Tony (To Move him)     -> You can do MPAL through the animation? I really think so
  *
  * SendMessage -> I'd say just theEngine.SendMessage()
  * ChangeLocation -> theEngine.ChangeLocation()
  * AddInventory -> theEngine.AddInventory()
 */
+
 void MCharResetCodes(void) {
 	for (int i = 0; i < 10; i++)
 		GLOBALS._mCharacter[i]._item = GLOBALS._loc->getItemFromCode(GLOBALS._mCharacter[i]._code);

diff --git a/engines/tony/globals.h b/engines/tony/globals.h
@@ -253,8 +253,8 @@ class Globals {
 
 	/**
 	 * @defgroup MPAL variables
-	 *
-	*/
+	 */
+	//@{
 	uint32                  _mpalError;
 	LPITEMIRQFUNCTION       _lpiifCustom;
 	LPLPCUSTOMFUNCTION      _lplpFunctions;
@@ -292,6 +292,8 @@ class Globals {
 	uint32                  _nExecutingDialog;
 	uint32                  _nExecutingChoice;
 	uint32                  _nSelectedChoice;
+
+	//@}
 };
 
 } // End of namespace Tony

diff --git a/engines/tony/mpal/expr.cpp b/engines/tony/mpal/expr.cpp
@@ -42,6 +42,7 @@ namespace MPAL {
 /**
  * @defgroup Mathamatical operations
  */
+//@{
 
 #define OP_MUL     ((1  << 4) | 0)
 #define OP_DIV     ((1  << 4) | 1)
@@ -73,9 +74,12 @@ enum ExprListTypes {
 	ELT_PARENTH2 = 4
 };
 
+//@}
+
 /**
  * @defgroup Structures
  */
+//@{
 
 /**
  * Mathamatical framework to manage operations
@@ -96,6 +100,7 @@ typedef struct {
 } EXPRESSION;
 typedef EXPRESSION *LPEXPRESSION;
 
+//@}
 
 /**
  * Duplicate a mathematical expression.

diff --git a/engines/tony/mpal/loadmpc.cpp b/engines/tony/mpal/loadmpc.cpp
@@ -517,6 +517,7 @@ static const byte *ParseLocation(const byte *lpBuf, LPMPALLOCATION lpmlLocation)
 /**
  * @defgroup Exported functions
  */
+//@{
 
 /**
  * Reads and interprets the MPC file, and create structures for various directives 
@@ -796,6 +797,8 @@ void FreeMpc() {
 	}
 }
 
+//@}
+
 } // end of namespace MPAL
 
 } // end of namespace Tony
diff --git a/engines/tony/mpal/mpal.cpp b/engines/tony/mpal/mpal.cpp
@@ -1395,6 +1395,7 @@ bool doSelection(uint32 i, uint32 dwData) {
 /**
  * @defgroup Exported functions
  */
+//@{
 
 /**
  * Initialises the MPAL library and opens the .MPC file, which will be used for all queries.
@@ -2918,6 +2919,8 @@ void mpalDumpDialogs(void) {
 	unlockDialogs();
 }
 
+//@}
+
 } // end of namespace MPAL
 
 } // end of namespace Tony
diff --git a/engines/tony/mpal/mpal.h b/engines/tony/mpal/mpal.h
@@ -187,6 +187,7 @@ typedef LPITEMIRQFUNCTION* LPLPITEMIRQFUNCTION;
  *
  * The following are defines used for simplifying calling the mpalQuery variants
  */
+//@{
 
 /**
  * Gets the current version of MPAL
@@ -386,11 +387,12 @@ typedef LPITEMIRQFUNCTION* LPLPITEMIRQFUNCTION;
 #define mpalQueryDoDialog(nDialog,nGroup)               \
         mpalQueryDWORD(MPQ_DO_DIALOG, (uint32)(nDialog),(uint32)(nGroup))
 
+//@}
 
 /**
  * @defgroup Functions exported to the main game
  */
-
+//@{
 
 /**
  * Initializes the MPAL library, and opens an .MPC file, which will be 'used for all queries
@@ -526,6 +528,8 @@ void lockVar(void);
  */
 void unlockVar(void);
 
+//@}
+
 } // end of namespace MPAL
 
 } // end of namespace Tony