]
George Gastaldi updated FORGE-331:
----------------------------------
Fix Version/s: 2.0.0.Alpha1
Get online help from plugin's javadoc
-------------------------------------
Key: FORGE-331
URL:
https://issues.jboss.org/browse/FORGE-331
Project: Forge
Issue Type: Feature Request
Components: Plugin API
Reporter: Jonathan Fuerth
Priority: Minor
Fix For: 2.0.0.Alpha1
IDEs already have lots of great tooling to help write good javadoc and keep it neatly
formatted and up to date. It would be excellent if forge's source of help text for
plugins came straight from the javadoc. This could be done either via a doclet that
operates on the Java source code, or by scraping the output of the default doclet (like
Eclipse will do if you attach generated JavaDoc rather than library source code).
Lowering the barrier to providing high-quality documentation should help encourage plugin
authors to provide good help, and in turn that should help everyone pick up and learn
Forge faster.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: