[jira] [Commented] (DAFFODIL-2902) Javadoc for runtime1 API Infoset and Metadata classes/traits

["Mike Beckerle (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/DAFFODIL-2902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17847041#comment-17847041 ] 

Mike Beckerle commented on DAFFODIL-2902:
-----------------------------------------

Note that these are not included for either scaladoc nor javadoc. 

> Javadoc for runtime1 API Infoset and Metadata classes/traits
> ------------------------------------------------------------
>
>                 Key: DAFFODIL-2902
>                 URL: https://issues.apache.org/jira/browse/DAFFODIL-2902
>             Project: Daffodil
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 3.7.0
>            Reporter: Mike Beckerle
>            Priority: Major
>
>  
> runtime1.api.Metadata.scala
> runtime1.api.Infoset.scala
>  
> These define API to be callable from Java. They work fine from java, but the
> genjavadoc SBT plugin we use, which is supposed to create javadoc from scala code, 
> does not handle that there are many top level traits in these files. It does not generate
> javadoc for those at all. 
>  
> It may be easier to just convert Metadata.scala and Infoset.scala into java code.
> Note that each will become a bunch of files, one per public interface or class. 



--
This message was sent by Atlassian Jira
(v8.20.10#820010)