jMonkeyEngine / jMonkeyEngine/jmonkeyengine
source files that lack javadoc
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 4.3k
- Forks
- 1.2k
- Avg merge
- 4d 7h
- Merged PRs (30d)
- 14
Description
More than 4 years after the new animation system was added to our Engine codebase, many files under "jme3-core/source/main/java/com/jme3/anim" still contain little or no useful javadoc. In particular:
- "AnimInterpolator.java"
- "AnimInterpoators.java"
- "FrameInterpolator.java"
- "ContainsTween.java"
- "Action.java"
- "BaseAction.java"
- "BlendAction.java"
- "BlendSpace.java"
- "BlendableAction.java"
- "ClipAction.java"
- "LinearBlendSpace.java"
- "AnimMigrationUtils.java"
- "HasLocalTransform.java"
- "Weighted.java"
"Documenting files that still lack java docs" was mentioned at the Forum/Hub as an important feature for JME 3.5.
Pull requests #1618 and #1626 address(ed) portions of this issue.
This issue is distinct from #1402, which is more of a Wiki issue.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Java files under jme3-core/source/main/java/com/jme3/anim listed in the issue, then check pull requests #1618 and #1626 to identify which portions remain. Done means the remaining animation-system source files have useful Javadoc, without expanding into the Wiki work tracked by #1402.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100