CCEffects - API documentation fixes

Author: Thayer J Andrews

cocos2d/CCEffect.h

@@ -15,7 +15,7 @@
 
 /**
  * CCEffect is the foundation of the Cocos2D effects system. Subclasses of CCEffect can be
- * used to easil add exciting visual effects such has blur, bloom, reflection, refraction, and
+ * used to easily add exciting visual effects such has blur, bloom, reflection, refraction, and
  * other image processing filters to your applications.
  *
  */

cocos2d/CCEffectBloom.h

@@ -43,10 +43,8 @@
 /// -----------------------------------------------------------------------
 
 /**
- *  Initializes a CCEffectBloom object with the following default parameters:
- *    blurRadius : 2
- *    intensity : 1
- *    luminanceThreshold : 0
+ *  Initializes a CCEffectBloom object with the following default values:
+ *  blurRadius = 2, intensity = 1, luminanceThreshold = 0
  *
  *  @return The CCEffectBloom object.
  */
@@ -74,7 +72,7 @@
 /// -----------------------------------------------------------------------
 
 /**
- *  Creates a CCEffectBloom object with the following default parameters:
+ *  Creates a CCEffectBloom 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).

cocos2d/CCEffectGaussianBlur.h

@@ -31,7 +31,7 @@
 
 /**
  *  Initializes a CCEffectGaussianBlur object with the following default parameters:
- *    blurRadius : 2
+ *  blurRadius = 2
  *
  *  @return The CCEffectGaussianBlur object.
  */

cocos2d/CCEffectGlass.h

@@ -66,12 +66,7 @@
 
 /**
  *  Initializes a CCEffectGlass object with the following default parameters:
- *    refraction : 1.0
- *    fresnelBias : 0.1
- *    fresnelPower : 2.0
- *    refractionEnvironment : nil
- *    reflectionEnvironment : nil
- *    normalMap : nil
+ *  refraction = 1.0, fresnelBias = 0.1, fresnelPower = 2.0, refractionEnvironment = nil, reflectionEnvironment = nil, normalMap = nil
  *
  *  @return The CCEffectGlass object.
  */

cocos2d/CCEffectReflection.h

@@ -53,19 +53,15 @@
 
 /**
  *  Initializes a CCEffectReflection object with the following default parameters:
- *    fresnelBias : 1.0
- *    fresnelPower : 0.0
- *    environment : nil
- *    normalMap : nil
+ *  fresnelBias = 1.0, fresnelPower = 0.0, environment = nil, normalMap = nil
  *
  *  @return The CCEffectReflection object.
  */
 -(id)init;
 
 /**
  *  Initializes a CCEffectReflection object with the specified environment and normal map and the following default parameters:
- *    fresnelBias : 1.0
- *    fresnelPower : 0.0
+ *  fresnelBias = 1.0, fresnelPower = 0.0
  *
  *  @param environment The environment image that will be reflected by the affected node.
  *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
@@ -93,8 +89,7 @@
 
 /**
  *  Creates a CCEffectReflection object with the specified environment and normal map and the following default parameters:
- *    fresnelBias : 1.0
- *    fresnelPower : 0.0
+ *  fresnelBias = 1.0, fresnelPower = 0.0
  *
  *  @param environment The environment image that will be reflected by the affected node.
  *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.

cocos2d/CCEffectRefraction.h

@@ -43,9 +43,7 @@
 
 /**
  *  Initializes a CCEffectRefraction object with the following default parameters:
- *    refraction : 1.0
- *    environment : nil
- *    normalMap : nil
+ *  refraction = 1.0, environment = nil, normalMap = nil
  *
  *  @return The CCEffectRefraction object.
  */

cocos2d/CCEffectStack.h

@@ -40,6 +40,8 @@
 /**
  *  Initializes an empty effect stack object.
  *
+ *  @param effects The array of effects to add to the stack.
+ *
  *  @return The CCEffectStack object.
  */
 - (id)initWithEffects:(NSArray *)effects;