Browse Source

convert comments to javadoc in 8 source files

Stephen Gold 4 years ago
parent
commit
49383a5c0c

+ 2 - 2
jme3-core/src/main/java/com/jme3/audio/openal/AL.java

@@ -86,7 +86,7 @@ public interface AL {
      */
      */
     public static final int AL_GAIN = 0x100A;
     public static final int AL_GAIN = 0x100A;
 
 
-    /*
+    /**
      * Indicate minimum source attenuation
      * Indicate minimum source attenuation
      * Type: ALfloat
      * Type: ALfloat
      * Range:  [0.0 - 1.0]
      * Range:  [0.0 - 1.0]
@@ -131,7 +131,7 @@ public interface AL {
     public static final int AL_SAMPLE_OFFSET = 0x1025;
     public static final int AL_SAMPLE_OFFSET = 0x1025;
     public static final int AL_BYTE_OFFSET = 0x1026;
     public static final int AL_BYTE_OFFSET = 0x1026;
 
 
-    /*
+    /**
      * Source type (Static, Streaming or undetermined)
      * Source type (Static, Streaming or undetermined)
      * Source is Static if a Buffer has been attached using AL_BUFFER
      * Source is Static if a Buffer has been attached using AL_BUFFER
      * Source is Streaming if one or more Buffers have been attached using alSourceQueueBuffers
      * Source is Streaming if one or more Buffers have been attached using alSourceQueueBuffers

+ 1 - 1
jme3-core/src/main/java/com/jme3/shadow/PssmShadowRenderer.java

@@ -606,7 +606,7 @@ public class PssmShadowRenderer implements SceneProcessor {
         return lambda;
         return lambda;
     }
     }
 
 
-    /*
+    /**
      * Adjust the repartition of the different shadow maps in the shadow extend
      * Adjust the repartition of the different shadow maps in the shadow extend
      * usually goes from 0.0 to 1.0
      * usually goes from 0.0 to 1.0
      * a low value give a more linear repartition resulting in a constant quality in the shadow over the extends, but near shadows could look very jagged
      * a low value give a more linear repartition resulting in a constant quality in the shadow over the extends, but near shadows could look very jagged

+ 2 - 2
jme3-core/src/main/java/com/jme3/ui/Picture.java

@@ -1,5 +1,5 @@
 /*
 /*
- * Copyright (c) 2009-2019 jMonkeyEngine
+ * Copyright (c) 2009-2020 jMonkeyEngine
  * All rights reserved.
  * All rights reserved.
  *
  *
  * Redistribution and use in source and binary forms, with or without
  * Redistribution and use in source and binary forms, with or without
@@ -80,7 +80,7 @@ public class Picture extends Geometry {
         this(name, false);
         this(name, false);
     }
     }
 
 
-    /*
+    /**
      * Serialization only. Do not use.
      * Serialization only. Do not use.
      */
      */
     protected Picture(){
     protected Picture(){

+ 1 - 1
jme3-core/src/main/java/com/jme3/util/ListSort.java

@@ -993,7 +993,7 @@ public class ListSort<T> {
         return length;
         return length;
     }
     }
     
     
-    /*
+    /**
      * test case
      * test case
      */
      */
     @SuppressWarnings("unchecked")
     @SuppressWarnings("unchecked")

+ 1 - 1
jme3-terrain/src/main/java/com/jme3/terrain/geomipmap/TerrainQuad.java

@@ -1065,7 +1065,7 @@ public class TerrainQuad extends Node implements Terrain {
         return height;
         return height;
     }
     }
 
 
-    /*
+    /**
      * gets an interpolated value at the specified point
      * gets an interpolated value at the specified point
      */
      */
     protected float getHeight(int x, int z, float xm, float zm) {
     protected float getHeight(int x, int z, float xm, float zm) {

+ 1 - 1
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/FluidSimHeightMap.java

@@ -134,7 +134,7 @@ public class FluidSimHeightMap extends AbstractHeightMap {
     }
     }
 
 
 
 
-    /*
+    /**
      * Generates a heightmap using fluid simulation and the attributes set by
      * Generates a heightmap using fluid simulation and the attributes set by
      * the constructor or the setters.
      * the constructor or the setters.
      */
      */

+ 1 - 1
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/HillHeightMap.java

@@ -111,7 +111,7 @@ public class HillHeightMap extends AbstractHeightMap {
         this(size, iterations, minRadius, maxRadius, new Random().nextLong());
         this(size, iterations, minRadius, maxRadius, new Random().nextLong());
     }
     }
 
 
-    /*
+    /**
      * Generates a heightmap using the Hill Algorithm and the attributes set by
      * Generates a heightmap using the Hill Algorithm and the attributes set by
      * the constructor or the setters.
      * the constructor or the setters.
      */
      */

+ 1 - 1
jme3-vr/src/main/java/com/jme3/app/VRApplication.java

@@ -393,7 +393,7 @@ public abstract class VRApplication implements Application, SystemListener {
     }
     }
 
 
     
     
-    /*
+    /**
         we do NOT want to get & modify the distortion scene camera, so
         we do NOT want to get & modify the distortion scene camera, so
         return the left viewport camera instead if we are in VR mode
         return the left viewport camera instead if we are in VR mode
     */
     */