From fdfaf233616a001f36717586917a12638b55d716 Mon Sep 17 00:00:00 2001 From: pjulien Date: Sat, 16 Apr 2016 20:09:28 -0400 Subject: [PATCH] 3847 --- .../google/flatbuffers/FlatBufferBuilder.java | 8 ++++---- java/com/google/flatbuffers/Table.java | 18 ++++++++++++------ 2 files changed, 16 insertions(+), 10 deletions(-) mode change 100644 => 100755 java/com/google/flatbuffers/FlatBufferBuilder.java diff --git a/java/com/google/flatbuffers/FlatBufferBuilder.java b/java/com/google/flatbuffers/FlatBufferBuilder.java old mode 100644 new mode 100755 index e86471397..107da88d9 --- a/java/com/google/flatbuffers/FlatBufferBuilder.java +++ b/java/com/google/flatbuffers/FlatBufferBuilder.java @@ -28,8 +28,7 @@ import java.nio.charset.Charset; /** * Class that helps you build a FlatBuffer. See the section - * @ref flatbuffers_guide_use_java_c-sharp "Use in Java/C#" in the - * main FlatBuffers documentation. + * "Use in Java/C#" in the main FlatBuffers documentation. */ public class FlatBufferBuilder { /// @cond FLATBUFFERS_INTERNAL @@ -428,8 +427,7 @@ public class FlatBufferBuilder { * call this directly. The `FlatBuffers` compiler will generate helper methods * that call this method internally. *

- * For example, using the "Monster" code found on the - * @ref flatbuffers_guide_use_java_c-sharp "landing page". An + * For example, using the "Monster" code found on the "landing page". An * object of type `Monster` can be created using the following code: * *

{@code
@@ -708,6 +706,8 @@ public class FlatBufferBuilder {
      * Get the ByteBuffer representing the FlatBuffer. Only call this after you've
      * called `finish()`. The actual data starts at the ByteBuffer's current position,
      * not necessarily at `0`.
+     *
+     * @return The {@link ByteBuffer} representing the FlatBuffer
      */
     public ByteBuffer dataBuffer() {
         finished();
diff --git a/java/com/google/flatbuffers/Table.java b/java/com/google/flatbuffers/Table.java
index 3d10012a8..36a9bcf90 100644
--- a/java/com/google/flatbuffers/Table.java
+++ b/java/com/google/flatbuffers/Table.java
@@ -113,9 +113,13 @@ public class Table {
   /**
    * Get a whole vector as a ByteBuffer.
    *
-   * This is efficient, since it only allocates a new bytebuffer object, but does not actually copy
-   * the data, it still refers to the same bytes as the original ByteBuffer. Also useful with nested
-   * FlatBuffers, etc.
+   * This is efficient, since it only allocates a new {@link ByteBuffer} object,
+   * but does not actually copy the data, it still refers to the same bytes
+   * as the original ByteBuffer. Also useful with nested FlatBuffers, etc.
+   *
+   * @param vector_offset The position of the vector in the byte buffer
+   * @param elem_size The size of each element in the array
+   * @return The {@link ByteBuffer} for the array
    */
   protected ByteBuffer __vector_as_bytebuffer(int vector_offset, int elem_size) {
     int o = __offset(vector_offset);
@@ -142,10 +146,12 @@ public class Table {
   }
 
   /**
-   * Check if a ByteBuffer contains a file identifier.
+   * Check if a {@link ByteBuffer} contains a file identifier.
    *
-   * @param bb A `ByteBuffer` to check if it contains the identifier `ident`.
-   * @param ident A `String` identifier of the flatbuffer file.
+   * @param bb A {@code ByteBuffer} to check if it contains the identifier
+   * `ident`.
+   * @param ident A `String` identifier of the FlatBuffer file.
+   * @return True if the buffer contains the file identifier
    */
   protected static boolean __has_identifier(ByteBuffer bb, String ident) {
     if (ident.length() != FILE_IDENTIFIER_LENGTH)