issue #171, add @brief in class annotate

Author: Walzer

cocos2dx/include/CCAtlasNode.h

@@ -32,7 +32,7 @@ THE SOFTWARE.
 namespace   cocos2d {
 class CCTextureAtlas;
 
-/** CCAtlasNode is a subclass of CCNode that implements the CCRGBAProtocol and
+/** @brief CCAtlasNode is a subclass of CCNode that implements the CCRGBAProtocol and
 CCTextureProtocol protocol
 
 It knows how to render a TextureAtlas object.

cocos2dx/include/CCBitmapFontAtlas.h

@@ -64,7 +64,7 @@ namespace cocos2d{
 		kCCBitmapFontAtlasMaxChars = 2048, //256,
 	};
 
-	/** CCBitmapFontConfiguration has parsed configuration of the the .fnt file
+	/** @brief CCBitmapFontConfiguration has parsed configuration of the the .fnt file
 	@since v0.8
 	*/
 	class CCX_DLL CCBitmapFontConfiguration : public NSObject
@@ -102,7 +102,7 @@ namespace cocos2d{
 		void purgeKerningDictionary();
 	};
 
-	/** CCBitmapFontAtlas is a subclass of CCSpriteSheet.
+	/** @brief CCBitmapFontAtlas is a subclass of CCSpriteSheet.
 
 	Features:
 	- Treats each character like a CCSprite. This means that each individual character can be:

cocos2dx/include/CCGrid3DAction.h

@@ -29,7 +29,7 @@ THE SOFTWARE.
 namespace cocos2d
 {
 	/** 
-	CCWaves3D action 
+	@brief CCWaves3D action 
 	*/
 	class CCX_DLL CCWaves3D : public CCGrid3DAction
 	{
@@ -57,7 +57,7 @@ namespace cocos2d
 		float m_fAmplitudeRate;
 	};
 
-	/** CCFlipX3D action */
+	/** @brief CCFlipX3D action */
 	class CCX_DLL CCFlipX3D : public CCGrid3DAction
 	{
 	public:
@@ -72,7 +72,7 @@ namespace cocos2d
 		static CCFlipX3D* actionWithDuration(ccTime duration);
 	};
 
-	/** CCFlipY3D action */
+	/** @brief CCFlipY3D action */
 	class CCX_DLL CCFlipY3D : public CCFlipX3D
 	{
 	public:
@@ -84,7 +84,7 @@ namespace cocos2d
 		static CCFlipY3D* actionWithDuration(ccTime duration);
 	};
 
-	/** CCLens3D action */
+	/** @brief CCLens3D action */
 	class CCX_DLL CCLens3D : public CCGrid3DAction
 	{
 	public:
@@ -110,7 +110,7 @@ namespace cocos2d
 		CGPoint m_lastPosition;
 	};
 
-	/** CCRipple3D action */
+	/** @brief CCRipple3D action */
 	class CCX_DLL CCRipple3D : public CCGrid3DAction
 	{
 	public:
@@ -142,7 +142,7 @@ namespace cocos2d
 		float m_fAmplitudeRate;
 	};
 
-	/** CCShaky3D action */
+	/** @brief CCShaky3D action */
 	class CCX_DLL CCShaky3D : public CCGrid3DAction
 	{
 	public:
@@ -160,7 +160,7 @@ namespace cocos2d
 		bool m_bShakeZ;
 	};
 
-	/** CCLiquid action */
+	/** @brief CCLiquid action */
 	class CCX_DLL CCLiquid : public CCGrid3DAction
 	{
 	public:
@@ -186,7 +186,7 @@ namespace cocos2d
 		float m_fAmplitudeRate;
 	};
 
-	/** CCWaves action */
+	/** @brief CCWaves action */
 	class CCX_DLL CCWaves : public CCGrid3DAction
 	{
 	public:
@@ -215,7 +215,7 @@ namespace cocos2d
 		bool m_bHorizontal;
 	};
 
-	/** CCTwirl action */
+	/** @brief CCTwirl action */
 	class CCX_DLL CCTwirl : public CCGrid3DAction
 	{
 	public:

cocos2dx/include/CCGridAction.h

@@ -92,7 +92,7 @@ namespace cocos2d
         static CCTiledGrid3DAction* actionWithSize(ccGridSize gridSize, ccTime duration);
 	};
 
-	/** CCAccelDeccelAmplitude action */
+	/** @brief CCAccelDeccelAmplitude action */
 	class CCX_DLL CCAccelDeccelAmplitude : public CCIntervalAction
 	{
 	public:
@@ -117,7 +117,7 @@ namespace cocos2d
 		CCIntervalAction *m_pOther;
 	};
 
-	/** CCAccelAmplitude action */
+	/** @brief CCAccelAmplitude action */
 	class CCX_DLL CCAccelAmplitude : public CCIntervalAction
 	{
 	public:
@@ -142,7 +142,7 @@ namespace cocos2d
 		CCIntervalAction *m_pOther;
 	};
 
-	/** CCDeccelAmplitude action */
+	/** @brief CCDeccelAmplitude action */
 	class CCX_DLL CCDeccelAmplitude : public CCIntervalAction
 	{
 	public:
@@ -167,7 +167,7 @@ namespace cocos2d
 		CCIntervalAction *m_pOther;
 	};
 
-	/** CCStopGrid action.
+	/** @brief CCStopGrid action.
 	 @warning Don't call this action if another grid action is active.
 	 Call if you want to remove the the grid effect. Example:
 	 CCSequence::actions(Lens::action(...), CCStopGrid::action(...), NULL);
@@ -182,7 +182,7 @@ namespace cocos2d
 		static CCStopGrid* action(void);
 	};
 
-	/** CCReuseGrid action */
+	/** @brief CCReuseGrid action */
 	class CCX_DLL CCReuseGrid : public CCInstantAction
 	{
 	public:

cocos2dx/include/CCInstantAction.h

@@ -48,7 +48,7 @@ namespace cocos2d {
 		virtual CCFiniteTimeAction * reverse(void);
 	};
 
-	/** Show the node
+	/** @brief Show the node
 	*/
 	class CCX_DLL CCShow : public CCInstantAction
 	{

cocos2dx/include/CCLabel.h

@@ -28,7 +28,7 @@ THE SOFTWARE.
 
 namespace cocos2d{
 
-	/** CCLabel is a subclass of CCTextureNode that knows how to render text labels
+	/** @brief CCLabel is a subclass of CCTextureNode that knows how to render text labels
 	*
 	* All features from CCTextureNode are valid in CCLabel
 	*

cocos2dx/include/CCLabelAtlas.h

@@ -26,7 +26,7 @@ THE SOFTWARE.
 #include "CCAtlasNode.h"
 namespace cocos2d{
 
-	/** CCLabelAtlas is a subclass of CCAtlasNode.
+	/** @brief CCLabelAtlas is a subclass of CCAtlasNode.
 
 	It can be as a replacement of CCLabel since it is MUCH faster.
 

cocos2dx/include/CCLayer.h

@@ -35,13 +35,13 @@ namespace   cocos2d {
 //
 // CCLayer
 //
-/** CCLayer is a subclass of CCNode that implements the TouchEventsDelegate protocol.
+/** @brief CCLayer is a subclass of CCNode that implements the TouchEventsDelegate protocol.
 
 All features from CCNode are valid, plus the following new features:
 - It can receive iPhone Touches
 - It can receive Accelerometer input
 */
-/// @todo public UIAccelerometerDelegate
+// @todo public UIAccelerometerDelegate
 class CCX_DLL CCLayer : public CCNode, public CCTouchDelegate//, public UIAccelerometerDelegate
 {
 public:
@@ -84,7 +84,7 @@ class CCX_DLL CCLayer : public CCNode, public CCTouchDelegate//, public UIAccele
 //
 // CCColorLayer
 //
-/** CCColorLayer is a subclass of CCLayer that implements the CCRGBAProtocol protocol.
+/** @brief CCColorLayer is a subclass of CCLayer that implements the CCRGBAProtocol protocol.
 
 All features from CCLayer are valid, plus the following new features:
 - opacity
@@ -136,7 +136,7 @@ private :
 	void updateColor();
 };
 
-/** CCMultipleLayer is a CCLayer with the ability to multiplex it's children.
+/** @brief CCMultipleLayer is a CCLayer with the ability to multiplex it's children.
 Features:
 - It supports one or more children
 - Only one children will be active a time

cocos2dx/include/CCMenu.h

@@ -35,7 +35,7 @@ namespace cocos2d{
 		kMenuStateTrackingTouch
 	} MenuState;
 
-	/** A CCMenu
+	/** @brief A CCMenu
 	* 
 	* Features and Limitation:
 	*  - You can add MenuItem objects in runtime using addChild:

cocos2dx/include/CCMenuItem.h

@@ -37,7 +37,7 @@ namespace cocos2d{
 
 #define kItemSize 32
 
-	/** CCMenuItem base class
+	/** @brief CCMenuItem base class
 	*
 	*  Subclass CCMenuItem (or any subclass) to create your custom CCMenuItem objects.
 	*/
@@ -70,7 +70,7 @@ namespace cocos2d{
 		SEL_MunuHandler		m_pfnSelector;
 	};
 
-	/** An abstract class for "label" CCMenuItemLabel items 
+	/** @brief An abstract class for "label" CCMenuItemLabel items 
 	Any CCNode that supports the CCLabelProtocol protocol can be added.
 	Supported nodes:
 	- CCBitmapFontAtlas
@@ -114,7 +114,7 @@ namespace cocos2d{
 		float		m_fOriginalScale;
 	};
 
-	/** A CCMenuItemAtlasFont
+	/** @brief A CCMenuItemAtlasFont
 	Helper class that creates a MenuItemLabel class with a LabelAtlas
 	*/
 	class CCX_DLL CCMenuItemAtlasFont : public CCMenuItemLabel
@@ -130,7 +130,7 @@ namespace cocos2d{
 		bool initFromString(const char *value, const char *charMapFile, int itemWidth, int itemHeight, char startCharMap, SelectorProtocol* target, SEL_MunuHandler selector);
 	};
 
-	/** A CCMenuItemFont
+	/** @brief A CCMenuItemFont
 	Helper class that creates a CCMenuItemLabel class with a Label
 	*/
 	class CCX_DLL CCMenuItemFont : public CCMenuItemLabel
@@ -154,7 +154,7 @@ namespace cocos2d{
 		bool initFromString(const char *value, SelectorProtocol* target, SEL_MunuHandler selector);
 	};
 
-	/** CCMenuItemSprite accepts CCNode<CCRGBAProtocol> objects as items.
+	/** @brief CCMenuItemSprite accepts CCNode<CCRGBAProtocol> objects as items.
 	The images has 3 different states:
 	- unselected image
 	- selected image
@@ -195,7 +195,7 @@ namespace cocos2d{
 		virtual CCRGBAProtocol* convertToRGBAProtocol() { return (CCRGBAProtocol*)this; }
 	};
 
-	/** CCMenuItemImage accepts images as items.
+	/** @brief CCMenuItemImage accepts images as items.
 	The images has 3 different states:
 	- unselected image
 	- selected image
@@ -225,7 +225,7 @@ namespace cocos2d{
 		virtual GLubyte getOpacity();
 	};
 
-	/** A CCMenuItemToggle
+	/** @brief A CCMenuItemToggle
 	A simple container class that "toggles" it's inner items
 	The inner itmes can be any MenuItem
 	*/

cocos2dx/include/CCMotionStreak.h

@@ -28,7 +28,7 @@ THE SOFTWARE.
 namespace cocos2d {
 	class CCRibbon;
 	/**
-	* CCMotionStreak manages a Ribbon based on it's motion in absolute space.
+	* @brief CCMotionStreak manages a Ribbon based on it's motion in absolute space.
 	* You construct it with a fadeTime, minimum segment size, texture path, texture
 	* length and color. The fadeTime controls how long it takes each vertex in
 	* the streak to fade out, the minimum segment size it how many pixels the

cocos2dx/include/CCNode.h

@@ -48,7 +48,7 @@ enum {
 	kCCNodeTagInvalid = -1,
 };
 
-/** CCNode is the main element. Anything thats gets drawn or contains things that get drawn is a CCNode.
+/** @brief CCNode is the main element. Anything thats gets drawn or contains things that get drawn is a CCNode.
 The most popular CCNodes are: CCScene, CCLayer, CCSprite, CCMenu.
 
 The main features of a CCNode are:

cocos2dx/include/CCParallaxNode.h

@@ -30,7 +30,7 @@ THE SOFTWARE.
 namespace cocos2d {
 	struct _ccArray;
 
-	/** CCParallaxNode: A node that simulates a parallax scroller
+	/** @brief CCParallaxNode: A node that simulates a parallax scroller
 
 	The children will be moved faster / slower than the parent according the the parallax ratio.