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

[Tristan Tarrant (JIRA)]

     [ https://issues.jboss.org/browse/ISPN-755?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tristan Tarrant updated ISPN-755:
---------------------------------

              Status: Pull Request Sent  (was: Coding In Progress)
    Git Pull Request: https://github.com/infinispan/infinispan/pull/2033

    
> Provide API documentation for scala components within the distribution
> ----------------------------------------------------------------------
>
>                 Key: ISPN-755
>                 URL: https://issues.jboss.org/browse/ISPN-755
>             Project: Infinispan
>          Issue Type: Feature Request
>    Affects Versions: 4.1.0.Final
>            Reporter: Richard Achmatowicz
>            Assignee: Tristan Tarrant
>             Fix For: 6.0.0.Final
>
>
> 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, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira