diff --git a/cocos/math/CCAffineTransform.h b/cocos/math/CCAffineTransform.h index 86d23df392..f79a7f994f 100644 --- a/cocos/math/CCAffineTransform.h +++ b/cocos/math/CCAffineTransform.h @@ -31,6 +31,11 @@ THE SOFTWARE. #include "math/CCGeometry.h" #include "math/CCMath.h" +/** + * @addtogroup base + * @{ + */ + NS_CC_BEGIN /**@{ @@ -108,4 +113,7 @@ extern CC_DLL const AffineTransform AffineTransformIdentity; NS_CC_END +// end of base transform +/// @} + #endif // __MATH_CCAFFINETRANSFORM_H__ diff --git a/cocos/math/CCGeometry.h b/cocos/math/CCGeometry.h index d271b9cf1c..2420a882d8 100644 --- a/cocos/math/CCGeometry.h +++ b/cocos/math/CCGeometry.h @@ -32,13 +32,13 @@ THE SOFTWARE. #include "base/ccMacros.h" #include "math/CCMath.h" -NS_CC_BEGIN - /** - * @addtogroup data_structures + * @addtogroup base * @{ */ +NS_CC_BEGIN + class CC_DLL Size { public: @@ -207,9 +207,9 @@ public: static const Rect ZERO; }; -// end of data_structure group -/// @} - NS_CC_END +// end of base group +/// @} + #endif // __MATH_CCGEOMETRY_H__ diff --git a/cocos/math/CCMathBase.h b/cocos/math/CCMathBase.h index 9a8f8c78d0..a7fbbc8d4e 100644 --- a/cocos/math/CCMathBase.h +++ b/cocos/math/CCMathBase.h @@ -4,6 +4,11 @@ #include #include #include "platform/CCPlatformMacros.h" +/** + * @addtogroup base + * @{ + */ + /**Util macro for conversion from degrees to radians.*/ #define MATH_DEG_TO_RAD(x) ((x) * 0.0174532925f) /**Util macro for conversion from radians to degrees.*/ @@ -39,5 +44,9 @@ #define USING_NS_CC_MATH #endif +/** + * end of base group + * @} + */ #endif // __CCMATHBASE_H__ diff --git a/cocos/math/CCVertex.h b/cocos/math/CCVertex.h index a084a7168e..9a04d68c95 100644 --- a/cocos/math/CCVertex.h +++ b/cocos/math/CCVertex.h @@ -28,13 +28,13 @@ #include "base/ccTypes.h" -NS_CC_BEGIN - /** - * @addtogroup data_structures + * @addtogroup base * @{ */ +NS_CC_BEGIN + /** @file CCVertex.h */ /** converts a line to a polygon */ @@ -46,10 +46,11 @@ bool CC_DLL ccVertexLineIntersect(float Ax, float Ay, float Cx, float Cy, float Dx, float Dy, float *T); -// end of data_structures group -/// @} - NS_CC_END + +// end of base group +/// @} + #endif /* __CCVERTEX_H__ */ diff --git a/cocos/math/Mat4.h b/cocos/math/Mat4.h index cbdbf392a5..7de852bff9 100644 --- a/cocos/math/Mat4.h +++ b/cocos/math/Mat4.h @@ -31,6 +31,11 @@ #include #endif +/** + * @addtogroup base + * @{ + */ + NS_CC_MATH_BEGIN //class Plane; @@ -275,12 +280,9 @@ public: const Vec3& cameraUpVector, const Vec3& cameraForwardVector, Mat4* dst); - /** - * Fills in an existing Mat4 so that it reflects the coordinate system about a specified Plane. - * - * @param plane The Plane about which to create a reflection. - * @param dst A matrix to store the result in. - */ + //Fills in an existing Mat4 so that it reflects the coordinate system about a specified Plane. + //plane The Plane about which to create a reflection. + //dst A matrix to store the result in. //static void createReflection(const Plane& plane, Mat4* dst); /** @@ -485,11 +487,7 @@ public: bool inverse(); /** - * Stores the inverse of this matrix in the specified matrix. - * - * @param dst A matrix to store the invert of this matrix in. - * - * @return true if the the matrix can be inverted, false otherwise. + * Get the inversed matrix. */ Mat4 getInversed() const; @@ -546,9 +544,7 @@ public: void negate(); /** - * Negates this matrix and stores the result in dst. - * - * @param dst A matrix to store the result in. + Get the Negated matrix. */ Mat4 getNegated() const; @@ -867,9 +863,7 @@ public: void transpose(); /** - * Transposes this matrix and stores the result in dst. - * - * @param dst A matrix to store the result in. + * Get the Transposed matrix. */ Mat4 getTransposed() const; @@ -993,7 +987,10 @@ inline Vec4& operator*=(Vec4& v, const Mat4& m); inline const Vec4 operator*(const Mat4& m, const Vec4& v); NS_CC_MATH_END - +/** + end of base group + @} + */ #include "math/Mat4.inl" #endif // MATH_MAT4_H diff --git a/cocos/math/MathUtil.h b/cocos/math/MathUtil.h index 36b13e9ce8..602e515e1b 100644 --- a/cocos/math/MathUtil.h +++ b/cocos/math/MathUtil.h @@ -28,6 +28,11 @@ #include "CCMathBase.h" +/** + * @addtogroup base + * @{ + */ + NS_CC_MATH_BEGIN /** @@ -115,7 +120,10 @@ private: }; NS_CC_MATH_END - +/** + end of base group + @} + */ #define MATRIX_SIZE ( sizeof(float) * 16) #endif diff --git a/cocos/math/Quaternion.h b/cocos/math/Quaternion.h index 7e82c4a047..1554bace47 100644 --- a/cocos/math/Quaternion.h +++ b/cocos/math/Quaternion.h @@ -26,6 +26,11 @@ #include "math/Mat4.h" //#include "Plane.h" +/** + * @addtogroup base + * @{ + */ + NS_CC_MATH_BEGIN class Mat4; @@ -184,9 +189,8 @@ public: void conjugate(); /** - * Gets the conjugate of this quaternion in dst. + * Gets the conjugate of this quaternion. * - * @param dst A quaternion to store the conjugate in. */ Quaternion getConjugated() const; @@ -203,16 +207,12 @@ public: bool inverse(); /** - * Gets the inverse of this quaternion in dst. + * Gets the inverse of this quaternion. * * Note that the inverse of a quaternion is equal to its conjugate * when the quaternion is unit-length. For this reason, it is more * efficient to use the conjugate method directly when you know your * quaternion is already unit-length. - * - * @param dst A quaternion to store the inverse in. - * - * @return true if the inverse can be computed, false otherwise. */ Quaternion getInversed() const; @@ -241,13 +241,11 @@ public: void normalize(); /** - * Normalizes this quaternion and stores the result in dst. + * Get the normalized quaternion. * * If the quaternion already has unit length or if the length * of the quaternion is zero, this method simply copies - * this vector into dst. - * - * @param dst A quaternion to store the result in. + * this vector. */ Quaternion getNormalized() const; @@ -413,7 +411,10 @@ private: }; NS_CC_MATH_END - +/** + end of base group + @} + */ #include "Quaternion.inl" #endif diff --git a/cocos/math/TransformUtils.h b/cocos/math/TransformUtils.h index 7e889aa75c..a73e3855b1 100644 --- a/cocos/math/TransformUtils.h +++ b/cocos/math/TransformUtils.h @@ -31,6 +31,11 @@ THE SOFTWARE. #include "platform/CCGL.h" #include "base/ccMacros.h" +/** + * @addtogroup base + * @{ + */ + namespace cocos2d { struct AffineTransform; @@ -43,5 +48,8 @@ CC_DLL void CGAffineToGL(const AffineTransform &t, GLfloat *m); CC_DLL void GLToCGAffine(const GLfloat *m, AffineTransform *t); /**@}*/ }//namespace cocos2d - +/** + end of base group + @} + */ #endif // __SUPPORT_TRANSFORM_UTILS_H__ diff --git a/cocos/math/Vec2.h b/cocos/math/Vec2.h index bf4679c956..712c13671a 100644 --- a/cocos/math/Vec2.h +++ b/cocos/math/Vec2.h @@ -27,6 +27,11 @@ #include #include "math/CCMathBase.h" +/** + * @addtogroup base + * @{ + */ + NS_CC_MATH_BEGIN /** Clamp a value between from and to. @@ -245,13 +250,7 @@ public: void normalize(); /** - * Normalizes this vector and stores the result in dst. - * - * If the vector already has unit length or if the length - * of the vector is zero, this method simply copies the - * current vector into dst. - * - * @param dst The destination vector. + Get the normalized vector. */ Vec2 getNormalized() const; @@ -757,6 +756,11 @@ typedef Vec2 Point; NS_CC_MATH_END +/** + end of base group + @} + */ + #include "Vec2.inl" #endif // MATH_VEC2_H diff --git a/cocos/math/Vec3.h b/cocos/math/Vec3.h index d83fc3ab5a..62cc570afe 100644 --- a/cocos/math/Vec3.h +++ b/cocos/math/Vec3.h @@ -24,6 +24,11 @@ #include "math/CCMathBase.h" +/** + * @addtogroup base + * @{ + */ + NS_CC_MATH_BEGIN class Mat4; @@ -271,13 +276,7 @@ public: void normalize(); /** - * Normalizes this vector and stores the result in dst. - * - * If the vector already has unit length or if the length - * of the vector is zero, this method simply copies the - * current vector into dst. - * - * @param dst The destination vector. + * Get the normalized vector. */ Vec3 getNormalized() const; @@ -482,7 +481,10 @@ inline const Vec3 operator*(float x, const Vec3& v); //typedef Vec3 Point3; NS_CC_MATH_END - +/** + end of base group + @} + */ #include "Vec3.inl" #endif // MATH_VEC3_H diff --git a/cocos/math/Vec4.h b/cocos/math/Vec4.h index f9f05b6141..df00f38ca2 100644 --- a/cocos/math/Vec4.h +++ b/cocos/math/Vec4.h @@ -28,6 +28,11 @@ #include "math/CCMathBase.h" +/** + * @addtogroup base + * @{ + */ + NS_CC_MATH_BEGIN class Mat4; @@ -269,13 +274,7 @@ public: void normalize(); /** - * Normalizes this vector and stores the result in dst. - * - * If the vector already has unit length or if the length - * of the vector is zero, this method simply copies the - * current vector into dst. - * - * @param dst The destination vector. + * Get the normalized vector. */ Vec4 getNormalized() const; @@ -460,7 +459,10 @@ public: inline const Vec4 operator*(float x, const Vec4& v); NS_CC_MATH_END - +/** + end of base group + @} + */ #include "math/Vec4.inl" #endif // MATH_VEC4_H diff --git a/cocos/renderer/CCBatchCommand.h b/cocos/renderer/CCBatchCommand.h index 01f2374c78..d565164d3e 100644 --- a/cocos/renderer/CCBatchCommand.h +++ b/cocos/renderer/CCBatchCommand.h @@ -27,6 +27,11 @@ #include "renderer/CCRenderCommand.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class TextureAtlas; @@ -73,4 +78,8 @@ protected: }; NS_CC_END +/** + end of support group + @} + */ #endif //_CC_BATCHCOMMAND_H_ diff --git a/cocos/renderer/CCCustomCommand.h b/cocos/renderer/CCCustomCommand.h index 748c5d4203..a32823d421 100644 --- a/cocos/renderer/CCCustomCommand.h +++ b/cocos/renderer/CCCustomCommand.h @@ -28,6 +28,11 @@ #include "renderer/CCRenderCommand.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN /** Custom command is used for call custom openGL command which can not be done by other commands, @@ -68,5 +73,8 @@ protected: }; NS_CC_END - +/** + end of support group + @} + */ #endif //_CC_CUSTOMCOMMAND_H_ diff --git a/cocos/renderer/CCGLProgram.h b/cocos/renderer/CCGLProgram.h index a5d8beb51c..c95dca151c 100644 --- a/cocos/renderer/CCGLProgram.h +++ b/cocos/renderer/CCGLProgram.h @@ -38,6 +38,11 @@ THE SOFTWARE. #include "platform/CCGL.h" #include "math/CCMath.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class GLProgram; @@ -514,5 +519,8 @@ protected: }; NS_CC_END - +/** + end of support group + @} + */ #endif /* __CCGLPROGRAM_H__ */ diff --git a/cocos/renderer/CCGLProgramCache.h b/cocos/renderer/CCGLProgramCache.h index cf9783e78d..db740dd1e2 100644 --- a/cocos/renderer/CCGLProgramCache.h +++ b/cocos/renderer/CCGLProgramCache.h @@ -33,15 +33,15 @@ THE SOFTWARE. #include "base/CCRef.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class GLProgram; -/** - * @addtogroup shaders - * @{ - */ - /** GLProgramCache Singleton that stores manages GLProgram objects (shaders) @since v2.0 @@ -109,9 +109,8 @@ private: std::unordered_map _programs; }; +NS_CC_END // end of shaders group /// @} -NS_CC_END - #endif /* __CCGLPROGRAMCACHE_H__ */ diff --git a/cocos/renderer/CCGLProgramState.h b/cocos/renderer/CCGLProgramState.h index 3a4ba8a4ff..5e7fb45998 100644 --- a/cocos/renderer/CCGLProgramState.h +++ b/cocos/renderer/CCGLProgramState.h @@ -33,6 +33,11 @@ THE SOFTWARE. #include "math/Vec3.h" #include "math/Vec4.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class GLProgram; @@ -305,4 +310,8 @@ protected: NS_CC_END +/** + end of support group + @} + */ #endif /* __CCGLPROGRAMSTATE_H__ */ diff --git a/cocos/renderer/CCGLProgramStateCache.h b/cocos/renderer/CCGLProgramStateCache.h index e2638eda3d..7d7db28a5c 100644 --- a/cocos/renderer/CCGLProgramStateCache.h +++ b/cocos/renderer/CCGLProgramStateCache.h @@ -32,6 +32,11 @@ THE SOFTWARE. #include "math/Vec3.h" #include "math/Vec4.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class GLProgram; @@ -66,5 +71,8 @@ protected: }; NS_CC_END - +/** + end of support group + @} + */ #endif /* __CCGLPROGRAMSTATECACHE_H__ */ diff --git a/cocos/renderer/CCGroupCommand.h b/cocos/renderer/CCGroupCommand.h index 432d180949..feb7bfde7d 100644 --- a/cocos/renderer/CCGroupCommand.h +++ b/cocos/renderer/CCGroupCommand.h @@ -32,6 +32,11 @@ #include "base/CCRef.h" #include "CCRenderCommand.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN //Used for internal @@ -76,4 +81,8 @@ protected: NS_CC_END +/** + end of support group + @} + */ #endif //_CC_GROUPCOMMAND_H_ diff --git a/cocos/renderer/CCPrimitive.h b/cocos/renderer/CCPrimitive.h index fc2b2c056d..7be6491887 100644 --- a/cocos/renderer/CCPrimitive.h +++ b/cocos/renderer/CCPrimitive.h @@ -27,6 +27,11 @@ #include "renderer/CCVertexIndexData.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class IndexBuffer; @@ -80,4 +85,8 @@ protected: NS_CC_END +/** + end of support group + @} + */ #endif //__CC_PRIMITIVE_H__ diff --git a/cocos/renderer/CCPrimitiveCommand.h b/cocos/renderer/CCPrimitiveCommand.h index 9fba38e1fd..535d2e7219 100644 --- a/cocos/renderer/CCPrimitiveCommand.h +++ b/cocos/renderer/CCPrimitiveCommand.h @@ -28,6 +28,11 @@ #include "renderer/CCPrimitive.h" #include "renderer/CCRenderCommand.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class GLProgramState; /** @@ -82,4 +87,8 @@ protected: NS_CC_END +/** + end of support group + @} + */ #endif //_CC_PRIMITIVE_COMMAND_H__ diff --git a/cocos/renderer/CCQuadCommand.h b/cocos/renderer/CCQuadCommand.h index 0f90e6488a..bfd35376db 100644 --- a/cocos/renderer/CCQuadCommand.h +++ b/cocos/renderer/CCQuadCommand.h @@ -28,6 +28,11 @@ #include "renderer/CCRenderCommand.h" #include "renderer/CCGLProgramState.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN /** @@ -97,4 +102,8 @@ protected: NS_CC_END +/** + end of support group + @} + */ #endif //_CC_QUADCOMMAND_H_ diff --git a/cocos/renderer/CCRenderCommand.h b/cocos/renderer/CCRenderCommand.h index 811edeabff..5bc94c5931 100644 --- a/cocos/renderer/CCRenderCommand.h +++ b/cocos/renderer/CCRenderCommand.h @@ -31,6 +31,11 @@ #include "platform/CCPlatformMacros.h" #include "base/ccTypes.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN /** Base class of the `RenderCommand` hierarchy. @@ -124,5 +129,8 @@ protected: }; NS_CC_END - +/** + end of support group + @} + */ #endif //__CCRENDERCOMMAND_H_ diff --git a/cocos/renderer/CCRenderer.h b/cocos/renderer/CCRenderer.h index 31f06750ff..61f2510db8 100644 --- a/cocos/renderer/CCRenderer.h +++ b/cocos/renderer/CCRenderer.h @@ -34,6 +34,11 @@ #include "renderer/CCGLProgram.h" #include "platform/CCGL.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class EventListenerCustom; @@ -260,4 +265,8 @@ protected: NS_CC_END +/** + end of support group + @} + */ #endif //__CC_RENDERER_H_ diff --git a/cocos/renderer/CCTrianglesCommand.h b/cocos/renderer/CCTrianglesCommand.h index 65fb2acd8e..8c7a1ffcac 100644 --- a/cocos/renderer/CCTrianglesCommand.h +++ b/cocos/renderer/CCTrianglesCommand.h @@ -28,6 +28,11 @@ #include "renderer/CCRenderCommand.h" #include "renderer/CCGLProgramState.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN /** Command used to render one or more Triangles, which is similar to QuadCommand. @@ -108,5 +113,8 @@ protected: }; NS_CC_END - +/** + end of support group + @} + */ #endif // defined(__CC_TRIANGLES_COMMAND__) diff --git a/cocos/renderer/CCVertexIndexBuffer.h b/cocos/renderer/CCVertexIndexBuffer.h index 68a9e70a9a..b71da9fcef 100644 --- a/cocos/renderer/CCVertexIndexBuffer.h +++ b/cocos/renderer/CCVertexIndexBuffer.h @@ -29,6 +29,11 @@ #include "base/CCRef.h" #include "platform/CCGL.h" +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class EventListenerCustom; @@ -253,4 +258,8 @@ public: NS_CC_END +/** + end of support group + @} + */ #endif /* __CC_VERTEX_INDEX_BUFFER_H__*/ diff --git a/cocos/renderer/CCVertexIndexData.h b/cocos/renderer/CCVertexIndexData.h index 4470f928b8..65aade3ee2 100644 --- a/cocos/renderer/CCVertexIndexData.h +++ b/cocos/renderer/CCVertexIndexData.h @@ -28,6 +28,11 @@ #include "base/CCRef.h" #include +/** + * @addtogroup support + * @{ + */ + NS_CC_BEGIN class VertexBuffer; @@ -175,5 +180,8 @@ protected: }; NS_CC_END - +/** + end of support group + @} + */ #endif //__CC_VERTEX_INDEX_DATA_H__ diff --git a/cocos/renderer/ccShaders.h b/cocos/renderer/ccShaders.h index 108bdc3a44..3c7963a483 100644 --- a/cocos/renderer/ccShaders.h +++ b/cocos/renderer/ccShaders.h @@ -31,13 +31,13 @@ THE SOFTWARE. #include "platform/CCGL.h" #include "platform/CCPlatformMacros.h" -NS_CC_BEGIN - /** - * @addtogroup shaders + * @addtogroup support * @{ */ +NS_CC_BEGIN + extern CC_DLL const GLchar * ccPosition_uColor_frag; extern CC_DLL const GLchar * ccPosition_uColor_vert; @@ -86,10 +86,12 @@ extern CC_DLL const GLchar * cc3D_Particle_tex_frag; extern CC_DLL const GLchar * cc3D_Particle_color_frag; extern CC_DLL const GLchar * cc3D_Skybox_vert; extern CC_DLL const GLchar * cc3D_Skybox_frag; -// end of shaders group -/// @} + NS_CC_END - +/** + end of support group + @} + */ /// @endcond #endif /* __CCSHADER_H__ */