EngineHub / EngineHub/CommandHelper
Add a documentation class instead of a formatted string.
- Dominant language
- Java
- Stars
- 128
- Forks
- 70
- PR merge metrics
- No merged PRs in 30d
Description
CMDHELPER-2915 - Reported by ACzChef
Right now functions have to pass in a string for their docs, that then later gets parsed into usable data.
My suggestion is to have a documentation class where you just define all the fields such as description, return type, arguments, name, etc. and use that instead. It would be cleaner, and less error prone.
Contributor guide
Research direction
No files or tests are named. Start by tracing where function documentation strings are defined, parsed, and consumed; identify the fields currently encoded in the format. Done means documentation is represented by a class with fields such as description, return type, arguments, and name, with all existing consumers updated and covered by the project's relevant tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100