Clarify documentation based on review comments

This commit is contained in:
pjulien 2016-05-23 16:47:41 -04:00
parent 9d8ae1b0c3
commit 1aa3ee2170
1 changed files with 2 additions and 1 deletions

View File

@ -368,7 +368,8 @@ public class FlatBufferBuilder {
/// @endcond /// @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. * @param s The string to encode.
* @return The offset in the buffer where the encoded string starts. * @return The offset in the buffer where the encoded string starts.