[
https://issues.jboss.org/browse/FORGE-331?page=com.atlassian.jira.plugin....
]
George Gastaldi closed FORGE-331.
---------------------------------
Fix Version/s: (was: 2.x Future)
Resolution: Won't Fix
We already generate a "man" page for the commands dynamically, based on the
command parameters
Get online help from plugin's javadoc
-------------------------------------
Key: FORGE-331
URL:
https://issues.jboss.org/browse/FORGE-331
Project: Forge
Issue Type: Feature Request
Security Level: Public(Everyone can see)
Components: Plugin API
Reporter: Jonathan Fuerth
Priority: Minor
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 was sent by Atlassian JIRA
(v6.2.6#6264)