Skip to content

Commit 5f0a025

Browse files
authored
Remove @js in comments (#2491)
1 parent ba4a9dc commit 5f0a025

File tree

201 files changed

+1
-1055
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

201 files changed

+1
-1055
lines changed

core/2d/Action.h

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ class AX_DLL Action : public Object, public Clonable
5757
/** Default tag used for all the actions. */
5858
static const int INVALID_TAG = -1;
5959
/**
60-
* @js NA
6160
* @lua NA
6261
*/
6362
virtual std::string description() const;
@@ -75,7 +74,6 @@ class AX_DLL Action : public Object, public Clonable
7574
/** Returns a new action that performs the exact reverse of the action.
7675
*
7776
* @return A new action that performs the exact reverse of the action.
78-
* @js NA
7977
*/
8078
virtual Action* reverse() const
8179
{
@@ -359,14 +357,12 @@ class AX_DLL Follow : public Action
359357
virtual Follow* reverse() const override;
360358
/**
361359
* @param dt in seconds.
362-
* @js NA
363360
*/
364361
virtual void step(float dt) override;
365362
virtual bool isDone() const override;
366363
virtual void stop() override;
367364

368365
/**
369-
* @js ctor
370366
*/
371367
Follow()
372368
: _followedNode(nullptr)
@@ -381,7 +377,6 @@ class AX_DLL Follow : public Action
381377
, _worldRect(Rect::ZERO)
382378
{}
383379
/**
384-
* @js NA
385380
* @lua NA
386381
*/
387382
virtual ~Follow();

core/2d/ActionCamera.h

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,10 @@ class AX_DLL ActionCamera : public ActionInterval
5050
{
5151
public:
5252
/**
53-
* @js ctor
5453
* @lua new
5554
*/
5655
ActionCamera();
5756
/**
58-
* @js NA
5957
* @lua NA
6058
*/
6159
virtual ~ActionCamera(){};
@@ -68,38 +66,32 @@ class AX_DLL ActionCamera : public ActionInterval
6866
/* Sets the Eye value of the Camera.
6967
*
7068
* @param eye The Eye value of the Camera.
71-
* @js NA
7269
*/
7370
void setEye(const Vec3& eye);
7471
void setEye(float x, float y, float z);
7572
/* Returns the Eye value of the Camera.
7673
*
7774
* @return The Eye value of the Camera.
78-
* @js NA
7975
*/
8076
const Vec3& getEye() const { return _eye; }
8177
/* Sets the Center value of the Camera.
8278
*
8379
* @param center The Center value of the Camera.
84-
* @js NA
8580
*/
8681
void setCenter(const Vec3& center);
8782
/* Returns the Center value of the Camera.
8883
*
8984
* @return The Center value of the Camera.
90-
* @js NA
9185
*/
9286
const Vec3& getCenter() const { return _center; }
9387
/* Sets the Up value of the Camera.
9488
*
9589
* @param up The Up value of the Camera.
96-
* @js NA
9790
*/
9891
void setUp(const Vec3& up);
9992
/* Returns the Up value of the Camera.
10093
*
10194
* @return The Up value of the Camera.
102-
* @js NA
10395
*/
10496
const Vec3& getUp() const { return _up; }
10597

@@ -149,11 +141,9 @@ class AX_DLL OrbitCamera : public ActionCamera
149141
virtual void update(float time) override;
150142

151143
/**
152-
* @js ctor
153144
*/
154145
OrbitCamera();
155146
/**
156-
* @js NA
157147
* @lua NA
158148
*/
159149
virtual ~OrbitCamera();

core/2d/ActionCatmullRom.h

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -55,103 +55,87 @@ class Node;
5555
/** An Array that contain control points.
5656
* Used by CardinalSplineTo and (By) and CatmullRomTo (and By) actions.
5757
* @ingroup Actions
58-
* @js NA
5958
*/
6059
class AX_DLL PointArray : public Object, public Clonable
6160
{
6261
public:
6362
/** Creates and initializes a Points array with capacity.
64-
* @js NA
6563
* @param capacity The size of the array.
6664
*/
6765
static PointArray* create(ssize_t capacity);
6866

6967
/**
70-
* @js NA
7168
* @lua NA
7269
*/
7370
virtual ~PointArray();
7471
/**
75-
* @js NA
7672
* @lua NA
7773
*/
7874
PointArray();
7975

8076
/** Initializes a Catmull Rom config with a capacity hint.
8177
*
82-
* @js NA
8378
* @param capacity The size of the array.
8479
* @return True.
8580
*/
8681
bool initWithCapacity(ssize_t capacity);
8782

8883
/** Appends a control point.
8984
*
90-
* @js NA
9185
* @param controlPoint A control point.
9286
*/
9387
void addControlPoint(const Vec2& controlPoint);
9488

9589
/** Inserts a controlPoint at index.
9690
*
97-
* @js NA
9891
* @param controlPoint A control point.
9992
* @param index Insert the point to array in index.
10093
*/
10194
void insertControlPoint(const Vec2& controlPoint, ssize_t index);
10295

10396
/** Replaces an existing controlPoint at index.
10497
*
105-
* @js NA
10698
* @param controlPoint A control point.
10799
* @param index Replace the point to array in index.
108100
*/
109101
void replaceControlPoint(const Vec2& controlPoint, ssize_t index);
110102

111103
/** Get the value of a controlPoint at a given index.
112104
*
113-
* @js NA
114105
* @param index Get the point in index.
115106
* @return A Vec2.
116107
*/
117108
const Vec2& getControlPointAtIndex(ssize_t index) const;
118109

119110
/** Deletes a control point at a given index
120111
*
121-
* @js NA
122112
* @param index Remove the point in index.
123113
*/
124114
void removeControlPointAtIndex(ssize_t index);
125115

126116
/** Returns the number of objects of the control point array.
127117
*
128-
* @js NA
129118
* @return The number of objects of the control point array.
130119
*/
131120
ssize_t count() const;
132121

133122
/** Returns a new copy of the array reversed. User is responsible for releasing this copy.
134123
*
135-
* @js NA
136124
* @return A new copy of the array reversed.
137125
*/
138126
PointArray* reverse() const;
139127

140128
/** Reverse the current control point array inline, without generating a new one.
141-
* @js NA
142129
*/
143130
void reverseInline();
144131
/**
145-
* @js NA
146132
* @lua NA
147133
*/
148134
virtual PointArray* clone() const;
149135
/**
150-
* @js NA
151136
*/
152137
const std::vector<Vec2>& getControlPoints() const;
153138
/**
154-
* @js NA
155139
*/
156140
void setControlPoints(std::vector<Vec2> controlPoints);
157141

@@ -180,12 +164,10 @@ class AX_DLL CardinalSplineTo : public ActionInterval
180164
*/
181165
static CardinalSplineTo* create(float duration, PointArray* points, float tension);
182166
/**
183-
* @js NA
184167
* @lua NA
185168
*/
186169
virtual ~CardinalSplineTo();
187170
/**
188-
* @js ctor
189171
* @lua NA
190172
*/
191173
CardinalSplineTo();
@@ -209,7 +191,6 @@ class AX_DLL CardinalSplineTo : public ActionInterval
209191
*/
210192
PointArray* getPoints() { return _points; }
211193
/**
212-
* @js NA
213194
* @lua NA
214195
*/
215196
void setPoints(PointArray* points)

core/2d/ActionGrid.h

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ class AX_DLL Grid3DAction : public GridAction
9797
* @brief Get the vertex that belongs to certain position in the grid.
9898
* @param position The position of the grid.
9999
* @return Return a pointer of vertex.
100-
* @js vertex
101100
* @lua NA
102101
*/
103102
Vec3 getVertex(const Vec2& position) const;
@@ -106,7 +105,6 @@ class AX_DLL Grid3DAction : public GridAction
106105
* @brief Get the non-transformed vertex that belongs to certain position in the grid.
107106
* @param position The position of the grid.
108107
* @return Return a pointer of vertex.
109-
* @js originalVertex
110108
* @lua NA
111109
*/
112110
Vec3 getOriginalVertex(const Vec2& position) const;
@@ -115,7 +113,6 @@ class AX_DLL Grid3DAction : public GridAction
115113
* @brief Set a new vertex to a certain position of the grid.
116114
* @param position The position of the grid.
117115
* @param vertex The vertex will be used on the certain position of grid.
118-
* @js setVertex
119116
* @lua NA
120117
*/
121118
void setVertex(const Vec2& position, const Vec3& vertex);
@@ -153,7 +150,6 @@ class AX_DLL TiledGrid3DAction : public GridAction
153150
* @brief Get the tile that belongs to a certain position of the grid.
154151
* @param position The position of the tile want to get.
155152
* @return A quadrilateral of the tile.
156-
* @js tile
157153
* @lua NA
158154
*/
159155
Quad3 getTile(const Vec2& position) const;
@@ -162,7 +158,6 @@ class AX_DLL TiledGrid3DAction : public GridAction
162158
* @brief Get the non-transformed tile that belongs to a certain position of the grid.
163159
* @param position The position of the tile want to get.
164160
* @return A quadrilateral of the tile.
165-
* @js originalTile
166161
* @lua NA
167162
*/
168163
Quad3 getOriginalTile(const Vec2& position) const;
@@ -188,7 +183,6 @@ class AX_DLL TiledGrid3DAction : public GridAction
188183

189184
/**
190185
@brief AccelDeccelAmplitude action.
191-
@js NA
192186
*/
193187
class AX_DLL AccelDeccelAmplitude : public ActionInterval
194188
{
@@ -239,7 +233,6 @@ class AX_DLL AccelDeccelAmplitude : public ActionInterval
239233

240234
/**
241235
@brief AccelAmplitude action.
242-
@js NA
243236
*/
244237
class AX_DLL AccelAmplitude : public ActionInterval
245238
{
@@ -284,7 +277,6 @@ class AX_DLL AccelAmplitude : public ActionInterval
284277

285278
/**
286279
@brief DeccelAmplitude action.
287-
@js NA
288280
*/
289281
class AX_DLL DeccelAmplitude : public ActionInterval
290282
{

core/2d/ActionInstant.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,6 @@ class AX_DLL CallFunc : public ActionInstant
360360

361361
/** @class CallFuncN
362362
* @brief Calls a 'callback' with the node as the first argument. N means Node.
363-
* @js NA
364363
*/
365364
class AX_DLL CallFuncN : public CallFunc
366365
{

core/2d/ActionInterval.h

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,15 +152,13 @@ class AX_DLL Sequence : public ActionInterval
152152
* @param action1 The first sequenceable action.
153153
* @param args The va_list variable.
154154
* @return An autoreleased Sequence object.
155-
* @js NA
156155
* @note ATTENTION! Last entry must be a 'nullptr' to correctly terminate the list.
157156
*/
158157
static Sequence* createWithVariableList(FiniteTimeAction* action1, va_list args);
159158
/** Creates the action.
160159
* @param actionOne The first sequenceable action.
161160
* @param actionTwo The second sequenceable action.
162161
* @return An autoreleased Sequence object.
163-
* @js NA
164162
*/
165163
static Sequence* createWithTwoActions(FiniteTimeAction* actionOne, FiniteTimeAction* actionTwo);
166164

@@ -342,7 +340,6 @@ class AX_DLL Spawn : public ActionInterval
342340
* @param action1 The first sequenceable action.
343341
* @param args The va_list variable.
344342
* @return An autoreleased Spawn object.
345-
* @js NA
346343
*/
347344
static Spawn* createWithVariableList(FiniteTimeAction* action1, va_list args);
348345

@@ -358,7 +355,6 @@ class AX_DLL Spawn : public ActionInterval
358355
* @param action1 The first spawned action.
359356
* @param action2 The second spawned action.
360357
* @return An autoreleased Spawn object.
361-
* @js NA
362358
*/
363359
static Spawn* createWithTwoActions(FiniteTimeAction* action1, FiniteTimeAction* action2);
364360

@@ -1231,7 +1227,6 @@ class AX_DLL FadeIn : public FadeTo
12311227
virtual FadeTo* reverse() const override;
12321228

12331229
/**
1234-
* @js NA
12351230
*/
12361231
void setReverseAction(FadeTo* ac);
12371232

@@ -1264,7 +1259,6 @@ class AX_DLL FadeOut : public FadeTo
12641259
virtual FadeTo* reverse() const override;
12651260

12661261
/**
1267-
* @js NA
12681262
*/
12691263
void setReverseAction(FadeTo* ac);
12701264

core/2d/ActionManager.h

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,10 @@ class AX_DLL ActionManager : public Object
6767
{
6868
public:
6969
/**
70-
* @js ctor
7170
*/
7271
ActionManager();
7372

7473
/**
75-
* @js NA
7674
* @lua NA
7775
*/
7876
virtual ~ActionManager();
@@ -118,15 +116,13 @@ class AX_DLL ActionManager : public Object
118116
*
119117
* @param tag The actions' tag.
120118
* @param target A certain target.
121-
* @js NA
122119
*/
123120
virtual void removeAllActionsByTag(int tag, Node* target);
124121

125122
/** Removes all actions matching at least one bit in flags and the target.
126123
*
127124
* @param flags The flag field to match the actions' flags based on bitwise AND.
128125
* @param target A certain target.
129-
* @js NA
130126
*/
131127
virtual void removeActionsByFlags(unsigned int flags, Node* target);
132128

@@ -145,13 +141,11 @@ class AX_DLL ActionManager : public Object
145141
*
146142
* @param target A certain target.
147143
* @return The numbers of actions that are running in a certain target.
148-
* @js NA
149144
*/
150145
virtual ssize_t getNumberOfRunningActionsInTarget(const Node* target) const;
151146

152147
/** Returns the numbers of actions that are running in all targets.
153148
* @return The numbers of actions that are running in all target.
154-
* @js NA
155149
*/
156150
virtual ssize_t getNumberOfRunningActions() const;
157151

@@ -167,7 +161,6 @@ class AX_DLL ActionManager : public Object
167161
* @return The numbers of actions that are running in a certain target
168162
* with a specific tag.
169163
* @see getNumberOfRunningActionsInTarget
170-
* @js NA
171164
*/
172165
virtual size_t getNumberOfRunningActionsInTargetByTag(const Node* target, int tag);
173166

0 commit comments

Comments
 (0)