Improve documentation on BRSearchObjectType. Fixes #7.

Blue-Rocket · Feb 8, 2016 · e208c80 · e208c80
1 parent 41d082e
commit e208c80
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/BRFullTextSearch/BRIndexable.h b/BRFullTextSearch/BRIndexable.h
@@ -58,7 +58,8 @@ typedef NS_ENUM (unsigned int, BRIndexableIndexType) {
  * Get the type of object this document represents.
  *
  * Search documents are uniquely identified by combining their `indexObjectType` **and**
- * `indexIdentifier` values.
+ * `indexIdentifier` values. The actual values used are arbitrary and application dependent.
+ * Simple applications might use a single value for all search documents.
  *
  * @return the type of object
  */

diff --git a/BRFullTextSearch/BRSearchFields.h b/BRFullTextSearch/BRSearchFields.h
@@ -25,7 +25,7 @@ extern NSString *const kBRSearchFieldNameValue;
 /** Search field constant for a date value (`s`). */
 extern NSString *const kBRSearchFieldNameTimestamp;
 
-/** Type definition for a "type of" search object flag. */
+/** Type definition for a "type of" search object flag. Values are arbitrary and application dependent. */
 typedef char BRSearchObjectType;
 
 /**