Clarify documentation based on review comments

2016-05-23 16:47:41 -04:00 · 2016-05-23 16:47:41 -04:00 · 1aa3ee2170
parent 9d8ae1b0c3
commit 1aa3ee2170
1 changed files with 2 additions and 1 deletions
--- a/java/com/google/flatbuffers/FlatBufferBuilder.java
+++ b/java/com/google/flatbuffers/FlatBufferBuilder.java
@ -368,7 +368,8 @@ public class FlatBufferBuilder {
    /// @endcond

   /**
-    * Encode the string `s` in the buffer using UTF-8.
+    * Encode the string `s` in the buffer using UTF-8.  If {@code s} is
+    * already a {@link CharBuffer}, this method is allocation free.
    *
    * @param s The string to encode.
    * @return The offset in the buffer where the encoded string starts.