Uploaded image for project: 'Infinispan'
  1. Infinispan
  2. ISPN-755

Provide API documentation for scala components within the distribution

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Done
    • Major
    • 6.0.0.Alpha4, 6.0.0.CR1
    • 4.1.0.Final
    • None
    • None

    Description

      Infinispan makes use of the Scala language to implement server modules for client-server communication. At present, these modules do not have any API documentation, which means that application developers must browse through the source code in order to find out which classes are available and what their interfaces are.

      Scala has the ability to produce scaladoc documentation, but this is not compatible with javadoc. It appears that there is no method at present to incorporate scala API information into existing javadoc documentation.

      The task of this issue is to investigate and implement a viable way to incorporate API information for the scala classes into the Infinispan distribution.

      Attachments

        Issue Links

          Activity

            People

              ttarrant@redhat.com Tristan Tarrant
              rachmato@redhat.com Richard Achmatowicz
              Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: