Update documentation format, fix #6.

Author: kevin-lyn

STNetTaskQueue/STHTTPNetTask.h

@@ -12,7 +12,7 @@
 FOUNDATION_EXPORT NSString *const STHTTPNetTaskServerError;
 FOUNDATION_EXPORT NSString *const STHTTPNetTaskResponseParsedError;
 
-// Error "userInfo" key
+// Error "userInfo" keys
 FOUNDATION_EXPORT NSString *const STHTTPNetTaskErrorStatusCodeUserInfoKey;
 FOUNDATION_EXPORT NSString *const STHTTPNetTaskErrorResponseDataUserInfoKey;
 
@@ -39,12 +39,12 @@ typedef NS_ENUM(NSUInteger, STHTTPNetTaskResponseType) {
     STHTTPNetTaskResponseRawData
 };
 
-/*
+/**
  If a class conforms to this protocol, it means the instance of this class will be converted to a dictionary and passed as parameter in a HTTP request.
  */
 @protocol STHTTPNetTaskRequestObject <NSObject>
 
-/* 
+/**
  Properties which should be ignored when packing parameters for reqeust.
  
  @return NSArray An array of strings representing the name of properties to be ignored.
@@ -53,7 +53,7 @@ typedef NS_ENUM(NSUInteger, STHTTPNetTaskResponseType) {
 
 @optional
 
-/*
+/**
  Separator string which should be used when packing parameters.
  E.g. property schoolName will be converted to school_name.
  Default: @"_"
@@ -64,76 +64,76 @@ typedef NS_ENUM(NSUInteger, STHTTPNetTaskResponseType) {
 
 @end
 
-/*
+/**
  Net task which is designed for HTTP protocol.
  */
 @interface STHTTPNetTask : STNetTask<STHTTPNetTaskRequestObject>
 
-/*
+/**
  HTTP method which should be used for the HTTP net task.
  
  @return STHTTPNetTaskMethod
  */
 - (STHTTPNetTaskMethod)method;
 
-/*
+/**
  Request parameters format. E.g JSON, key-value string(form param).
  
  @return STHTTPNetTaskRequestType
  */
 - (STHTTPNetTaskRequestType)requestType;
 
-/*
+/**
  Response data format. E.g JSON, String, Raw data.
  
  @return STHTTPNetTaskResponseType
  */
 - (STHTTPNetTaskResponseType)responseType;
 
-/*
+/**
  Custom headers which will be added into HTTP request headers.
  
  @return NSDictionary<NSString, NSString> Custom headers, e.g. @{ @"User-Agent": @"STNetTaskQueue Client" }
  */
 - (NSDictionary *)headers;
 
-/*
+/**
  Additional parameters which will be added as HTTP request parameters.
  
  @return NSDictionary<NSString, id>
  */
 - (NSDictionary *)parameters;
 
-/*
+/**
  NSDatas which will be added into multi-part form data body,
  requestType should be STHTTPNetTaskRequestFormData if you are going to return datas.
  
  @return NSDictionary<NSString, NSData>
  */
 - (NSDictionary *)datas;
 
-/*
+/**
  This method will be called if the response object is a dictionary.
  
  @param dictionary NSDictionary
  */
 - (void)didResponseDictionary:(NSDictionary *)dictionary;
 
-/*
+/**
  This method will be called if the response object is an array.
  
  @param array NSArray
  */
 - (void)didResponseArray:(NSArray *)array;
 
-/*
+/**
  This method will be called if the response obejct is a string.
  
  @param string NSString
  */
 - (void)didResponseString:(NSString *)string;
 
-/*
+/**
  This method will be called if the response object is NSData
  
  @param data NSData

STNetTaskQueue/STHTTPNetTaskQueueHandler.h

@@ -10,15 +10,15 @@
 
 @interface STHTTPNetTaskQueueHandler : NSObject<STNetTaskQueueHandler>
 
-/*
+/**
  Init the handler with base URL, a base URL will be used for constructing the whole url for HTTP net tasks.
  E.g HTTP net task returns uri "user/profile", handled by handler with baseURL "http://example.com", the whole url will be http://example.com/user/profile".
  
  @param baseURL NSURL
  */
 - (instancetype)initWithBaseURL:(NSURL *)baseURL;
 
-/*
+/**
  Init the handler with baseURL and NSURLSessionConfiguration.
  
  @param baseURL NSURL

STNetTaskQueue/STNetTask.h

@@ -30,7 +30,7 @@ FOUNDATION_EXPORT NSString *const STNetTaskUnknownError;
 
 @protocol STNetTaskDelegate <NSObject>
 
-/*
+/**
  This delegate method will be called when the net task is finished(no matter it's successful or failed).
  If the net task is failed, task.error will be non-nil.
  
@@ -50,63 +50,69 @@ typedef void (^STNetTaskSubscriptionBlock)();
 
 @interface STNetTask : NSObject
 
-/* Error object which contains error message when net task is failed. */
+/**
+ Error object which contains error message when net task is failed.
+ */
 @property (atomic, strong) NSError *error;
 
-/*
+/**
  Indicates if the net task is waiting for executing or executing.
  This value will be set to "YES" immediately after the net task is added to net task queue.
  */
 @property (atomic, assign, readonly) BOOL pending;
 
-/*
+/**
  Indicates if the net task is cancelled.
  This value would be "NO" by default after net task is created, even the net task is not added to queue.
  */
 @property (atomic, assign, readonly) BOOL cancelled;
 
-/* Indicates if the net task is finished(no matter it's successful or failed). */
+/**
+ Indicates if the net task is finished(no matter it's successful or failed).
+ */
 @property (atomic, assign, readonly) BOOL finished;
 
-/* The current retry time @see maxRetryCount */
+/**
+ The current retry time @see maxRetryCount
+ */
 @property (atomic, assign, readonly) NSUInteger retryCount;
 
-/*
+/**
  A unique string represents the net task.
  
  @return NSString The uri string.
  */
 - (NSString *)uri;
 
-/*
+/**
  A callback method which is called when the net task is finished successfully.
  Note: this method will be called in thread of STNetTaskQueue.
  
  @param response id The response object.
  */
 - (void)didResponse:(id)response;
 
-/*
+/**
  A callback method which is called when the net task is failed.
  Note: this method will be called in thread of STNetTaskQueue.
  */
 - (void)didFail;
 
-/*
+/**
  A callback method which is called when the net task is retried.
  Note: this method will be called in thread of STNetTaskQueue.
  */
 - (void)didRetry;
 
-/*
+/**
  Indicates how many times the net task should be retried after failed.
  Default 0.
  
  @return NSUInteger
  */
 - (NSUInteger)maxRetryCount;
 
-/*
+/**
  If you are going to retry the net task only when specific error is returned, return NO in this method.
  Default YES.
  
@@ -115,14 +121,14 @@ typedef void (^STNetTaskSubscriptionBlock)();
  */
 - (BOOL)shouldRetryForError:(NSError *)error;
 
-/*
+/**
  Indicates how many seconds should be delayed before retrying the net task.
  
  @return NSTimeInterval
  */
 - (NSTimeInterval)retryInterval;
 
-/*
+/**
  Subscribe state of net task by using block
  
  @param state STNetTaskState state of net task

STNetTaskQueue/STNetTaskQueue.h

@@ -19,15 +19,15 @@ FOUNDATION_EXPORT const unsigned char STNetTaskQueueVersionString[];
 
 @protocol STNetTaskQueueHandler <NSObject>
 
-/*
+/**
  STNetTaskQueue will call this method when a net task is added to queue and become ready to be excecuted.
  
  @param netTaskQueue STNetTaskQueue The net task queue which is holding the net task.
  @param task STNetTask The net task which is ready to be executed.
  */
 - (void)netTaskQueue:(STNetTaskQueue *)netTaskQueue handleTask:(STNetTask *)task;
 
-/*
+/**
  STNetTaskQueue will call this method when a net task is cancelled and removed from net task queue.
  Giving a chance to the handler to do a clean up for the cancelled net task.
  
@@ -36,7 +36,7 @@ FOUNDATION_EXPORT const unsigned char STNetTaskQueueVersionString[];
  */
 - (void)netTaskQueue:(STNetTaskQueue *)netTaskQueue didCancelTask:(STNetTask *)task;
 
-/*
+/**
  STNetTaskQueue will call this method when the net task queue is deallocated.
  
  @param netTaskQueue STNetTaskQueue The net task queue which is deallocated.
@@ -47,21 +47,23 @@ FOUNDATION_EXPORT const unsigned char STNetTaskQueueVersionString[];
 
 @interface STNetTaskQueue : NSObject
 
-/* The STNetTaskQueueHandler which is used for handling the net tasks in queue. */
+/**
+ The STNetTaskQueueHandler which is used for handling the net tasks in queue.
+ */
 @property (nonatomic, strong) id<STNetTaskQueueHandler> handler;
 
-/* 
+/**
  Count of Max concurrent task in a queue.
  If the number of unfinished tasks in queue hits the max count, upcoming task will be processed till one of the unfinished task is done.
  */
 @property (nonatomic, assign) NSUInteger maxConcurrentTasksCount;
 
-/*
+/**
  A shared STNetTaskQueue instance.
  */
 + (instancetype)sharedQueue;
 
-/*
+/**
  Add a net task into the net task queue.
  The net task may not be executed immediately depends on the "maxConcurrentTasksCount",
  but the net task will be marked as "pending" anyway.
@@ -70,15 +72,15 @@ FOUNDATION_EXPORT const unsigned char STNetTaskQueueVersionString[];
  */
 - (void)addTask:(STNetTask *)task;
 
-/*
+/**
  Cancel and remove the net task from queue.
  If the net task is executing, it will be cancelled and remove from the queue without calling the "netTaskDidEnd" delegate method.
  
  @param task STNetTask The net task to be cancelled and removed from the queue.
  */
 - (void)cancelTask:(STNetTask *)task;
 
-/*
+/**
  This method should be called when the "handler" finish handling the net task successfully.
  After "handler" called this method, the net task will be marked as "finished", set "pending" as "NO", and removed from the queue.
  
@@ -87,7 +89,7 @@ FOUNDATION_EXPORT const unsigned char STNetTaskQueueVersionString[];
  */
 - (void)task:(STNetTask *)task didResponse:(id)response;
 
-/*
+/**
  This method should be caled when the "handler" finish handling the net task with error.
  After "hadnler" called this method, the net task will be marked as "finished", set "pending" as "NO", and removed from the queue.
  
@@ -96,7 +98,7 @@ FOUNDATION_EXPORT const unsigned char STNetTaskQueueVersionString[];
  */
 - (void)task:(STNetTask *)task didFailWithError:(NSError *)error;
 
-/*
+/**
  Add a net task delegate to "STNetTaskQueue" with uri of the net task,
  it's a weak reference and duplicated delegate with same uri will be ignored.
  
@@ -105,7 +107,7 @@ FOUNDATION_EXPORT const unsigned char STNetTaskQueueVersionString[];
  */
 - (void)addTaskDelegate:(id<STNetTaskDelegate>)delegate uri:(NSString *)uri;
 
-/*
+/**
  Add a net task delegate to "STNetTaskQueue" with class of net task,
  it's a weak reference and duplicated delegate with same class will be ignored.
  
@@ -114,7 +116,7 @@ FOUNDATION_EXPORT const unsigned char STNetTaskQueueVersionString[];
  */
 - (void)addTaskDelegate:(id<STNetTaskDelegate>)delegate class:(Class)clazz;
 
-/*
+/**
  Most of the times you don't need to remove net task delegate explicitly,
  because "STNetTaskQueue" holds weak reference of each delegate.
  

STNetTaskQueueTest/STNetTaskQueueTest/STNetTaskQueueTestHTTP.m

@@ -6,7 +6,6 @@
 //
 //
 
-#import <UIKit/UIKit.h>
 #import <XCTest/XCTest.h>
 #import <STNetTaskQueue/STNetTaskQueue.h>
 #import "STTestRetryNetTask.h"