[infinispan-issues] [JBoss JIRA] Created: (ISPN-755) Provide API documentation for scala components within the distribution

Tue Nov 2 09:51:01 EDT 2010

Provide API documentation for scala components within the distribution
----------------------------------------------------------------------

                 Key: ISPN-755
                 URL: https://jira.jboss.org/browse/ISPN-755
             Project: Infinispan
          Issue Type: Feature Request
    Affects Versions: 4.1.0.Final
            Reporter: Richard Achmatowicz
            Assignee: Manik Surtani

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.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira