Fixed documentation in the common parts of Bolts.

Bolts.xcodeproj/project.pbxproj

@@ -281,14 +281,14 @@
 			isa = PBXGroup;
 			children = (
 				8103FA5619900A84000BAE3F /* BoltsVersion.h */,
-				8103FA4E19900A84000BAE3F /* BFExecutor.h */,
-				8103FA4F19900A84000BAE3F /* BFExecutor.m */,
+				8103FA5419900A84000BAE3F /* Bolts.h */,
+				8103FA5519900A84000BAE3F /* Bolts.m */,
 				8103FA5019900A84000BAE3F /* BFTask.h */,
 				8103FA5119900A84000BAE3F /* BFTask.m */,
 				8103FA5219900A84000BAE3F /* BFTaskCompletionSource.h */,
 				8103FA5319900A84000BAE3F /* BFTaskCompletionSource.m */,
-				8103FA5419900A84000BAE3F /* Bolts.h */,
-				8103FA5519900A84000BAE3F /* Bolts.m */,
+				8103FA4E19900A84000BAE3F /* BFExecutor.h */,
+				8103FA4F19900A84000BAE3F /* BFExecutor.m */,
 			);
 			path = Common;
 			sourceTree = "<group>";

Bolts/Common/BFExecutor.h

@@ -32,22 +32,26 @@
 + (instancetype)mainThreadExecutor;
 
 /*!
- Returns a new executor that uses the given block execute continations.
+ Returns a new executor that uses the given block to execute continuations.
+ @param block The block to use.
  */
 + (instancetype)executorWithBlock:(void(^)(void(^block)()))block;
 
 /*!
  Returns a new executor that runs continuations on the given queue.
+ @param queue The instance of `dispatch_queue_t` to dispatch all continuations onto.
  */
 + (instancetype)executorWithDispatchQueue:(dispatch_queue_t)queue;
 
 /*!
  Returns a new executor that runs continuations on the given queue.
+ @param queue The instance of `NSOperationQueue` to run all continuations on.
  */
 + (instancetype)executorWithOperationQueue:(NSOperationQueue *)queue;
 
 /*!
  Runs the given block using this executor's particular strategy.
+ @param block The block to execute.
  */
 - (void)execute:(void(^)())block;
 

Bolts/Common/BFTask.h

@@ -27,16 +27,19 @@ typedef id(^BFContinuationBlock)(BFTask *task);
 
 /*!
  Creates a task that is already completed with the given result.
+ @param result The result for the task.
  */
 + (instancetype)taskWithResult:(id)result;
 
 /*!
  Creates a task that is already completed with the given error.
+ @param error The error for the task.
  */
 + (instancetype)taskWithError:(NSError *)error;
 
 /*!
  Creates a task that is already completed with the given exception.
+ @param exception The exception for the task.
  */
 + (instancetype)taskWithException:(NSException *)exception;
 
@@ -48,6 +51,7 @@ typedef id(^BFContinuationBlock)(BFTask *task);
 /*!
  Returns a task that will be completed (with result == nil) once
  all of the input tasks have completed.
+ @param tasks An `NSArray` of the tasks to use as an input.
  */
 + (instancetype)taskForCompletionOfAllTasks:(NSArray *)tasks;
 

Bolts/Common/BFTaskCompletionSource.h

@@ -32,18 +32,21 @@
 /*!
  Completes the task by setting the result.
  Attempting to set this for a completed task will raise an exception.
+ @param result The result of the task.
  */
 - (void)setResult:(id)result;
 
 /*!
  Completes the task by setting the error.
  Attempting to set this for a completed task will raise an exception.
+ @param error The error for the task.
  */
 - (void)setError:(NSError *)error;
 
 /*!
  Completes the task by setting an exception.
  Attempting to set this for a completed task will raise an exception.
+ @param exception The exception for the task.
  */
 - (void)setException:(NSException *)exception;
 
@@ -61,12 +64,14 @@
 
 /*!
  Sets the error of the task if it wasn't already completed.
+ @param error The error for the task.
  @returns whether the new value was set.
  */
 - (BOOL)trySetError:(NSError *)error;
 
 /*!
  Sets the exception of the task if it wasn't already completed.
+ @param exception The exception for the task.
  @returns whether the new value was set.
  */
 - (BOOL)trySetException:(NSException *)exception;

Bolts/Common/Bolts.h

@@ -27,6 +27,7 @@ extern NSInteger const kBFMultipleErrorsError;
 
 /*!
  Returns the version of the Bolts Framework as an NSString.
+ @returns The NSString representation of the current version.
  */
 + (NSString *)version;
 

Bolts/iOS/BFURL.h

@@ -21,6 +21,7 @@
 /*!
  Creates a link target from a raw URL. Usually, this will be used to parse a URL passed into
  an app delegate's handleOpenURL: method.
+ @param url The instance of `NSURL` to create BFURL from.
  */
 + (BFURL *)URLWithURL:(NSURL *)url;
 

scripts/build_framework.sh

@@ -168,5 +168,5 @@ fi
 # Done
 #
 
-progress_message "Framework version info:" `perl -pe "s/.*@//" < $BOLTS_SRC/Bolts/BoltsVersion.h`
+progress_message "Framework version info:" `perl -pe "s/.*@//" < $BOLTS_SRC/Bolts/Common/BoltsVersion.h`
 common_success

scripts/common.sh

@@ -58,7 +58,7 @@ if [ -z "$BOLTS_SCRIPT" ]; then
   BOLTS_OSX_FRAMEWORK=$BOLTS_OSX_BUILD/$BOLTS_FRAMEWORK_NAME
 
   # The name of the docset
-  BOLTS_DOCSET_NAME=bolts.docset
+  BOLTS_DOCSET_NAME=Bolts.docset
 
   # The path to the framework docs
   BOLTS_FRAMEWORK_DOCS=$BOLTS_BUILD/$BOLTS_DOCSET_NAME