diff --git a/cocos/2d/CCActionGrid.h b/cocos/2d/CCActionGrid.h index 8e4541e304..7fe70b8ca4 100644 --- a/cocos/2d/CCActionGrid.h +++ b/cocos/2d/CCActionGrid.h @@ -99,7 +99,7 @@ public: * @brief Get the vertex that belongs to certain position in the grid. * @param position The position of the grid. * @return Return a pointer of vertex. - * @js NA + * @js vertex * @lua NA */ Vec3 getVertex(const Vec2& position) const; @@ -114,7 +114,7 @@ public: * @brief Get the non-transformed vertex that belongs to certain position in the grid. * @param position The position of the grid. * @return Return a pointer of vertex. - * @js NA + * @js originalVertex * @lua NA */ Vec3 getOriginalVertex(const Vec2& position) const; @@ -129,7 +129,7 @@ public: * @brief Set a new vertex to a certain position of the grid. * @param position The position of the grid. * @param vertex The vertex will be used on the certain position of grid. - * @js NA + * @js setVertex * @lua NA */ void setVertex(const Vec2& position, const Vec3& vertex); @@ -153,7 +153,6 @@ public: * @param duration The duration of the action. It's a value in seconds. * @param gridSize Specify the grid size of the action. * @return A pointer of TiledGrid3DAction. If creation failed, return nil. - * @js NA * @lua NA */ static TiledGrid3DAction* create(float duration, const Size& gridSize); @@ -162,7 +161,7 @@ public: * @brief Get the tile that belongs to a certain position of the grid. * @param position The position of the tile want to get. * @return A quadrilateral of the tile. - * @js NA + * @js tile * @lua NA */ Quad3 getTile(const Vec2& position) const; @@ -177,7 +176,7 @@ public: * @brief Get the non-transformed tile that belongs to a certain position of the grid. * @param position The position of the tile want to get. * @return A quadrilateral of the tile. - * @js NA + * @js originalTile * @lua NA */ Quad3 getOriginalTile(const Vec2& position) const; @@ -192,7 +191,6 @@ public: * @brief Set a new tile to a certain position of the grid. * @param position The position of the tile. * @param coords The quadrilateral of the new tile. - * @js NA * @lua NA */ void setTile(const Vec2& position, const Quad3& coords); @@ -210,6 +208,7 @@ public: /** @brief AccelDeccelAmplitude action. +@js NA */ class CC_DLL AccelDeccelAmplitude : public ActionInterval { @@ -261,6 +260,7 @@ private: /** @brief AccelAmplitude action. +@js NA */ class CC_DLL AccelAmplitude : public ActionInterval { @@ -306,6 +306,7 @@ private: /** @brief DeccelAmplitude action. +@js NA */ class CC_DLL DeccelAmplitude : public ActionInterval { diff --git a/cocos/2d/CCAnimation.h b/cocos/2d/CCAnimation.h index 5d066cb60d..e2c64eb1d4 100644 --- a/cocos/2d/CCAnimation.h +++ b/cocos/2d/CCAnimation.h @@ -182,7 +182,6 @@ public: /* Creates an animation with an array of AnimationFrame, the delay per units in seconds and and how many times it should be executed. * @since v2.0 - * @js NA * @param arrayOfAnimationFrameNames An animation with an array of AnimationFrame. * @param delayPerUnit The delay per units in seconds and and how many times it should be executed. * @param loops The times the animation is going to loop. @@ -203,6 +202,7 @@ public: void addSpriteFrameWithFile(const std::string& filename); /** * @deprecated. Use addSpriteFrameWithFile() instead. + @js NA */ CC_DEPRECATED_ATTRIBUTE void addSpriteFrameWithFileName(const std::string& filename){ addSpriteFrameWithFile(filename);} diff --git a/cocos/2d/CCAnimationCache.h b/cocos/2d/CCAnimationCache.h index 8f69c37a92..6646e17f7e 100644 --- a/cocos/2d/CCAnimationCache.h +++ b/cocos/2d/CCAnimationCache.h @@ -45,10 +45,13 @@ class Animation; */ /** Singleton that manages the Animations. - * It saves in a cache the animations. You should use this class if you want to save your animations in a cache. - * Before v0.99.5, the recommend way was to save them on the Sprite. Since v0.99.5, you should use this class instead. - * @since v0.99.5 - */ +It saves in a cache the animations. You should use this class if you want to save your animations in a cache. + +Before v0.99.5, the recommend way was to save them on the Sprite. Since v0.99.5, you should use this class instead. + +@since v0.99.5 +@js cc.animationCache +*/ class CC_DLL AnimationCache : public Ref { public: @@ -61,13 +64,14 @@ public: * @lua NA */ ~AnimationCache(); - /** Returns the shared instance of the Animation cache. - * - * @return The shared instance of the Animation cache. - */ + /** Returns the shared instance of the Animation cache + @js NA + */ static AnimationCache* getInstance(); - /** Purges the cache. It releases all the Animation objects and the shared instance. */ + /** Purges the cache. It releases all the Animation objects and the shared instance. + @js NA + */ static void destroyInstance(); /** @deprecated Use getInstance() instead. */ @@ -115,6 +119,7 @@ public: * @param dictionary An NSDictionary. * @param plist The path of the relative file,it use to find the plist path for load SpriteFrames. * @since v1.1 + @js NA */ void addAnimationsWithDictionary(const ValueMap& dictionary,const std::string& plist); diff --git a/cocos/2d/CCAtlasNode.h b/cocos/2d/CCAtlasNode.h index 2f53918dde..57d0978835 100644 --- a/cocos/2d/CCAtlasNode.h +++ b/cocos/2d/CCAtlasNode.h @@ -96,7 +96,6 @@ public: */ virtual void setBlendFunc(const BlendFunc& blendFunc) override; /** - * @js NA * @lua NA */ virtual const BlendFunc& getBlendFunc() const override; diff --git a/cocos/base/CCRef.h b/cocos/base/CCRef.h index bd6cacbd52..0185f3164d 100644 --- a/cocos/base/CCRef.h +++ b/cocos/base/CCRef.h @@ -71,6 +71,7 @@ public: /** * Ref is used for reference count manangement. If a class inherits from Ref, * then it is easy to be shared in different places. + * @js NA */ class CC_DLL Ref {