[appledoc] Added reference for FP extensions of NSArray

src/lib/SCUtils/SitecoreMobileSDK/NSArray+SCBlocksAdditions.h

@@ -1,8 +1,21 @@
 #include <SitecoreMobileSDK/SCArrayHelperBlocks.h>
 #import <Foundation/Foundation.h>
 
+
+/**
+ This category adds extensions that allow using the functional programming patterns in your applications. 
+ The methods are built on top of the -[NSArray enumerateObjectsUsingBlock:] method and are capable of solving the task of
+ 
+ * iterating
+ * filtering array contents
+ * transforming the array ( mapping )
+ 
+ 
+ */
 @interface NSArray (SCBlocksAdditions)
 
+
+
 /**
    Creates a new NSArray of length N containing the values returned by the block.
  
@@ -14,25 +27,42 @@
 +(instancetype)arrayWithSize:(NSUInteger)N
                     producer:(SCProducerBlock)block;
 
+
+
+
 /**
 Calls block once for each element in self, passing that element as a parameter.
+ 
+ @param block Performs some action with the given object. It is executed for each element of the array. The execution order is not guaranteed to be the same as the order of elements in the array.
  */
 - (void)each:(SCActionBlock)block;
 
+
+
+
 /**
 Invokes block once for each element of self.
 Creates a new NSArray containing the values returned by the block.
  
  @param block - a block that perfroms the transform of element in this array to element in the new array.
+ 
  @return a new NSArray of mapped objects
  
  */
 - (NSArray*)map:(SCMappingBlock)block;
 
+
+
+
 /**
  Invokes the block passing in successive elements from self.
  Creates a new NSArray containing all elements of all arrays returned the block.
  
+ @param block A block for retrieving an NSArray from the array element. All its elements will be appenden to the result array.
+ 
+ @return A flat array.
+ 
+ 
  For example,
  
 ```
@@ -48,38 +78,57 @@ Creates a new NSArray containing the values returned by the block.
 - (NSArray*)flatten:(SCFlattenBlock)block;
 
 
+
 /**
 Invokes the block passing in successive elements from self.
 Creates a new NSArray containing those elements for which the block returns a YES value.
  
  @param predicate - a predicate. It takes an object and returns YES if the object matches a certain condition.
+ 
  @return - a new NSArray of objects that fit predicate requirements
  */
 - (NSArray*)select:(SCPredicateBlock)predicate;
 
+
+
 /**
 Invokes the block passing in successive elements from self, returning a count of those elements for which the block returns a YES value.
  
- @param predicate - a predicate. It takes an object and returns YES if the object matches a certain condition.
- @return - number of objects matching the predicate
+ @param predicate A predicate that takes an object and returns YES if the object matches a certain condition.
+ 
+ @return number of objects matching the predicate
  */
 - (NSUInteger)count:(SCPredicateBlock)predicate;
 
+
+
 /**
  Invokes the block passing in successive elements from self, returning the first element for which the block returns a YES value.
  
- @param predicate - a predicate. It takes an object and returns YES if the object matches a certain condition.
+ @param predicate A predicate that takes an object and returns YES if the object matches a certain condition.
+ 
  @return - the first object matching the predicate
  */
 - (id)firstMatch:(SCPredicateBlock)predicate;
 
+
+
 /**
  Invokes the block passing in successive elements from self, returning an index of the first element for which the block returns a YES value.
+ 
+ @param predicate A predicate that takes an object and returns YES if the object matches a certain condition.
+ 
+ @return index of the found object or NSNotFound otherwise
  */
 - (NSUInteger)firstIndexOfObjectMatch:(SCPredicateBlock)predicate;
 
+
+
 /**
  Iterates two arrays simultaneously. Objects with same indices are passed to the block.
+ 
+ @param other An array of the same size
+ @param block Performs some action with the given pair of objects. Both objects have the same index in the corresponding arrays ( "self" and "other" ).
  */
 - (void)transformWithArray:(NSArray *)other
                  withBlock:(SCTransformBlock)block;