Browse Source

added appledoc-style documentation to headers of FMSQLStatementSplitter

openthread 11 years ago
parent
commit
a29e7c4688

+ 19 - 0
src/extra/FMStatementSplitter/FMSQLStatementSplitter.h

@@ -8,14 +8,33 @@
 
 #import <Foundation/Foundation.h>
 
+/**
+ * The FMSplittedStatement class contains a separated statement.
+ */
 @interface FMSplittedStatement : NSObject
+
+/**
+ * Separated statement string.
+ */
 @property (nonatomic, retain) NSString *statementString;//statement string
 @end
 
 @interface FMSQLStatementSplitter : NSObject
 
+/**
+ * Get singleton instance.
+ */
 + (instancetype)sharedInstance;
 
+/**
+ * Split batch sql statement into separated statements.
+ *
+ * @param batchStatement The batch statement string to split.
+ *
+ * @return Returns the array of splitted statements. Each member of return value is an `FMSplittedStatement`.
+ *
+ * @see FMSplittedStatement
+ */
 - (NSArray *)statementsFromBatchSqlStatement:(NSString *)batchStatement;
 
 @end

+ 10 - 0
src/extra/FMStatementSplitter/FMStatementTokenRecogniser.h

@@ -8,9 +8,19 @@
 
 #import <Foundation/Foundation.h>
 
+/**
+ * The FMStatementTokenRecogniser protocol.
+ */
 @protocol FMStatementTokenRecogniser <NSObject>
 
 @required
+/**
+ * Recognise token with a scanner.
+ * @param scanner The recognising scanner.
+ * @param tokenPosition Begining token position to recognise of scanner.
+ *
+ * @return Returns the recognised token range of scanner. If not recognised, the location of return value is `NSNotFound`.
+ */
 - (NSRange)recogniseRangeWithScanner:(NSScanner *)scanner currentTokenPosition:(NSUInteger *)tokenPosition;
 
 @end