Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix outdated documentation [ci skip] #19618

Merged
merged 1 commit into from
Apr 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cocos/2d/CCSprite.h
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ class CC_DLL Sprite : public Node, public TextureProtocol
* A SpriteFrame will be fetched from the SpriteFrameCache by spriteFrameName param.
* If the SpriteFrame doesn't exist it will raise an exception.
*
* @param spriteFrameName A null terminated string which indicates the sprite frame name.
* @param spriteFrameName The name of sprite frame.
* @return An autoreleased sprite object.
*/
static Sprite* createWithSpriteFrameName(const std::string& spriteFrameName);
Expand Down
2 changes: 1 addition & 1 deletion cocos/base/CCProtocols.h
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ class CC_DLL LabelProtocol
/**
* Sets a new label using a string
*
* @param label A null terminated string
* @param label The name of the new label.
* @js NA
* @lua NA
*/
Expand Down
4 changes: 2 additions & 2 deletions cocos/renderer/CCTextureAtlas.h
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class CC_DLL TextureAtlas : public Ref
/** Creates a TextureAtlas with an filename and with an initial capacity for Quads.

* The TextureAtlas capacity can be increased in runtime.
@param file A null terminated string contains the file path.
@param file The file path.
@param capacity Capacity for Quads.
*/
static TextureAtlas* create(const std::string& file , ssize_t capacity);
Expand All @@ -94,7 +94,7 @@ class CC_DLL TextureAtlas : public Ref
* The TextureAtlas capacity can be increased in runtime.
*
@attention Do not reinitialize the TextureAtlas because it will leak memory (issue #706).
@param file A null terminated string contains the file path.
@param file The file path.
@param capacity Capacity for Quads.
*/
bool initWithFile(const std::string& file, ssize_t capacity);
Expand Down
4 changes: 2 additions & 2 deletions cocos/renderer/CCTextureCache.h
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ class CC_DLL TextureCache : public Ref
* Object and it will return it. It will use the filename as a key.
* Otherwise it will return a reference of a previously loaded image.
* Supported image extensions: .png, .bmp, .tiff, .jpeg, .pvr.
@param filepath A null terminated string.
@param filepath The file path.
*/
Texture2D* addImage(const std::string &filepath);

Expand All @@ -119,7 +119,7 @@ class CC_DLL TextureCache : public Ref
* Otherwise it will load a texture in a new thread, and when the image is loaded, the callback will be called with the Texture2D as a parameter.
* The callback will be called from the main thread, so it is safe to create any cocos2d object from the callback.
* Supported image extensions: .png, .jpg
@param filepath A null terminated string.
@param filepath The file path.
@param callback A callback function would be invoked after the image is loaded.
@since v0.8
*/
Expand Down