CCEffectGaussianBlur - API documentation

Author: Thayer J Andrews

cocos2d/CCEffectGaussianBlur.h

@@ -8,18 +8,58 @@
 
 #import "CCEffect.h"
 
+
+/**
+ * CCEffectGaussianBlur performs blur operation on the pixels of the attached node.
+ */
+
 @interface CCEffectGaussianBlur : CCEffect
 
-// blurRadius number of pixels blur will extend to (6 is the maximum, because we are limited by the number
-// of varying variables that can be passed to a glsl program). TODO: create a slower bloom shader, that does not have this restriction.
+
+/// -----------------------------------------------------------------------
+/// @name Accessing Effect Attributes
+/// -----------------------------------------------------------------------
+
+/** The size of the blur. This value is in the range [0..6].
+ */
 @property (nonatomic) NSUInteger blurRadius;
 
+
+/// -----------------------------------------------------------------------
+/// @name Initializing a CCEffectGaussianBlur object
+/// -----------------------------------------------------------------------
+
 /**
- *  @param blurRadius number of pixels blur will extend to (6 is the maximum, because we are limited by the number
- *  of varying variables that can be passed to a glsl program). TODO: create a slower bloom shader, that does not have this restriction.
+ *  Initializes a CCEffectGaussianBlur object with the following default parameters:
+ *    blurRadius : 2
+ *
+ *  @return The CCEffectGaussianBlur object.
  */
 -(id)init;
+
+/**
+ *  Initializes a CCEffectGaussianBlur object with the specified parameters.
+ *
+ *  @param blurRadius number of pixels blur will extend to (6 is the maximum, because we are limited by the number
+ *  of varying variables that can be passed to a glsl program).
+ *
+ *  @return The CCEffectGaussianBlur object.
+ */
 -(id)initWithPixelBlurRadius:(NSUInteger)blurRadius;
+
+
+/// -----------------------------------------------------------------------
+/// @name Creating a CCEffectGaussianBlur object
+/// -----------------------------------------------------------------------
+
+/**
+ *  Creates a CCEffectGaussianBlur object with the specified parameters.
+ *
+ *  @param blurRadius number of pixels blur will extend to (6 is the maximum, because we are limited by the number
+ *  of varying variables that can be passed to a glsl program).
+ *
+ *  @return The CCEffectGaussianBlur object.
+ */
 +(id)effectWithPixelBlurRadius:(NSUInteger)blurRadius;
 
 @end