소스 검색

add some missing javadoc (2 files in com.jme3.util)

Stephen Gold 5 년 전
부모
커밋
33ebbef214
2개의 변경된 파일24개의 추가작업 그리고 6개의 파일을 삭제
  1. 11 2
      jme3-core/src/main/java/com/jme3/util/BufferAllocator.java
  2. 13 4
      jme3-core/src/main/java/com/jme3/util/PrimitiveAllocator.java

+ 11 - 2
jme3-core/src/main/java/com/jme3/util/BufferAllocator.java

@@ -4,9 +4,18 @@ import java.nio.Buffer;
 import java.nio.ByteBuffer;
 
 public interface BufferAllocator {
-
+    /**
+     * De-allocate a direct buffer.
+     *
+     * @param toBeDestroyed the buffer to de-allocate (not null)
+     */
     void destroyDirectBuffer(Buffer toBeDestroyed);
 
+    /**
+     * Allocate a direct ByteBuffer of the specified size.
+     *
+     * @param size in bytes (≥0)
+     * @return a new direct buffer
+     */
     ByteBuffer allocate(int size);
-
 }

+ 13 - 4
jme3-core/src/main/java/com/jme3/util/PrimitiveAllocator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2018 jMonkeyEngine
+ * Copyright (c) 2009-2020 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -39,17 +39,26 @@ import java.nio.ByteBuffer;
  * on any jvm
  */
 public final class PrimitiveAllocator implements BufferAllocator {
-
+    /**
+     * De-allocate a direct buffer.
+     *
+     * @param toBeDestroyed ignored
+     */
     @Override
     public void destroyDirectBuffer(Buffer toBeDestroyed) {
-        // no exception by intent, as this way naivly written java7/8
+        // no exception by intent, as this way naively written java7/8
         // applications won't crash on 9 assuming they can dispose buffers
         System.err.println("Warning destroyBuffer not supported");
     }
 
+    /**
+     * Allocate a direct ByteBuffer of the specified size.
+     *
+     * @param size in bytes (≥0)
+     * @return a new direct buffer
+     */
     @Override
     public ByteBuffer allocate(int size) {
         return ByteBuffer.allocateDirect(size);
     }
-
 }