Uploaded image for project: 'JBeret'
  1. JBeret
  2. JBERET-232

jberet-rest-api module should have both rest api docs and javadocs

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • 1.3.0.Beta2
    • 1.3.0.Beta1
    • docs
    • None

      We currently generate rest api docs for jberet-rest-api module and publish it at
      http://docs.jboss.org/jberet/latest/javadoc/jberet-rest-api/

      However, jberet-rest-api also contains classes that do not define any rest operations, and they should have javadocs. In addition, even for classes of rest operations, users may also want to view their javadocs.

      So we should keep rest api docs separate from javadocs:

      jberet-rest-api javadocs:
      http://docs.jboss.org/jberet/latest/javadoc/jberet-rest-api/

      jberet-rest-api rest docs (generated with Miredot):
      http://docs.jboss.org/jberet/latest/rest-doc

              cfang@redhat.com Cheng Fang
              cfang@redhat.com Cheng Fang
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: