CCEffectPixellate - API documentation

Author: Thayer J Andrews

cocos2d/CCEffectPixellate.h

@@ -8,12 +8,55 @@
 
 #import "CCEffect.h"
 
+/**
+ * CCEffectPixellate adjusts the size of the pixels of the sprite or effect node it is attached to.
+ */
+
 @interface CCEffectPixellate : CCEffect
 
+/// -----------------------------------------------------------------------
+/// @name Accessing Effect Attributes
+/// -----------------------------------------------------------------------
+
+/** The resulting size of the pixel blocks of the affected node. This value is specified in points
+ *  and is in the range [1..inf]. A value of 1 results in no change to the affected pixels
+ *  and larger values result in larger output pixel blocks.
+ */
 @property (nonatomic) float blockSize;
 
+
+/// -----------------------------------------------------------------------
+/// @name Initializing a CCEffectPixellate object
+/// -----------------------------------------------------------------------
+
+/**
+ *  Initializes a CCEffectPixellate object with a block size of 1.
+ *
+ *  @return The CCEffectPixellate object.
+ */
 -(id)init;
+
+/**
+ *  Initializes a CCEffectPixellate object with the supplied parameters.
+ *
+ *  @param blockSize The desired block size.
+ *
+ *  @return The CCEffectPixellate object.
+ */
 -(id)initWithBlockSize:(float)blockSize;
+
+
+/// -----------------------------------------------------------------------
+/// @name Initializing a CCEffectPixellate object
+/// -----------------------------------------------------------------------
+
+/**
+ *  Creates a CCEffectPixellate object with the supplied parameters.
+ *
+ *  @param blockSize The desired block size.
+ *
+ *  @return The CCEffectPixellate object.
+ */
 +(id)effectWithBlockSize:(float)blockSize;
 
 @end