EngineHub / EngineHub/CommandHelper

Add a documentation class instead of a formatted string.

Open
#914 3 comments 0 reactions 0 assignees View on GitHub
documentation engineering
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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.