Forge
  1. Forge
  2. FORGE-583

Include Forge JavaDoc in Distribution download.

    Details

    • Similar Issues:
      Show 10 results 

      Description

      The Forge API JavaDocs should be included in the Forge Distribution.

        Gliffy Diagrams

          Issue Links

            Activity

            Hide
            Rajmahendra Hegde added a comment -

            We can also add PDF of wiki as well. something like JBoss-Forge-UserGuide-<version>.pdf or something similar. User can read and learn from the UserGuide. Make sure this must be updated and added in each release.

            Show
            Rajmahendra Hegde added a comment - We can also add PDF of wiki as well. something like JBoss-Forge-UserGuide-<version>.pdf or something similar. User can read and learn from the UserGuide. Make sure this must be updated and added in each release.
            Hide
            Lincoln Baxter III added a comment -

            We've thought about the idea of a PDF user-guide, but we have opted for a centralized online documentation that is kept up to date via source control. See https://github.com/forge/website - currently hosted at forge.github.com, but we are still working on it.

            Show
            Lincoln Baxter III added a comment - We've thought about the idea of a PDF user-guide, but we have opted for a centralized online documentation that is kept up to date via source control. See https://github.com/forge/website - currently hosted at forge.github.com, but we are still working on it.
            Hide
            George Gastaldi added a comment -

            We should generate another distribution (make another assembly execution) with the sources + javadocs only, so the forge-distribution-bin.zip doesn't increase in size.

            Show
            George Gastaldi added a comment - We should generate another distribution (make another assembly execution) with the sources + javadocs only, so the forge-distribution-bin.zip doesn't increase in size.
            Hide
            Rajmahendra Hegde added a comment -

            If it increases the size we need to give a separate zip file for javadoc. src+jdoc is also a good option.

            Show
            Rajmahendra Hegde added a comment - If it increases the size we need to give a separate zip file for javadoc. src+jdoc is also a good option.
            Hide
            George Gastaldi added a comment - - edited

            I think the following modules should be present on the javadoc. The other ones are purely implementation specific and their Javadoc is not useful for new plugin developers

            • forge-dev-plugins
            • forge-event-bus-api
            • forge-git-tools
            • forge-javaee-api
            • forge-maven-api
            • forge-parser-java-api
            • forge-parser-xml
            • forge-scaffold-api
            • forge-shell-api
            Show
            George Gastaldi added a comment - - edited I think the following modules should be present on the javadoc. The other ones are purely implementation specific and their Javadoc is not useful for new plugin developers forge-dev-plugins forge-event-bus-api forge-git-tools forge-javaee-api forge-maven-api forge-parser-java-api forge-parser-xml forge-scaffold-api forge-shell-api
            Hide
            George Gastaldi added a comment -

            Merged. Forge-javadoc.jar now contains the complete javadoc. We should publish to our website (or docs.jboss.org) soon.

            Show
            George Gastaldi added a comment - Merged. Forge-javadoc.jar now contains the complete javadoc. We should publish to our website (or docs.jboss.org) soon.

              People

              • Assignee:
                Ivan St. Ivanov
                Reporter:
                Lincoln Baxter III
              • Votes:
                1 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Development