[Docs] Extend Javadoc coverage (warnings ~890 → 100)#289
Merged
Conversation
- Add class Javadoc to WorldListener, EntityListener, ActionCaster, DashAttackAction, DashDirection, ConsumableActive, PassiveSkill - Fix @Return-Only Javadoc in Skill interface (add full sentences) - Fix AbilitySkill.abilityType() Javadoc (no main description warning) - Add @param tags for record components: SkillId, BezierShape, ConeShape, ArcShape, CameraPath - Fix InputAction.Builder empty /** */ comment - Add @return tags to ArcShape/ConeShape factory methods - Fix AnimationSlot.hasTag() missing @return - Fix DrawUtil.circle() missing main description (had ~-style params) - Fix constructor Javadoc in AbilityHistoryRepository, AbilityStateRepository, AspectRepository (no-main-desc warnings) - Fix ArmorType.id() missing @return - Add @param <T> to Config.ConfigEntry class-level Javadoc - Add State.name() full-sentence Javadoc - Add documented constructors to abstract/concrete classes that were using implicit default constructors: ActiveSkill, ActivatableAbility, ApproachState, AttackReadyState, AttackState, AttackingHeavyState, AttackingQuickState, AttackAction, ArenaManager - Add private BezierUtil() constructor (also fixes utility class check) - Add @param comboStep to AttackAction.basicAttack() - Fix ActionCaster.cast() missing Javadoc - Fix DashAttackAction class + method Javadoc
Mere-Solace
added
type: docs
Mere-Solace
force-pushed
the
chore/javadoc-coverage-2-pr
branch
from
0f80909 to
aa3d017
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@param/@return, empty comments, no-main-description, and undocumented default constructorsprivate BezierUtil()constructor (also suppressesFinalClassCheckstyle hint)Config/Prefab— out of scope)Test plan
./gradlew checkpasses./gradlew javadocshows no warnings outside "no comment" (undocumented fields)