#64 fix javadoc issues

mgsx-dev · Jul 25, 2022 · 838674e · 838674e
1 parent 2df995c
commit 838674e
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 11 deletions.
diff --git a/gltf/src/net/mgsx/gltf/data/extensions/KHRLightsPunctual.java b/gltf/src/net/mgsx/gltf/data/extensions/KHRLightsPunctual.java
@@ -13,8 +13,8 @@
 import net.mgsx.gltf.scene3d.lights.SpotLightEx;
 
 /**
- * {@link net.mgsx.gltf.data.scene.GLTFNode} and {@link net.mgsx.gltf.data.GLTF} (root) extension
- * @see https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_lights_punctual
+ * {@link net.mgsx.gltf.data.scene.GLTFNode} and {@link net.mgsx.gltf.data.GLTF} (root) extension.
+ * See https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_lights_punctual
  */
 abstract public class KHRLightsPunctual {
 

diff --git a/gltf/src/net/mgsx/gltf/data/extensions/KHRMaterialsPBRSpecularGlossiness.java b/gltf/src/net/mgsx/gltf/data/extensions/KHRMaterialsPBRSpecularGlossiness.java
@@ -3,8 +3,8 @@
 import net.mgsx.gltf.data.texture.GLTFTextureInfo;
 
 /**
- * {@link net.mgsx.gltf.model.material.GLTFMaterial} extension (deprecated now)
- * @see https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Archived/KHR_materials_pbrSpecularGlossiness/README.md
+ * {@link net.mgsx.gltf.data.material.GLTFMaterial} extension (deprecated now).
+ * See https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Archived/KHR_materials_pbrSpecularGlossiness/README.md
  */
 public class KHRMaterialsPBRSpecularGlossiness 
 {

diff --git a/gltf/src/net/mgsx/gltf/data/extensions/KHRMaterialsUnlit.java b/gltf/src/net/mgsx/gltf/data/extensions/KHRMaterialsUnlit.java
@@ -1,8 +1,8 @@
 package net.mgsx.gltf.data.extensions;
 
 /**
- * {@link net.mgsx.gltf.data.material.GLTFMaterial} extension
- * @see https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_materials_unlit
+ * {@link net.mgsx.gltf.data.material.GLTFMaterial} extension.
+ * See https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_materials_unlit
  */
 public class KHRMaterialsUnlit {
 	public static final String EXT = "KHR_materials_unlit";

diff --git a/gltf/src/net/mgsx/gltf/data/extensions/KHRTextureTransform.java b/gltf/src/net/mgsx/gltf/data/extensions/KHRTextureTransform.java
@@ -1,8 +1,8 @@
 package net.mgsx.gltf.data.extensions;
 
 /**
- * {@link net.mgsx.gltf.model.texture.GLTFTextureInfo} extension
- * @see https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_transform/README.md
+ * {@link net.mgsx.gltf.data.texture.GLTFTextureInfo} extension.
+ * See https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_transform/README.md
  */
 public class KHRTextureTransform {
 	public static final String EXT = "KHR_texture_transform";

diff --git a/gltf/src/net/mgsx/gltf/scene3d/shaders/PBRShaderProvider.java b/gltf/src/net/mgsx/gltf/scene3d/shaders/PBRShaderProvider.java
@@ -122,7 +122,6 @@ protected boolean isGL3(){
 	 * override this method in order to add your own prefix.
 	 * @param renderable
 	 * @param config
-	 * @return
 	 */
 	public String createPrefixBase(Renderable renderable, PBRShaderConfig config) {
 
@@ -370,7 +369,6 @@ protected Shader createShader(Renderable renderable) {
 	 * @param renderable
 	 * @param config
 	 * @param prefix
-	 * @return
 	 */
 	protected PBRShader createShader(Renderable renderable, PBRShaderConfig config, String prefix){
 		return new PBRShader(renderable, config, prefix);

diff --git a/gltf/src/net/mgsx/gltf/scene3d/utils/IBLBuilder.java b/gltf/src/net/mgsx/gltf/scene3d/utils/IBLBuilder.java
@@ -174,7 +174,7 @@ protected void disposeColorTexture(Cubemap colorTexture) {
 	/**
 	 * Creates an radiance map, to be used with {@link net.mgsx.gltf.scene3d.attributes.PBRCubemapAttribute#SpecularEnv}
 	 * generated cubemap contains mipmaps in order to perform roughness in PBR shading
-	 * @param levels mipMapLevels how many mipmaps level, eg. 10 levels produce a 1024x1024 cubemap with mipmaps.
+	 * @param mipMapLevels how many mipmaps level, eg. 10 levels produce a 1024x1024 cubemap with mipmaps.
 	 * @return generated cubemap, caller is responsible to dispose it when no longer used.
 	 */
 	public Cubemap buildRadianceMap(final int mipMapLevels){