Merge pull request #11081 from VisualSJ/v3-docs

[ci skip] Add javascript notes...

cocos/2d/CCMotionStreak.h

@@ -117,7 +117,6 @@ public:
     */
     virtual void draw(Renderer *renderer, const Mat4 &transform, uint32_t flags) override;
     /**
-    * @js NA
     * @lua NA
     */
     virtual void update(float delta) override;

cocos/2d/CCParticleBatchNode.h

@@ -75,6 +75,7 @@ public:
      * @param tex A given texture.
      * @param capacity A capacity of particles.
      * @return An autoreleased ParticleBatchNode object.
+     * @js NA
      */
     static ParticleBatchNode* createWithTexture(Texture2D *tex, int capacity = kParticleDefaultCapacity);
 

cocos/2d/CCParticleExamples.h

@@ -51,6 +51,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleFire object.
+     * @js NA
      */
     static ParticleFire* createWithTotalParticles(int numberOfParticles);
     
@@ -87,6 +88,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleFireworks object.
+     * @js NA
      */
     static ParticleFireworks* createWithTotalParticles(int numberOfParticles);
     
@@ -124,6 +126,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleSun object.
+     * @js NA
      */
     static ParticleSun* createWithTotalParticles(int numberOfParticles);
     
@@ -161,6 +164,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleGalaxy object.
+     * @js NA
      */
     static ParticleGalaxy* createWithTotalParticles(int numberOfParticles);
     
@@ -198,6 +202,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleFlower object.
+     * @js NA
      */
     static ParticleFlower* createWithTotalParticles(int numberOfParticles);
     
@@ -234,6 +239,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleMeteor object.
+     * @js NA
      */
     static ParticleMeteor* createWithTotalParticles(int numberOfParticles);
     
@@ -270,6 +276,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleSpiral object.
+     * @js NA
      */
     static ParticleSpiral* createWithTotalParticles(int numberOfParticles);
     
@@ -307,6 +314,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleExplosion object.
+     * @js NA
      */
     static ParticleExplosion* createWithTotalParticles(int numberOfParticles);
     
@@ -343,6 +351,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleSmoke object.
+     * @js NA
      */
     static ParticleSmoke* createWithTotalParticles(int numberOfParticles);
     
@@ -379,6 +388,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleSnow object.
+     * @js NA
      */
     static ParticleSnow* createWithTotalParticles(int numberOfParticles);
     
@@ -415,6 +425,7 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleRain object.
+     * @js NA
      */
     static ParticleRain* createWithTotalParticles(int numberOfParticles);
     

cocos/2d/CCParticleSystem.h

@@ -140,6 +140,7 @@ class CC_DLL ParticleSystem : public Node, public TextureProtocol
 {
 public:
     /** Mode
+     * @js cc.ParticleSystem.MODE_GRAVITY;
      */
     enum class Mode
     {
@@ -149,6 +150,7 @@ public:
     
     /** PositionType
      Possible types of particle positions.
+     * @js cc.ParticleSystem.TYPE_FREE
      */
     enum class PositionType
     {
@@ -187,12 +189,14 @@ public:
      *
      * @param numberOfParticles A given number of particles.
      * @return An autoreleased ParticleSystemQuad object.
+     * @js NA
      */
     static ParticleSystem* createWithTotalParticles(int numberOfParticles);
 
     /** Add a particle to the emitter.
      *
      * @return True if add success.
+     * @js ctor
      */
     bool addParticle();
     /** Initializes a particle.

cocos/2d/CCParticleSystemQuad.h

@@ -53,6 +53,7 @@ Special features and Limitations:
 - It supports subrects.
 - It supports batched rendering since 1.1.
 @since v0.8
+@js NA
 */
 class CC_DLL ParticleSystemQuad : public ParticleSystem
 {

cocos/2d/CCTransition.h

@@ -48,6 +48,7 @@ class NodeGrid;
 /** @class TransitionEaseScene
  * @brief TransitionEaseScene can ease the actions of the scene protocol.
 @since v0.8.2
+@js NA
 */
 class CC_DLL TransitionEaseScene// : public Ref
 {
@@ -491,7 +492,6 @@ public:
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
@@ -533,7 +533,6 @@ public:
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
@@ -574,7 +573,6 @@ public:
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
@@ -615,7 +613,6 @@ public:
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
@@ -656,7 +653,6 @@ public:
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
@@ -697,7 +693,6 @@ public:
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
@@ -738,7 +733,6 @@ public:
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
@@ -776,12 +770,10 @@ public:
     static TransitionFade* create(float duration, Scene* scene);
 
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onExit() override;
@@ -822,17 +814,14 @@ public :
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void draw(Renderer *renderer, const Mat4 &transform, uint32_t flags) override;
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onExit() override;
@@ -864,12 +853,17 @@ public :
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;
+    /**
+     * @js NA
+     */
     virtual void onExit() override;
 	virtual ActionInterval * easeActionWithAction(ActionInterval * action) override;
+	/**
+	* @js NA
+	*/
     virtual void draw(Renderer *renderer, const Mat4 &transform, uint32_t flags) override;
 
 CC_CONSTRUCTOR_ACCESS:
@@ -909,7 +903,6 @@ public:
     // Overrides
     //
     /**
-     * @js NA
      * @lua NA
      */
     virtual void onEnter() override;

cocos/2d/CCTransitionPageTurn.h

@@ -67,6 +67,7 @@ public:
     
     //
     // Overrides
+    // @js NA
     //
     virtual void draw(Renderer *renderer, const Mat4 &transform, uint32_t flags) override;
 

cocos/base/CCConfiguration.h

@@ -42,6 +42,7 @@ NS_CC_BEGIN
 /** @class Configuration
  * @brief Configuration contains some openGL variables
  * @since v0.99.0
+ * @js NA
  */
 class CC_DLL Configuration : public Ref
 {

cocos/base/CCTouch.h

@@ -43,13 +43,17 @@ NS_CC_BEGIN
 class CC_DLL Touch : public Ref
 {
 public:
-    /** Dispatch mode, how the touches are dispathced. */
+    /** 
+     * Dispatch mode, how the touches are dispathced.
+     * @js NA
+     */
     enum class DispatchMode {
         ALL_AT_ONCE, /** All at once. */
         ONE_BY_ONE,  /** One by one. */
     };
 
     /** Constructor.
+     * @js ctor
      */
     Touch() 
         : _id(0),