Browse Source

Make @warnings last entry in documents

Rob Ryan 12 years ago
parent
commit
bf47d3d433
4 changed files with 14 additions and 13 deletions
  1. 5 4
      src/FMDatabase.h
  2. 2 2
      src/FMDatabaseAdditions.h
  3. 5 5
      src/FMDatabasePool.h
  4. 2 2
      src/FMResultSet.h

+ 5 - 4
src/FMDatabase.h

@@ -807,13 +807,14 @@
  
  @return A `NSDateFormatter` that can be used for converting dates to strings and vice versa.
  
- @warning Note that `NSDateFormatter` is not thread-safe, so the formatter generated by this method should be assigned to only one FMDB instance and should not be used for other purposes.
-
  @see hasDateFormatter
  @see setDateFormat:
  @see dateFromString:
  @see stringFromDate:
  @see storeableDateFormat:
+
+ @warning Note that `NSDateFormatter` is not thread-safe, so the formatter generated by this method should be assigned to only one FMDB instance and should not be used for other purposes.
+
  */
 
 + (NSDateFormatter *)storeableDateFormat:(NSString *)format;
@@ -835,13 +836,13 @@
  
  @param format Set to nil to use UNIX timestamps. Defaults to nil. Should be set using a formatter generated using FMDatabase::storeableDateFormat.
  
- @warning Note there is no direct getter for the `NSDateFormatter`, and you should not use the formatter you pass to FMDB for other purposes, as `NSDateFormatter` is not thread-safe.
-
  @see hasDateFormatter
  @see setDateFormat:
  @see dateFromString:
  @see stringFromDate:
  @see storeableDateFormat:
+ 
+ @warning Note there is no direct getter for the `NSDateFormatter`, and you should not use the formatter you pass to FMDB for other purposes, as `NSDateFormatter` is not thread-safe.
  */
 
 - (void)setDateFormat:(NSDateFormatter *)format;

+ 2 - 2
src/FMDatabaseAdditions.h

@@ -170,9 +170,9 @@
 
  @return `YES` if column exists in table in question; `NO` otherwise.
  
- @warning Deprecated - use `<columnExists:inTableWithName:>` instead.
- 
  @see columnExists:inTableWithName:
+ 
+ @warning Deprecated - use `<columnExists:inTableWithName:>` instead.
  */
 
 - (BOOL)columnExists:(NSString*)tableName columnName:(NSString*)columnName __attribute__ ((deprecated));

+ 5 - 5
src/FMDatabasePool.h

@@ -13,6 +13,11 @@
 
 /** Pool of `<FMDatabase>` objects.
 
+ ### See also
+ 
+ - `<FMDatabaseQueue>`
+ - `<FMDatabase>`
+
  @warning Before using `FMDatabasePool`, please consider using `<FMDatabaseQueue>` instead.
 
  If you really really really know what you're doing and `FMDatabasePool` is what
@@ -22,11 +27,6 @@
  For an example on deadlocking, search for:
  `ONLY_USE_THE_POOL_IF_YOU_ARE_DOING_READS_OTHERWISE_YOULL_DEADLOCK_USE_FMDATABASEQUEUE_INSTEAD`
  in the main.m file.
- 
- ### See also
-
- - `<FMDatabaseQueue>`
- - `<FMDatabase>`
  */
 
 @interface FMDatabasePool : NSObject {

+ 2 - 2
src/FMResultSet.h

@@ -426,9 +426,9 @@ If you don't, you're going to be in a world of hurt when you try and use the dat
  
 /** Returns a dictionary of the row results
  
- @warning **Deprecated**: Please use `<resultDictionary>` instead.  Also, beware that `<resultDictionary>` is case sensitive! 
- 
  @see resultDictionary
+ 
+ @warning **Deprecated**: Please use `<resultDictionary>` instead.  Also, beware that `<resultDictionary>` is case sensitive! 
  */
 
 - (NSDictionary*)resultDict  __attribute__ ((deprecated));