Uploaded image for project: 'Forge'
  1. Forge
  2. FORGE-331

Get online help from plugin's javadoc

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Won't Do
    • Icon: Minor Minor
    • None
    • None
    • Plugin API
    • None

      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.

            Unassigned Unassigned
            jfuerth_jira Jonathan Fuerth (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: