From 8917eee96220ad8842b78e45ae4d50008d7595f2 Mon Sep 17 00:00:00 2001
From: Adam Retter <adam.retter@googlemail.com>
Date: Sun, 1 Apr 2018 17:04:52 -0700
Subject: [PATCH] Fixed small typos

Summary: Closes https://github.com/facebook/rocksdb/pull/3667

Differential Revision: D7470060

Pulled By: miasantreble

fbshipit-source-id: 8e8545cda38f0805f35ccdb8841666a2d7a965f5
---
 include/rocksdb/sst_file_manager.h            |  6 ++--
 .../src/main/java/org/rocksdb/WriteBatch.java | 30 ++++++++++---------
 2 files changed, 19 insertions(+), 17 deletions(-)

diff --git a/include/rocksdb/sst_file_manager.h b/include/rocksdb/sst_file_manager.h
index c0e109f1e..475a5d47b 100644
--- a/include/rocksdb/sst_file_manager.h
+++ b/include/rocksdb/sst_file_manager.h
@@ -17,7 +17,7 @@ namespace rocksdb {
 class Env;
 class Logger;
 
-// SstFileManager is used to track SST files in the DB and control there
+// SstFileManager is used to track SST files in the DB and control their
 // deletion rate.
 // All SstFileManager public functions are thread-safe.
 // SstFileManager is not extensible.
@@ -29,7 +29,7 @@ class SstFileManager {
   // the total size of the SST files exceeds max_allowed_space, writes to
   // RocksDB will fail.
   //
-  // Setting max_allowed_space to 0 will disable this feature, maximum allowed
+  // Setting max_allowed_space to 0 will disable this feature; maximum allowed
   // space will be infinite (Default value).
   //
   // thread-safe.
@@ -55,7 +55,7 @@ class SstFileManager {
   // thread-safe
   virtual uint64_t GetTotalSize() = 0;
 
-  // Return a map containing all tracked files and there corresponding sizes.
+  // Return a map containing all tracked files and their corresponding sizes.
   // thread-safe
   virtual std::unordered_map<std::string, uint64_t> GetTrackedFiles() = 0;
 
diff --git a/java/src/main/java/org/rocksdb/WriteBatch.java b/java/src/main/java/org/rocksdb/WriteBatch.java
index 5e20daf14..fc95ee594 100644
--- a/java/src/main/java/org/rocksdb/WriteBatch.java
+++ b/java/src/main/java/org/rocksdb/WriteBatch.java
@@ -42,6 +42,8 @@ public class WriteBatch extends AbstractWriteBatch {
   /**
    * Constructs a WriteBatch instance from a serialized representation
    * as returned by {@link #data()}.
+   *
+   * @param serialized the serialized representation.
    */
   public WriteBatch(final byte[] serialized) {
     super(newWriteBatch(serialized, serialized.length));
@@ -78,45 +80,45 @@ public class WriteBatch extends AbstractWriteBatch {
   }
 
   /**
-   * Returns true if PutCF will be called during Iterate.
+   * Returns true if Put will be called during Iterate.
    *
-   * Return true if PutCF will be called during Iterate.
+   * @return true if Put will be called during Iterate.
    */
   public boolean hasPut() {
     return hasPut(nativeHandle_);
   }
 
   /**
-   * Returns true if DeleteCF will be called during Iterate.
+   * Returns true if Delete will be called during Iterate.
    *
-   * Return true if DeleteCF will be called during Iterate.
+   * @return true if Delete will be called during Iterate.
    */
   public boolean hasDelete() {
     return hasDelete(nativeHandle_);
   }
 
   /**
-   * Returns true if SingleDeleteCF will be called during Iterate.
+   * Returns true if SingleDelete will be called during Iterate.
    *
-   * Return true if SingleDeleteCF will be called during Iterate.
+   * @return true if SingleDelete will be called during Iterate.
    */
   public boolean hasSingleDelete() {
     return hasSingleDelete(nativeHandle_);
   }
 
   /**
-   * Returns true if DeleteRangeCF will be called during Iterate.
+   * Returns true if DeleteRange will be called during Iterate.
    *
-   * Return true if DeleteRangeCF will be called during Iterate.
+   * @return true if DeleteRange will be called during Iterate.
    */
   public boolean hasDeleteRange() {
     return hasDeleteRange(nativeHandle_);
   }
 
   /**
-   * Returns true if MergeCF will be called during Iterate.
+   * Returns true if Merge will be called during Iterate.
    *
-   * Return true if MergeCF will be called during Iterate.
+   * @return true if Merge will be called during Iterate.
    */
   public boolean hasMerge() {
     return hasMerge(nativeHandle_);
@@ -125,7 +127,7 @@ public class WriteBatch extends AbstractWriteBatch {
   /**
    * Returns true if MarkBeginPrepare will be called during Iterate.
    *
-   * Return true if MarkBeginPrepare will be called during Iterate.
+   * @return true if MarkBeginPrepare will be called during Iterate.
    */
   public boolean hasBeginPrepare() {
     return hasBeginPrepare(nativeHandle_);
@@ -134,7 +136,7 @@ public class WriteBatch extends AbstractWriteBatch {
   /**
    * Returns true if MarkEndPrepare will be called during Iterate.
    *
-   * Return true if MarkEndPrepare will be called during Iterate.
+   * @return true if MarkEndPrepare will be called during Iterate.
    */
   public boolean hasEndPrepare() {
     return hasEndPrepare(nativeHandle_);
@@ -143,7 +145,7 @@ public class WriteBatch extends AbstractWriteBatch {
   /**
    * Returns true if MarkCommit will be called during Iterate.
    *
-   * Return true if MarkCommit will be called during Iterate.
+   * @return true if MarkCommit will be called during Iterate.
    */
   public boolean hasCommit() {
     return hasCommit(nativeHandle_);
@@ -152,7 +154,7 @@ public class WriteBatch extends AbstractWriteBatch {
   /**
    * Returns true if MarkRollback will be called during Iterate.
    *
-   * Return true if MarkRollback will be called during Iterate.
+   * @return true if MarkRollback will be called during Iterate.
    */
   public boolean hasRollback() {
     return hasRollback(nativeHandle_);
-- 
GitLab