Merge pull request #1168 from walzer/gles20

add more details in doxygen comments.
This commit is contained in:
Walzer 2012-08-09 22:59:13 -07:00
commit 49e68df95c
4 changed files with 23 additions and 22 deletions

View File

@ -98,7 +98,7 @@ public:
public:
/** Allocates and initializes the action
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use create() instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCAction* action();
@ -185,7 +185,7 @@ public:
public:
/** creates the action
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use create(CCActionInterval* float) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCSpeed* actionWithAction(CCActionInterval *pAction, float fSpeed);
@ -234,7 +234,7 @@ public:
public:
/** creates the action with a set boundary,
It will work with no boundary if @param rect is equal to CCRectZero.
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use create(CCNode*, const CCRect&) intead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCFollow* actionWithTarget(CCNode *pFollowedNode, const CCRect& rect = CCRectZero);
/** creates the action with a set boundary,

View File

@ -116,37 +116,37 @@ public:
/* static functions */
/** Create an array
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use create() instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCArray* array();
/** Create an array with one object
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithObject(CCObject*) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCArray* arrayWithObject(CCObject* pObject);
/** Create an array with some objects
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use create(CCObject*, ...) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCArray* arrayWithObjects(CCObject* pObject, ...);
/** Create an array with capacity
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithCapacity(unsigned int) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCArray* arrayWithCapacity(unsigned int capacity);
/** Create an array with an existing array
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithArray(CCArray*) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCArray* arrayWithArray(CCArray* otherArray);
/**
@brief Generate a CCArray pointer by file
@param pFileName The file name of *.plist file
@return The CCArray pointer generated from the file
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithContentsOfFile(const char*) intead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCArray* arrayWithContentsOfFile(const char* pFileName);
/*
@brief The same meaning as arrayWithContentsOfFile(), but it doesn't call autorelease, so the
invoker should call release().
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithContentsOfFileThreadSafe(const char*) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCArray* arrayWithContentsOfFileThreadSafe(const char* pFileName);

View File

@ -141,23 +141,24 @@ public:
virtual CCObject* copyWithZone(CCZone* pZone);
/* static functions */
//@deprecated: This interface will be deprecated sooner or later.
//@deprecated: Please use create() instead. This interface will be deprecated sooner or later.
CC_DEPRECATED_ATTRIBUTE static CCDictionary* dictionary();
//@deprecated: This interface will be deprecated sooner or later.
//@deprecated: Please use createWithDictionary(CCDictionary*) instead. This interface will be deprecated sooner or later.
CC_DEPRECATED_ATTRIBUTE static CCDictionary* dictionaryWithDictionary(CCDictionary* srcDict);
/**
@brief Generate a CCDictionary pointer by file
@param pFileName The file name of *.plist file
@return The CCDictionary pointer generated from the file
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithContentsOfFile(const char*) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCDictionary* dictionaryWithContentsOfFile(const char *pFileName);
/*
@brief The same meaning as dictionaryWithContentsOfFile(), but it doesn't call autorelease, so the
invoker should call release().
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithContentsOfFileThreadSafe(const char*) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCDictionary* dictionaryWithContentsOfFileThreadSafe(const char *pFileName);

View File

@ -128,13 +128,13 @@ public:
/** Creates an sprite with a texture.
The rect used will be the size of the texture.
The offset will be (0,0).
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithTexture(CCTexture2D*) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCSprite* spriteWithTexture(CCTexture2D *pTexture);
/** Creates an sprite with a texture and a rect.
The offset will be (0,0).
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithTexture(CCTexture2D*, const CCRect&) instead, This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCSprite* spriteWithTexture(CCTexture2D *pTexture, const CCRect& rect);
@ -150,14 +150,14 @@ public:
static CCSprite* createWithTexture(CCTexture2D *pTexture, const CCRect& rect);
/** Creates an sprite with an sprite frame.
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithSpriteFrame(CCSpriteFrame*) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCSprite* spriteWithSpriteFrame(CCSpriteFrame *pSpriteFrame);
/** Creates an sprite with an sprite frame name.
An CCSpriteFrame will be fetched from the CCSpriteFrameCache by name.
If the CCSpriteFrame doesn't exist it will raise an exception.
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use createWithSpriteFrameName(const char*) instead. This interface will be deprecated sooner or later.
@since v0.9
*/
CC_DEPRECATED_ATTRIBUTE static CCSprite* spriteWithSpriteFrameName(const char *pszSpriteFrameName);
@ -175,13 +175,13 @@ public:
/** Creates an sprite with an image filename.
The rect used will be the size of the image.
The offset will be (0,0).
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use create(const char*) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCSprite* spriteWithFile(const char *pszFileName);
/** Creates an sprite with an image filename and a rect.
The offset will be (0,0).
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use create(const char*, const CCRect&) instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCSprite* spriteWithFile(const char *pszFileName, const CCRect& rect);
@ -197,7 +197,7 @@ public:
static CCSprite* create(const char *pszFileName, const CCRect& rect);
/** Creates an sprite.
@deprecated: This interface will be deprecated sooner or later.
@deprecated: Please use create() instead. This interface will be deprecated sooner or later.
*/
CC_DEPRECATED_ATTRIBUTE static CCSprite* node();
/** Creates an sprite.