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

Change some doc due to the change of source code. 

Fixed some incorrect use of doxygen command.
This commit is contained in:
Timothy Qiu 2013-08-01 17:47:37 +08:00
parent f0ee1e62c0
commit bc10c2a01f
6 changed files with 64 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CocosDenshion/include/SimpleAudioEngine.h
View File

@ -190,7 +190,6 @@ public:
/**
@brief Pause all playing sound effect
@param nSoundId The return value of function playEffect
*/
void pauseAllEffects();
@ -202,7 +201,6 @@ public:
/**
@brief Resume all playing sound effect
@param nSoundId The return value of function playEffect
*/
void resumeAllEffects();

10
cocos2dx/base_nodes/CCNode.h
View File

@ -174,7 +174,7 @@ public:
* The larger number it is, the later this node will be drawn in each message loop.
* Please refer to setVertexZ(float) for the difference.
*
* @param nZOrder Z order of this node.
* @param zOrder Z order of this node.
*/
virtual void setZOrder(int zOrder);
/**
@ -206,7 +206,7 @@ public:
*
* @warning Use it at your own risk since it might break the cocos2d parent-children z order
*
* @param fVertexZ OpenGL Z vertex of this node.
* @param vertexZ OpenGL Z vertex of this node.
*/
virtual void setVertexZ(float vertexZ);
/**
@ -462,9 +462,9 @@ public:
* 0 is the default rotation angle.
* Positive values rotate node clockwise, and negative values for anti-clockwise.
*
* @param fRotationX The X rotation in degrees which performs a horizontal rotational skew.
* @param rotationX The X rotation in degrees which performs a horizontal rotational skew.
*/
virtual void setRotationX(float rotaionX);
virtual void setRotationX(float rotationX);
/**
* Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew.
*
@ -481,7 +481,7 @@ public:
* 0 is the default rotation angle.
* Positive values rotate node clockwise, and negative values for anti-clockwise.
*
* @param fRotationY The Y rotation in degrees.
* @param rotationY The Y rotation in degrees.
*/
virtual void setRotationY(float rotationY);
/**

30
cocos2dx/cocoa/CCGeometry.h
View File

@ -246,24 +246,18 @@ public:
}
/** A general line-line intersection test
@param p1
is the startpoint for the first line P1 = (p1 - p2)
@param p2
is the endpoint for the first line P1 = (p1 - p2)
@param p3
is the startpoint for the second line P2 = (p3 - p4)
@param p4
is the endpoint for the second line P2 = (p3 - p4)
@param s
is the range for a hitpoint in P1 (pa = p1 + s*(p2 - p1))
@param t
is the range for a hitpoint in P3 (pa = p2 + t*(p4 - p3))
@return bool
indicating successful intersection of a line
note that to truly test intersection for segments we have to make
sure that s & t lie within [0..1] and for rays, make sure s & t > 0
the hit point is p3 + t * (p4 - p3);
the hit point also is p1 + s * (p2 - p1);
@param A the startpoint for the first line L1 = (A - B)
@param B the endpoint for the first line L1 = (A - B)
@param C the startpoint for the second line L2 = (C - D)
@param D the endpoint for the second line L2 = (C - D)
@param S the range for a hitpoint in L1 (p = A + S*(B - A))
@param T the range for a hitpoint in L2 (p = C + T*(D - C))
@returns whether these two lines interects.
Note that to truly test intersection for segments we have to make
sure that S & T lie within [0..1] and for rays, make sure S & T > 0
the hit point is C + T * (D - C);
the hit point also is A + S * (B - A);
@since 3.0
*/
static bool isLineIntersect(const Point& A, const Point& B,

14
cocos2dx/sprite_nodes/CCSprite.h
View File

@ -459,20 +459,20 @@ public:
virtual void setScaleX(float scaleX) override;
virtual void setScaleY(float scaleY) override;
virtual void setPosition(const Point& pos) override;
virtual void setRotation(float fRotation) override;
virtual void setRotationX(float fRotationX) override;
virtual void setRotationY(float fRotationY) override;
virtual void setRotation(float rotation) override;
virtual void setRotationX(float rotationX) override;
virtual void setRotationY(float rotationY) override;
virtual void setSkewX(float sx) override;
virtual void setSkewY(float sy) override;
virtual void removeChild(Node* child, bool bCleanup) override;
virtual void removeAllChildrenWithCleanup(bool bCleanup) override;
virtual void removeChild(Node* child, bool cleanup) override;
virtual void removeAllChildrenWithCleanup(bool cleanup) override;
virtual void reorderChild(Node *child, int zOrder) override;
virtual void addChild(Node *child) override;
virtual void addChild(Node *child, int zOrder) override;
virtual void addChild(Node *child, int zOrder, int tag) override;
virtual void sortAllChildren() override;
virtual void setScale(float fScale) override;
virtual void setVertexZ(float fVertexZ) override;
virtual void setScale(float scale) override;
virtual void setVertexZ(float vertexZ) override;
virtual void setAnchorPoint(const Point& anchor) override;
virtual void ignoreAnchorPointForPosition(bool value) override;
virtual void setVisible(bool bVisible) override;

82
cocos2dx/support/ccUTF8.h
View File

@ -17,74 +17,70 @@ CC_DLL int cc_wcslen(const unsigned short* str);
CC_DLL void cc_utf8_trim_ws(std::vector<unsigned short>* str);
/*
* @ch is the unicode character whitespace?
/**
* Whether the character is a whitespace character.
*
* Reference: http://en.wikipedia.org/wiki/Whitespace_character#Unicode
* @param ch the unicode character
* @returns whether the character is a white space character.
*
* Return value: weather the character is a whitespace character.
* @see http://en.wikipedia.org/wiki/Whitespace_character#Unicode
* */
CC_DLL bool isspace_unicode(unsigned short ch);
/*
* cc_utf8_strlen:
* @p: pointer to the start of a UTF-8 encoded string.
* @max: the maximum number of bytes to examine. If @max
* is less than 0, then the string is assumed to be
* null-terminated. If @max is 0, @p will not be examined and
* may be %NULL.
*
/**
* Returns the length of the string in characters.
*
* Return value: the length of the string in characters
* @param p pointer to the start of a UTF-8 encoded string.
* @param max the maximum number of bytes to examine. If \p max is less than
* 0, then the string is assumed to be null-terminated. If \p max
* is 0, \p p will not be examined and my be %NULL.
*
* @returns the length of the string in characters
**/
CC_DLL long
cc_utf8_strlen (const char * p, int max);
/*
* @str: the string to search through.
* @c: the character to not look for.
/**
* Find the last character that is not equal to the character given.
*
* Return value: the index of the last character that is not c.
* @param str the string to be searched.
* @param c the character to be searched for.
*
* @returns the index of the last character that is not \p c.
* */
CC_DLL unsigned int cc_utf8_find_last_not_char(std::vector<unsigned short> str, unsigned short c);
CC_DLL std::vector<unsigned short> cc_utf16_vec_from_utf16_str(const unsigned short* str);
/*
* cc_utf8_to_utf16:
* @str_old: pointer to the start of a C string.
*
/**
* Creates a utf8 string from a cstring.
*
* Return value: the newly created utf8 string.
* @param str_old pointer to the start of a C string.
*
* @returns the newly created utf8 string.
* */
CC_DLL unsigned short* cc_utf8_to_utf16(const char* str_old, int length = -1, int* rUtf16Size = NULL);
/**
* cc_utf16_to_utf8:
* @str: a UTF-16 encoded string
* @len: the maximum length of @str to use. If @len < 0, then
* the string is terminated with a 0 character.
* @items_read: location to store number of words read, or %NULL.
* If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
* returned in case @str contains a trailing partial
* character. If an error occurs then the index of the
* invalid input is stored here.
* @items_written: location to store number of bytes written, or %NULL.
* The value stored here does not include the trailing
* 0 byte.
* @error: location to store the error occuring, or %NULL to ignore
* errors. Any of the errors in #GConvertError other than
* %G_CONVERT_ERROR_NO_CONVERSION may occur.
* Convert a string from UTF-16 to UTF-8. The result will be null terminated.
*
* Convert a string from UTF-16 to UTF-8. The result will be
* terminated with a 0 byte.
* @param str a UTF-16 encoded string
* @param len the maximum length of \p str to use. If \p len < 0, then the
* string is null terminated.
* @param items_read location to store number of words read, or %NULL.
* If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
* returned in case \p str contains a trailing partial
* character. If an error occurs then the index of the
* invalid input is stored here.
* @param items_written location to store number of bytes written, or %NULL.
* The value stored here does not include the trailing null.
* @param error location to store the error occuring, or %NULL to ignore
* errors. Any of the errors in #GConvertError other than
* %G_CONVERT_ERROR_NO_CONVERSION may occur.
*
* Return value: a pointer to a newly allocated UTF-8 string.
* This value must be freed with free(). If an
* error occurs, %NULL will be returned and
* @error set.
* @returns a pointer to a newly allocated UTF-8 string. This value must be
* freed with free(). If an error occurs, %NULL will be returned and
* \p error set.
**/
CC_DLL char *
cc_utf16_to_utf8 (const unsigned short *str,

2
extensions/AssetsManager/AssetsManager.h
View File

@ -203,7 +203,7 @@ public:
virtual void onError(AssetsManager::ErrorCode errorCode) {};
/** @brief Call back function for recording downloading percent
@param percent How much percent downloaded
@warn This call back function just for recording downloading percent.
@warning This call back function just for recording downloading percent.
AssetsManager will do some other thing after downloading, you should
write code in onSuccess() after downloading.
*/