[ https://issues.apache.org/jira/browse/GROOVY-7577?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14731552#comment-14731552 ]
Paul King commented on GROOVY-7577: ----------------------------------- You can see more info about api vs gapi here: https://issues.apache.org/jira/browse/GROOVY-4045 (basically JavaDoc vs GroovyDoc). > Groovy class docs all have ASF license as their explanation > ----------------------------------------------------------- > > Key: GROOVY-7577 > URL: https://issues.apache.org/jira/browse/GROOVY-7577 > Project: Groovy > Issue Type: Documentation > Affects Versions: 2.4.4 > Reporter: Aseem Bansal > Priority: Critical > > I opened one of groovy's API docs and noticed a weird thing. The only > explanation that the class had is ASF license. > e.g. > http://docs.groovy-lang.org/2.4.4/html/gapi/index.html?groovy/lang/GroovyObjectSupport.html > I checked the source at > https://github.com/apache/incubator-groovy/blob/master/src/main/groovy/lang/GroovyObjectSupport.java > and found that there is some actual explanation but that is not present in > the API docs. > So basically somehow the complete groovy API docs are missing a lot of > information. > I opened > http://docs.groovy-lang.org/2.4.4/html/gapi/groovy/lang/package-summary.html > and saw that the description column contains the ASF license. Certainly > nobody would expect that in an API documentation. > Now I am sure that this is not required by Apache software Foundation as I > cross-checked in other Apache projects and they had some actual explanation. > It would be great if this is taken care of because in my opinion this just > makes the API docs very bad. -- This message was sent by Atlassian JIRA (v6.3.4#6332)