Browse Source

Addition of FMStatement documentation

Rob Ryan 12 years ago
parent
commit
a83ce3f848
1 changed files with 36 additions and 0 deletions
  1. 36 0
      src/FMDatabase.h

+ 36 - 0
src/FMDatabase.h

@@ -812,17 +812,53 @@
 @end
 @end
 
 
 
 
+/** Objective-C wrapper for `sqlite3_stmt`
+ 
+ This is a wrapper for a SQLite `sqlite3_stmt`. Generally when using FMDB you will not need to interact directly with `FMStatement`, but rather with `<FMDatabase>` and `<FMResultSet>` only.
+ 
+ ### See also
+ 
+ - `<FMDatabase>`
+ - `<FMResultSet>`
+ - [`sqlite3_stmt`](http://www.sqlite.org/c3ref/stmt.html)
+ */
+
 @interface FMStatement : NSObject {
 @interface FMStatement : NSObject {
     sqlite3_stmt *_statement;
     sqlite3_stmt *_statement;
     NSString *_query;
     NSString *_query;
     long _useCount;
     long _useCount;
 }
 }
 
 
+///---------------------------------------------------------------------------------------
+/// @name Properties
+///---------------------------------------------------------------------------------------
+
+/** Usage count */
+
 @property (atomic, assign) long useCount;
 @property (atomic, assign) long useCount;
+
+/** SQL statement */
+
 @property (atomic, retain) NSString *query;
 @property (atomic, retain) NSString *query;
+
+/** SQLite sqlite3_stmt
+ 
+ @see [`sqlite3_stmt`](http://www.sqlite.org/c3ref/stmt.html)
+ */
+
 @property (atomic, assign) sqlite3_stmt *statement;
 @property (atomic, assign) sqlite3_stmt *statement;
 
 
+
+///---------------------------------------------------------------------------------------
+/// @name Closing and Resetting
+///---------------------------------------------------------------------------------------
+
+/** Close statement */
+
 - (void)close;
 - (void)close;
+
+/** Reset statement */
+
 - (void)reset;
 - (void)reset;
 
 
 @end
 @end