EngineHub / EngineHub/CommandHelper
Add a documentation class instead of a formatted string.
- Langage dominant
- Java
- Étoiles
- 128
- Forks
- 70
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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.
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- java
- Domaine
- tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 25/100