Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,9 @@ tasks.register('mergedJavadoc', Javadoc) {
destinationDir = file("dist/javadoc")

options.encoding = 'UTF-8'
if (JavaVersion.current().isJava8Compatible()) {
options.addStringOption('Xdoclint:none', '-quiet')
}
options.addStringOption('-release', '8')
options.addBooleanOption('Werror', true)
options.addBooleanOption('Xdoclint:all,-missing', true)

options.overview = file("javadoc-overview.html")
source = mergedJavadocSubprojects.collect { project(it).sourceSets.main.allJava }
Expand Down
7 changes: 3 additions & 4 deletions common.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ jar {
}

javadoc {
failOnError = false
options.addStringOption('-release', '8')
options.addBooleanOption('Werror', true)
options.addBooleanOption('Xdoclint:all,-missing', true)
options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED
options.docTitle = "jMonkeyEngine ${jmeFullVersion} ${project.name} Javadoc"
options.windowTitle = "jMonkeyEngine ${jmeFullVersion} ${project.name} Javadoc"
Expand All @@ -79,9 +81,6 @@ javadoc {
options.use = "true"
options.charSet = "UTF-8"
options.encoding = "UTF-8"
if (JavaVersion.current().isJava8Compatible()) {
options.addStringOption('Xdoclint:none', '-quiet')
}
source = sourceSets.main.allJava // main only, exclude tests
}

Expand Down
3 changes: 1 addition & 2 deletions javadoc-overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
in Java aimed at wide accessibility and quick deployment to desktop,
web, and mobile platforms.

<h3>Key Features</h3>
<h1>Key Features</h1>
<ul>
<li>Free, open-source software (under the New BSD license) – Use our free engine for commercial, educational, or hobby game development</li>
<li>Minimal adaptations for cross-compatibility – Create games that run on any OpenGL 2 and 3-ready device with the Java Virtual Machine – web, desktop, or mobile.</li>
Expand All @@ -23,4 +23,3 @@ <h3>Key Features</h3>

</body>
</html>

18 changes: 9 additions & 9 deletions jme3-core/src/main/java/com/jme3/anim/tween/action/Action.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@
/**
* Wraps an array of Tween actions into an action object.
*
* <p>
* Notes :
* <p>Notes:</p>
* <ul>
* <li> The sequence of tweens is determined by {@link com.jme3.anim.tween.Tweens} utility class and the {@link BaseAction} interpolates that sequence. </li>
* <li> This implementation mimics the {@link com.jme3.anim.tween.AbstractTween}, but it delegates the interpolation method {@link Tween#interpolate(double)}
* to the {@link BlendableAction} class. </li>
* </p>
* </ul>
*
* Created by Nehon.
*
Expand All @@ -64,12 +64,12 @@ public abstract class Action implements JmeCloneable, Tween {

/**
* Instantiates an action object that wraps a tween actions array by extracting their actions to the collection {@link Action#actions}.
* <p>
* Notes :
* <p>Notes:</p>
* <ul>
* <li> If intentions are to wrap some tween actions, then subclasses have to call this constructor, examples : {@link BlendableAction} and {@link BlendAction}. </li>
* <li> If intentions are to make an implementation of {@link Action} that shouldn't wrap tweens of actions, then subclasses shouldn't call this
* constructor, examples : {@link ClipAction} and {@link BaseAction}. </li>
* </p>
* </ul>
*
* @param tweens the tween actions to be wrapped (not null).
*/
Expand Down Expand Up @@ -117,13 +117,13 @@ public double getSpeed() {

/**
* Alters the speedup factor applied by the layer running this action.
* <p>
* Notes:
* <p>Notes:</p>
* <ul>
* <li> This factor controls the animation direction, if the speed is a positive value then the animation will run forward and vice versa. </li>
* <li> The speed factor gets applied, inside the {@link com.jme3.anim.AnimLayer}, on each interpolation step by this formula : time += tpf * action.getSpeed() * composer.globalSpeed. </li>
* <li> Default speed is 1.0, it plays the animation clips at their normal speed. </li>
* <li> Setting the speed factor to Zero will stop the animation, while setting it to a negative number will play the animation in a backward fashion. </li>
* </p>
* </ul>
*
* @param speed the speed of frames.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@
* //run the action within this layer
* animComposer.setCurrentAction("basicAction", ActionState.class.getSimpleName());
* </pre>
* </p>
* Created by Nehon.
*/
public class BaseAction extends Action {
Expand Down
17 changes: 7 additions & 10 deletions jme3-core/src/main/java/com/jme3/anim/tween/action/BlendSpace.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,37 +31,34 @@
*/
package com.jme3.anim.tween.action;

import com.jme3.anim.util.HasLocalTransform;
import com.jme3.math.Transform;

/**
* A provider interface which provides a value {@link BlendSpace#getWeight()} to control the blending between 2 successive actions in a {@link BlendAction}.
* The blending weight is a read-only value, and it can be manipulated using the arbitrary value {@link BlendSpace#setValue(float)} during the application runtime.
*
* <p>
* Notes about the blending action and its relations with the blending weight:
* <p>Notes about the blending action and its relations with the blending weight:</p>
* <ul>
* <li> Blending is the action of mixing between 2 successive animation {@link BlendableAction}s by interpolating their transforms and
* then applying the result on the assigned {@link HasLocalTransform} object, the {@link BlendSpace} provides this blending action with a blend weight value. </li>
* <li> The blend weight is the value for the interpolation for the target transforms. </li>
* <li> The blend weight value must be in this interval [0, 1]. </li>
* </ul>
* </p>
*
* <p>
* Different blending weight case scenarios managed by {@link BlendAction} internally:
* <p>Different blending weight case scenarios managed by {@link BlendAction} internally:</p>
* <ul>
* <li> In case of (0 < Blending weight < 1), the blending is executed each update among 2 actions, the first action will use
* <li> In case of (0 &lt; Blending weight &lt; 1), the blending is executed each update among 2 actions, the first action will use
Comment thread
8Keep marked this conversation as resolved.
* a blend value of 1 and the second action will use the blend space weight as a value for the interpolation. </li>
* <li> In case of (Blending weight = 0), the blending hasn't started yet, only the first action will be interpolated at (weight = 1). </li>
* <li> In case of (Blending weight = 1), the blending is finished and only the second action will continue to run at (weight = 1). </li>
* </ul>
* </p>
*
* <p>
* Notes about the blending weight value:
* <p>Notes about the blending weight value:</p>
* <ul>
* <li> Negative values and values greater than 1 aren't allowed (i.e., extrapolations aren't allowed). </li>
* <li> For more details, see {@link BlendAction#doInterpolate(double)} and {@link BlendAction#collectTransform(HasLocalTransform, Transform, float, BlendableAction)}. </li>
* </ul>
* </p>
*
* Created by Nehon.
* @see LinearBlendSpace an example of blendspace implementation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class MouseAxisTrigger implements Trigger {

/**
* Create a new <code>MouseAxisTrigger</code>.
* <p>
*
* @param mouseAxis Mouse axis. See AXIS_*** constants in {@link MouseInput}
* @param negative True if listen to negative axis events, false if
* listen to positive axis events.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public Shader makeCurrent(AssetManager assetManager, RenderManager renderManager
* {@link #makeCurrent(com.jme3.asset.AssetManager, com.jme3.renderer.RenderManager, java.util.EnumSet, com.jme3.light.LightList, com.jme3.shader.DefineList)}.
* @param geometry The geometry to render
* @param lights Lights which influence the geometry.
* @param lastTexUnit the index of the most recently used texture unit
* @param lastBindUnits the most recently used bind units
*/
public void render(RenderManager renderManager, Shader shader, Geometry geometry, LightList lights, BindUnits lastBindUnits);
}
11 changes: 6 additions & 5 deletions jme3-core/src/main/java/com/jme3/scene/Node.java
Original file line number Diff line number Diff line change
Expand Up @@ -685,22 +685,23 @@ with BoundingSphere bounding volumes and collideWith(BoundingSphere). Doing
/**
* Returns flat list of Spatials implementing the specified class AND
* with name matching the specified pattern.
* <P>
*
* Note that we are <i>matching</i> the pattern, therefore the pattern
* must match the entire pattern (i.e. it behaves as if it is sandwiched
* between "^" and "$").
* You can set regex modes, like case insensitivity, by using the (?X)
* or (?X:Y) constructs.
* </P> <P>
* By design, it is always safe to code loops like:<PRE>
*
* <p>By design, it is always safe to code loops like:</p>
* <PRE>
* for (Spatial spatial : node.descendantMatches(AClass.class, "regex"))
* </PRE>
* <P>
*
* "Descendants" does not include self, per the definition of the word.
* To test for descendants AND self, you must do a
* <code>node.matches(aClass, aRegex)</code> +
* <code>node.descendantMatches(aClass, aRegex)</code>.
* <P>
*
*
* @param <T> the type of Spatial returned
* @param spatialSubclass Subclass which matching Spatials must implement.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ public AccessHint getAccessHint() {
/**
* Set AccessHint to hint the renderer on how to access this data.
*
* @param natureHint
* @param accessHint the access hint
*/
public void setAccessHint(AccessHint accessHint) {
this.accessHint = accessHint;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public interface ResourceLoader {
*
* @param path
* The resource name
* @return An enumeration of {@link java.net.URL <code>URL</code>} objects for
* @return An enumeration of {@link java.net.URL URL} objects for
* the resource. If no resources could be found, the enumeration
* will be empty.
*
Expand Down
2 changes: 1 addition & 1 deletion jme3-core/src/main/java/com/jme3/util/res/Resources.java
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ public static InputStream getResourceAsStream(String path, Class<?> parent) {
* The resource name
*
*
* @return An enumeration of {@link java.net.URL <code>URL</code>} objects for
* @return An enumeration of {@link java.net.URL URL} objects for
* the resource. If no resources could be found, the enumeration
* will be empty.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ public class StructStd140BufferObject extends BufferObject {
/**
* Create an empty Struct buffer
*
* @param str
*/
public StructStd140BufferObject() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
import java.util.logging.Logger;

/**
* @deprecated use {@link StbImageLoader} instead, which supports HDR images and more formats. This loader is
* @deprecated use {@code StbImageLoader} instead, which supports HDR images and more formats. This loader is
* kept for backward compatibility but may be removed in future versions.
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
* @author Joshua Slack - cleaned, commented, added ability to read 16bit true color and color-mapped TGAs.
* @author Kirill Vainer - ported to jME3
* @version $Id: TGALoader.java 4131 2009-03-19 20:15:28Z blaine.dev $
* @deprecated use {@link StbImageLoader} instead
* @deprecated use {@code StbImageLoader} instead
*/
@Deprecated
public final class TGALoader implements AssetLoader {
Expand Down
4 changes: 2 additions & 2 deletions jme3-core/src/tools/java/jme3tools/optimize/LodGenerator.java
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@
* LodGenerator lODGenerator = new LodGenerator(geometry);
* lODGenerator.bakeLods(reductionMethod,reductionValue);
* </pre> reductionMethod type is VertexReductionMethod described here
* {@link TriangleReductionMethod} reduction value depends on the
* reductionMethod<p>
* {@link TriangleReductionMethod} reduction value depends on the
* reductionMethod.
*
*
* @author Nehon
Expand Down
4 changes: 4 additions & 0 deletions jme3-ios-examples/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,10 @@ tasks.named('compileJava') {
options.release = 11
}

tasks.named('javadoc') {
exclude('org/ngengine/libjglios/generated/**')
}

tasks.named('processResources') {
dependsOn generateIosNativeImageMetadata, generateExamplesTestChooserClassList
}
Expand Down
7 changes: 0 additions & 7 deletions jme3-lwjgl3/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,3 @@ dependencies {
runtimeOnly(variantOf(libs.lwjgl3.sdl){ classifier('natives-macos-arm64') })

}

javadoc {
// Disable doclint for JDK8+.
if (JavaVersion.current().isJava8Compatible()){
options.addStringOption('Xdoclint:none', '-quiet')
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Import animations from an FBX asset.
*
* @deprecated FBX support is deprecated and will be removed in a future release.
* FBX support is deprecated and will be removed in a future release.
* Prefer glTF assets instead.
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Read and parse FBX files.
*
* @deprecated FBX support is deprecated and will be removed in a future release.
* FBX support is deprecated and will be removed in a future release.
* Prefer glTF assets instead.
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Import materials from an FBX asset.
*
* @deprecated FBX support is deprecated and will be removed in a future release.
* FBX support is deprecated and will be removed in a future release.
* Prefer glTF assets instead.
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Import meshes from an FBX asset.
*
* @deprecated FBX support is deprecated and will be removed in a future release.
* FBX support is deprecated and will be removed in a future release.
* Prefer glTF assets instead.
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Import nodes from an FBX asset.
*
* @deprecated FBX support is deprecated and will be removed in a future release.
* FBX support is deprecated and will be removed in a future release.
* Prefer glTF assets instead.
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Import models in the FBX file format.
*
* @deprecated FBX support is deprecated and will be removed in a future release.
* FBX support is deprecated and will be removed in a future release.
* Prefer glTF assets instead.
*/
@Deprecated
Expand Down
7 changes: 0 additions & 7 deletions jme3-saferallocator/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,3 @@ dependencies {

implementation libs.bundles.saferalloc
}

javadoc {
// Disable doclint for JDK8+.
if (JavaVersion.current().isJava8Compatible()){
options.addStringOption('Xdoclint:none', '-quiet')
}
}
7 changes: 0 additions & 7 deletions jme3-terrain/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,3 @@ dependencies {
testRuntimeOnly project(':jme3-desktop')
testRuntimeOnly project(':jme3-testdata')
}

javadoc {
// Disable doclint for JDK8+.
if (JavaVersion.current().isJava8Compatible()){
options.addStringOption('Xdoclint:none', '-quiet')
}
}