Lothario
/
axmol
mirror of https://github.com/axmolengine/axmol.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3742 from mlepage/develop 

Clean up some API documentation
This commit is contained in:
minggo 2013-09-23 19:15:37 -07:00
parent 9a433be58d e6144e2c80
commit 9211d8f503
4 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
cocos2dx/CCDirector.h
View File

@ -59,7 +59,7 @@ class KeypadDispatcher;
class Accelerometer; class Accelerometer;
/** /**
@brief Class that creates and handle the main Window and manages how @brief Class that creates and handles the main Window and manages how
and when to execute the Scenes. and when to execute the Scenes.
The Director is also responsible for: The Director is also responsible for:
@ -117,7 +117,7 @@ public:
// attribute // attribute
/** Get current running Scene. Director can only run one Scene at the time */ /** Get current running Scene. Director can only run one Scene at a time */
inline Scene* getRunningScene() { return _runningScene; } inline Scene* getRunningScene() { return _runningScene; }
/** Get the FPS value */ /** Get the FPS value */
@ -178,7 +178,7 @@ public:
Node* getNotificationNode(); Node* getNotificationNode();
void setNotificationNode(Node *node); void setNotificationNode(Node *node);
/** Director delegate. It shall implemente the DirectorDelegate protocol /** Director delegate. It shall implement the DirectorDelegate protocol
@since v0.99.5 @since v0.99.5
* @js NA * @js NA
* @lua NA * @lua NA
@ -240,20 +240,20 @@ public:
*/ */
void pushScene(Scene *scene); void pushScene(Scene *scene);
/** Pops out a scene from the queue. /** Pops out a scene from the stack.
* This scene will replace the running one. * This scene will replace the running one.
* The running scene will be deleted. If there are no more scenes in the stack the execution is terminated. * The running scene will be deleted. If there are no more scenes in the stack the execution is terminated.
* ONLY call it if there is a running scene. * ONLY call it if there is a running scene.
*/ */
void popScene(); void popScene();
/** Pops out all scenes from the queue until the root scene in the queue. /** Pops out all scenes from the stack until the root scene in the queue.
* This scene will replace the running one. * This scene will replace the running one.
* Internally it will call `popToSceneStackLevel(1)` * Internally it will call `popToSceneStackLevel(1)`
*/ */
void popToRootScene(); void popToRootScene();
/** Pops out all scenes from the queue until it reaches `level`. /** Pops out all scenes from the stack until it reaches `level`.
If level is 0, it will end the director. If level is 0, it will end the director.
If level is 1, it will pop all scenes until it reaches to root scene. If level is 1, it will pop all scenes until it reaches to root scene.
If level is <= than the current stack level, it won't do anything. If level is <= than the current stack level, it won't do anything.
@ -301,7 +301,7 @@ public:
// Memory Helper // Memory Helper
/** Removes cached all cocos2d cached data. /** Removes all cocos2d cached data.
It will purge the TextureCache, SpriteFrameCache, LabelBMFont cache It will purge the TextureCache, SpriteFrameCache, LabelBMFont cache
@since v0.99.3 @since v0.99.3
*/ */

2
cocos2dx/base_nodes/CCNode.h
View File

@ -619,7 +619,7 @@ public:
* node->setPosition(0,0); * node->setPosition(0,0);
* } * }
* @endcode * @endcode
* This sample code traverses all children nodes, and set theie position to (0,0) * This sample code traverses all children nodes, and set their position to (0,0)
* *
* @return An array of children * @return An array of children
*/ */

2
cocos2dx/include/CCProtocols.h
View File

@ -223,7 +223,7 @@ class CC_DLL LabelProtocol
{ {
public: public:
/** /**
* Sets a new label using an string * Sets a new label using a string
* *
* @param label A null terminated string * @param label A null terminated string
* @js NA * @js NA

2
cocos2dx/layers_scenes_transitions_nodes/CCScene.h
View File

@ -39,7 +39,7 @@ NS_CC_BEGIN
/** @brief Scene is a subclass of Node that is used only as an abstract concept. /** @brief Scene is a subclass of Node that is used only as an abstract concept.
Scene and Node are almost identical with the difference that Scene has it's Scene and Node are almost identical with the difference that Scene has its
anchor point (by default) at the center of the screen. anchor point (by default) at the center of the screen.
For the moment Scene has no other logic than that, but in future releases it might have For the moment Scene has no other logic than that, but in future releases it might have