Merge branch 'release/0.5.0'

iabudiab · Jul 30, 2015 · 6745ca9 · 6745ca9
2 parents b48f75b + d511714
commit 6745ca9
Show file tree

Hide file tree

Showing 60 changed files with 2,837 additions and 341 deletions.
diff --git a/ObjectiveRocks.xcodeproj/project.pbxproj b/ObjectiveRocks.xcodeproj/project.pbxproj
diff --git a/ObjectiveRocks.xcodeproj/xcshareddata/xcschemes/ObjectiveRocks-iOS.xcscheme b/ObjectiveRocks.xcodeproj/xcshareddata/xcschemes/ObjectiveRocks-iOS.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0610"
+   LastUpgradeVersion = "0630"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/ObjectiveRocks.xcodeproj/xcshareddata/xcschemes/ObjectiveRocks.xcscheme b/ObjectiveRocks.xcodeproj/xcshareddata/xcschemes/ObjectiveRocks.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0610"
+   LastUpgradeVersion = "0630"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/ObjectiveRocks.xcodeproj/xcshareddata/xcschemes/ObjectiveRocksTests-iOS.xcscheme b/ObjectiveRocks.xcodeproj/xcshareddata/xcschemes/ObjectiveRocksTests-iOS.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0610"
+   LastUpgradeVersion = "0630"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/ObjectiveRocks.xcodeproj/xcshareddata/xcschemes/ObjectiveRocksTests.xcscheme b/ObjectiveRocks.xcodeproj/xcshareddata/xcschemes/ObjectiveRocksTests.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0610"
+   LastUpgradeVersion = "0630"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/ObjectiveRocks/RocksDB+Private.h b/ObjectiveRocks/RocksDB+Private.h
@@ -13,12 +13,31 @@ namespace rocksdb {
 	class ColumnFamilyHandle;
 }
 
+/**
+ This category is intended to hide all C++ types from the public interface in order to
+ maintain a pure Objective-C API for Swift compatibility.
+ */
 @interface RocksDB (Private)
 
+/** @brief The underlying rocks::DB instance. */
 @property (nonatomic, assign) rocksdb::DB *db;
+
+/** @brief The underlying rocksdb::ColumnFamilyHandle associated with this instance. */
 @property (nonatomic, assign) rocksdb::ColumnFamilyHandle *columnFamily;
+
+/** @brief The DB options. 
+ @see RocksDBOptions
+ */
 @property (nonatomic, retain) RocksDBOptions *options;
+
+/** @brief The read options.
+ @see RocksDBReadOptions
+ */
 @property (nonatomic, retain) RocksDBReadOptions *readOptions;
+
+/** @brief The write options
+ @see RocksDBWriteOptions
+ */
 @property (nonatomic, retain) RocksDBWriteOptions *writeOptions;
 
 @end