Skip to content

Commit

Permalink
Improve comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
psineur committed Jan 28, 2012
1 parent a7ba995 commit 6ec90b6
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 9 deletions.
6 changes: 3 additions & 3 deletions cocos2d/CCAction.h
Expand Up @@ -49,7 +49,7 @@ enum {
Used in CCActionManager to start action in -resumeTarget: instead of
-addAction:target:paused if paused is YES (i.e. when -runAction: called
before calling addChild:)
@since v.1.1+ ("feature-amc-actions" branch of psineur/cocos2d-iphone)
@since v.1.1+ ("feature-amc-actions" branch of github.com/psineur/cocos2d-iphone)
*/
@property (nonatomic, readonly, assign) BOOL started;

Expand Down Expand Up @@ -200,7 +200,7 @@ enum {

/** Boundary rect, where camera position should be limited.
* Can be changed during runtime.
* @since 1.1+ ("feature-amc-actions" branch of psineur/cocos2d-iphone)
* @since 1.1+ ("feature-amc-actions" branch of github.com/psineur/cocos2d-iphone)
*/
@property (nonatomic, readwrite) CGRect worldBoundary;

Expand All @@ -210,7 +210,7 @@ enum {
* given name, if it exist right now or do nothing if it doesn't exist.
* 3. Setter: (When action didn't start yet) try to set followedNode by name now
* and, if no success, on start.
* @since 1.1+ ("feature-amc-actions" branch of psineur/cocos2d-iphone)
* @since 1.1+ ("feature-amc-actions" branch of github.com/psineur/cocos2d-iphone)
*/
@property(nonatomic, readwrite, retain) NSString *followedNodeName;

Expand Down
10 changes: 5 additions & 5 deletions cocos2d/CCNodeRegistry.h
Expand Up @@ -27,11 +27,11 @@
@class CCNode;

/** Singleton that holds pointers to named CCNode objects.
It called Registry because it doesn't cache(retain) anything.
You should use this class if you want to get ANY named node from ANY place.
To save pointer to a node (without retaining it) - use CCNode's name property.
@since v1.1+ ("feature-amc" branch)
* It called Registry because it doesn't cache(retain) anything.
* You should use this class if you want to get ANY named node from ANY place.
* To save pointer to a node (without retaining it) - use CCNode's name property.
*
* @since v1.1+ ("feature-amc" branch of github.com/psineur/cocos2d-iphone)
*/
@interface CCNodeRegistry : NSObject
{
Expand Down
9 changes: 8 additions & 1 deletion cocos2d/CCSpriteFrame.h
Expand Up @@ -50,7 +50,14 @@
NSString *name_;
}

/** Name of the frame. Changed when frame added to CCSpriteFrameCache. */
/** Name of the frame. Changed when frame added to CCSpriteFrameCache
* or removed from it.
* If you will not change this value manually - spriteframe's name will always be
* equal to the one, that is used to hold spriteFrame in CCSpriteFrameCache.
* Or nil if spriteFrame isn't present in CCSpriteFrameCache.
*
* @since v1.1+ ("feature-amc-actions" branch of github.com/psineur/cocos2d-iphone)
*/
@property (nonatomic, readwrite, copy) NSString *name;

/** rect of the frame in points. If it is updated, then rectInPixels will be updated too. */
Expand Down
2 changes: 2 additions & 0 deletions cocos2d/CCTexture2D.h
Expand Up @@ -182,6 +182,8 @@ typedef enum {
* ATTENTION: Changing this value may lead to making it's impossible to
* load this texture again. Usually you don't need to change this key - it
* should be used only by CCTextureCache.
*
* @since v1.1+ ("feature-amc-actions" branch of github.com/psineur/cocos2d-iphone)
*/
@property (nonatomic, readwrite, copy) NSString *key;

Expand Down

0 comments on commit 6ec90b6

Please sign in to comment.