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

Provide API documentation for scala components within the distribution

This issue belongs to an archived project. You can view it, but you can't modify it. Learn more

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Done
    • Icon: Major Major
    • 6.0.0.Final
    • 4.1.0.Final
    • None
    • None

      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.

            [ISPN-755] Provide API documentation for scala components within the distribution

            Mircea Markus (Inactive) added a comment -

            rogaallAny update on this Filip?

            Mircea Markus (Inactive) added a comment - rogaall Any update on this Filip?

            Galder Zamarreño added a comment -

            Filip, is the maven plugin finished? Have you tried to generate documentation for Infinispan's scala classes?

            Galder Zamarreño added a comment - Filip, is the maven plugin finished? Have you tried to generate documentation for Infinispan's scala classes?

            Filip Rogaczewski (Inactive) added a comment -

            Project link: https://github.com/frogaczewski/Scajadoc

            Filip Rogaczewski (Inactive) added a comment - Project link: https://github.com/frogaczewski/Scajadoc

              ttarrant@redhat.com Tristan Tarrant
              rachmato@redhat.com Richard Achmatowicz
              Archiver:
              rhn-support-adongare Amol Dongare

                Created:
                Updated:
                Resolved:
                Archived: