Browse Source

Changed @name formatting. Shorter lines looks nicer if your screen is small.

Added @warning to every encryption method. Otherwise the note was not visible in generated documentation.
Anton Sotkov 12 years ago
parent
commit
1cc58c2753
5 changed files with 65 additions and 63 deletions
  1. 37 35
      src/FMDatabase.h
  2. 6 6
      src/FMDatabaseAdditions.h
  3. 6 6
      src/FMDatabasePool.h
  4. 6 6
      src/FMDatabaseQueue.h
  5. 10 10
      src/FMResultSet.h

+ 37 - 35
src/FMDatabase.h

@@ -91,9 +91,9 @@
     NSDateFormatter     *_dateFormat;
 }
 
-///---------------------------------------------------------------------------------------
+///-----------------
 /// @name Properties
-///---------------------------------------------------------------------------------------
+///-----------------
 
 /** Whether should trace execution */
 
@@ -119,9 +119,9 @@
 
 @property (atomic, retain) NSMutableDictionary *cachedStatements;
 
-///---------------------------------------------------------------------------------------
+///---------------------
 /// @name Initialization
-///---------------------------------------------------------------------------------------
+///---------------------
 
 /** Create a `FMDatabase` object.
  
@@ -180,9 +180,9 @@
 - (id)initWithPath:(NSString*)inPath;
 
 
-///---------------------------------------------------------------------------------------
+///-----------------------------------
 /// @name Opening and closing database
-///---------------------------------------------------------------------------------------
+///-----------------------------------
 
 /** Opening a new database connection
  
@@ -248,9 +248,9 @@
 - (BOOL)goodConnection;
 
 
-///---------------------------------------------------------------------------------------
+///----------------------
 /// @name Perform updates
-///---------------------------------------------------------------------------------------
+///----------------------
 
 /** Execute update statement
  
@@ -340,9 +340,9 @@
 - (int)changes;
 
 
-///---------------------------------------------------------------------------------------
+///-------------------------
 /// @name Retrieving results
-///---------------------------------------------------------------------------------------
+///-------------------------
 
 /** Execute select statement
 
@@ -419,9 +419,9 @@
 
 - (FMResultSet *)executeQuery:(NSString *)sql withParameterDictionary:(NSDictionary *)arguments;
 
-///---------------------------------------------------------------------------------------
+///-------------------
 /// @name Transactions
-///---------------------------------------------------------------------------------------
+///-------------------
 
 /** Begin a transaction
  
@@ -488,9 +488,9 @@
 - (BOOL)inTransaction;
 
 
-///---------------------------------------------------------------------------------------
+///----------------------------------------
 /// @name Cached statements and result sets
-///---------------------------------------------------------------------------------------
+///----------------------------------------
 
 /** Clear cached statements */
 
@@ -522,11 +522,9 @@
 - (void)setShouldCacheStatements:(BOOL)value;
 
 
-///---------------------------------------------------------------------------------------
+///-------------------------
 /// @name Encryption methods
-///
-/// You need to have purchased the sqlite encryption extensions for these to work.
-///---------------------------------------------------------------------------------------
+///-------------------------
 
 /** Set encryption key.
  
@@ -535,7 +533,8 @@
  @return `YES` if success, `NO` on error.
 
  @see http://www.sqlite-encrypt.com/develop-guide.htm
-
+ 
+ @warning You need to have purchased the sqlite encryption extensions for this method to work.
  */
 
 - (BOOL)setKey:(NSString*)key;
@@ -548,6 +547,7 @@
 
  @see http://www.sqlite-encrypt.com/develop-guide.htm
 
+ @warning You need to have purchased the sqlite encryption extensions for this method to work.
  */
 
 - (BOOL)rekey:(NSString*)key;
@@ -560,6 +560,7 @@
 
  @see http://www.sqlite-encrypt.com/develop-guide.htm
  
+ @warning You need to have purchased the sqlite encryption extensions for this method to work.
  */
 
 - (BOOL)setKeyWithData:(NSData *)keyData;
@@ -572,14 +573,15 @@
 
  @see http://www.sqlite-encrypt.com/develop-guide.htm
 
+ @warning You need to have purchased the sqlite encryption extensions for this method to work.
  */
 
 - (BOOL)rekeyWithData:(NSData *)keyData;
 
 
-///---------------------------------------------------------------------------------------
+///------------------------------
 /// @name General inquiry methods
-///---------------------------------------------------------------------------------------
+///------------------------------
 
 /** The path of the database file
  
@@ -598,9 +600,9 @@
 - (sqlite3*)sqliteHandle;
 
 
-///---------------------------------------------------------------------------------------
+///-----------------------------
 /// @name Retrieving error codes
-///---------------------------------------------------------------------------------------
+///-----------------------------
 
 /** Last error message
  
@@ -656,9 +658,9 @@
 
 #if SQLITE_VERSION_NUMBER >= 3007000
 
-///---------------------------------------------------------------------------------------
+///------------------
 /// @name Save points
-///---------------------------------------------------------------------------------------
+///------------------
 
 /** Start save point
  
@@ -719,9 +721,9 @@
 
 #endif
 
-///---------------------------------------------------------------------------------------
+///----------------------------
 /// @name SQLite library status
-///---------------------------------------------------------------------------------------
+///----------------------------
 
 /** Test to see if the library is threadsafe
 
@@ -740,9 +742,9 @@
 + (NSString*)sqliteLibVersion;
 
 
-///---------------------------------------------------------------------------------------
+///------------------------
 /// @name Make SQL function
-///---------------------------------------------------------------------------------------
+///------------------------
 
 /** Adds SQL functions or aggregates or to redefine the behavior of existing SQL functions or aggregates.
  
@@ -791,9 +793,9 @@
 - (void)makeFunctionNamed:(NSString*)name maximumArguments:(int)count withBlock:(void (^)(sqlite3_context *context, int argc, sqlite3_value **argv))block;
 
 
-///---------------------------------------------------------------------------------------
+///---------------------
 /// @name Date formatter
-///---------------------------------------------------------------------------------------
+///---------------------
 
 /** Generate an `NSDateFormatter` that won't be broken by permutations of timezones or locales.
  
@@ -897,9 +899,9 @@
     long _useCount;
 }
 
-///---------------------------------------------------------------------------------------
+///-----------------
 /// @name Properties
-///---------------------------------------------------------------------------------------
+///-----------------
 
 /** Usage count */
 
@@ -917,9 +919,9 @@
 @property (atomic, assign) sqlite3_stmt *statement;
 
 
-///---------------------------------------------------------------------------------------
+///----------------------------
 /// @name Closing and Resetting
-///---------------------------------------------------------------------------------------
+///----------------------------
 
 /** Close statement */
 

+ 6 - 6
src/FMDatabaseAdditions.h

@@ -17,9 +17,9 @@
 
 @interface FMDatabase (FMDatabaseAdditions)
 
-///---------------------------------------------------------------------------------------
+///----------------------------------------
 /// @name Return results of SQL to variable
-///---------------------------------------------------------------------------------------
+///----------------------------------------
 
 /** Return `int` value for query
  
@@ -97,9 +97,9 @@
 // happens to the data that we just didn't copy?  Who knows, not I.
 
 
-///---------------------------------------------------------------------------------------
+///--------------------------------
 /// @name Schema related operations
-///---------------------------------------------------------------------------------------
+///--------------------------------
 
 /** Does table exist in database?
 
@@ -195,9 +195,9 @@
 
 #if SQLITE_VERSION_NUMBER >= 3007017
 
-///---------------------------------------------------------------------------------------
+///-----------------------------------
 /// @name Application identifier tasks
-///---------------------------------------------------------------------------------------
+///-----------------------------------
 
 /** Retrieve application ID
  

+ 6 - 6
src/FMDatabasePool.h

@@ -46,9 +46,9 @@
 @property (atomic, assign) id delegate;
 @property (atomic, assign) NSUInteger maximumNumberOfDatabasesToCreate;
 
-///---------------------------------------------------------------------------------------
+///---------------------
 /// @name Initialization
-///---------------------------------------------------------------------------------------
+///---------------------
 
 /** Create pool using path.
 
@@ -68,9 +68,9 @@
 
 - (id)initWithPath:(NSString*)aPath;
 
-///---------------------------------------------------------------------------------------
+///------------------------------------------------
 /// @name Keeping track of checked in/out databases
-///---------------------------------------------------------------------------------------
+///------------------------------------------------
 
 /** Number of checked-in databases in pool
  
@@ -97,9 +97,9 @@
 
 - (void)releaseAllDatabases;
 
-///---------------------------------------------------------------------------------------
+///------------------------------------------
 /// @name Perform database operations in pool
-///---------------------------------------------------------------------------------------
+///------------------------------------------
 
 /** Synchronously perform database operations in pool.
 

+ 6 - 6
src/FMDatabaseQueue.h

@@ -69,9 +69,9 @@
 
 @property (atomic, retain) NSString *path;
 
-///---------------------------------------------------------------------------------------
+///----------------------------------------------------
 /// @name Initialization, opening, and closing of queue
-///---------------------------------------------------------------------------------------
+///----------------------------------------------------
 
 /** Create queue using path.
  
@@ -95,9 +95,9 @@
 
 - (void)close;
 
-///---------------------------------------------------------------------------------------
+///-----------------------------------------------
 /// @name Dispatching database operations to queue
-///---------------------------------------------------------------------------------------
+///-----------------------------------------------
 
 /** Synchronously perform database operations on queue.
  
@@ -120,9 +120,9 @@
 
 - (void)inDeferredTransaction:(void (^)(FMDatabase *db, BOOL *rollback))block;
 
-///---------------------------------------------------------------------------------------
+///-----------------------------------------------
 /// @name Dispatching database operations to queue
-///---------------------------------------------------------------------------------------
+///-----------------------------------------------
 
 /** Synchronously perform database operations using save point.
 

+ 10 - 10
src/FMResultSet.h

@@ -31,9 +31,9 @@
     NSMutableDictionary *_columnNameToIndexMap;
 }
 
-///---------------------------------------------------------------------------------------
+///-----------------
 /// @name Properties
-///---------------------------------------------------------------------------------------
+///-----------------
 
 /** Executed query */
 
@@ -47,9 +47,9 @@
 
 @property (atomic, retain) FMStatement *statement;
 
-///---------------------------------------------------------------------------------------
+///------------------------------------
 /// @name Creating and closing database
-///---------------------------------------------------------------------------------------
+///------------------------------------
 
 /** Create result set from `<FMStatement>`
  
@@ -68,9 +68,9 @@
 
 - (void)setParentDB:(FMDatabase *)newDb;
 
-///---------------------------------------------------------------------------------------
+///---------------------------------------
 /// @name Iterating through the result set
-///---------------------------------------------------------------------------------------
+///---------------------------------------
 
 /** Retrieve next row for result set.
  
@@ -88,9 +88,9 @@
 
 - (BOOL)hasAnotherRow;
 
-///---------------------------------------------------------------------------------------
+///---------------------------------------------
 /// @name Retrieving information from result set
-///---------------------------------------------------------------------------------------
+///---------------------------------------------
 
 /** How many columns in result set
  
@@ -433,9 +433,9 @@ If you don't, you're going to be in a world of hurt when you try and use the dat
 
 - (NSDictionary*)resultDict  __attribute__ ((deprecated));
 
-///---------------------------------------------------------------------------------------
+///-----------------------------
 /// @name Key value coding magic
-///---------------------------------------------------------------------------------------
+///-----------------------------
 
 /** Performs `setValue` to yield support for key value observing.