[
https://issues.apache.org/jira/browse/GROOVY-7525?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Paul King updated GROOVY-7525:
------------------------------
Description:
A few packages have a {{package.html}}. We should add additional
{{package.html}} files for packages that are not currently described. At the
moment, this would include
* groovy.beans
* groovy.grape
* groovy.transform
* groovy.transform.builder
* groovy.transform.stc
* groovy.ui
* groovy.util.logging
* groovy.xml
For internal classes, we would add for
* org.codehaus.groovy.antlr.java
* org.codehaus.groovy.ast.builder
* org.codehaus.groovy.ast.decompiled
* org.codehaus.groovy.ast.tools
* org.codehaus.groovy.asm.indy
* org.codehaus.groovy.asm.indy.sc
* org.codehaus.groovy.asm.sc
* org.codehaus.groovy.cli
* org.codehaus.groovy.control.customizers
* org.codehaus.groovy.control.customizers.builder
* org.codehaus.groovy.plugin
* org.codehaus.groovy.reflection.android
* org.codehaus.groovy.reflection.stdclasses
* org.codehaus.groovy.reflection.v7
* org.codehaus.groovy.runtime.callsite
* org.codehaus.groovy.runtime.dgmimpl
* org.codehaus.groovy.runtime.dgmimpl.arrays
* org.codehaus.groovy.runtime.m12n
* org.codehaus.groovy.runtime.memoize
* org.codehaus.groovy.runtime.powerassert
* org.codehaus.groovy.tools.ast
* org.codehaus.groovy.tools.gse
* org.codehaus.groovy.tools.shell
* org.codehaus.groovy.tools.shell.util
* org.codehaus.groovy.transform
* org.codehaus.groovy.transform.sc
* org.codehaus.groovy.transform.sc.transformers
* org.codehaus.groovy.transform.stc
* org.codehaus.groovy.transform.tailrec
* org.codehaus.groovy.transform.trait
* org.codehaus.groovy.vmplugin
* org.codehaus.groovy.vmplugin.v6
* org.codehaus.groovy.vmplugin.v7
And for the modules:
*groovy-ant*
* groovy.util
*groovy-console*
* groovy.inspect
* groovy.ui.view
*groovy-docgenerator*
* org.codehaus.groovy.tools
*groovy-groovydoc*
* org.codehaus.groovy.tools.groovydoc
* org.codehaus.groovy.tools.groovydoc.gstringTemplates
*groovy-groovysh*
* org.codehaus.groovy.tools.shell.commands
* org.codehaus.groovy.tools.shell.completion
*groovy-jmx*
* groovy.jmx.builder
* groovy.util
*groovy-json*
* groovy.json
* groovy.json.internal
*groovy-jsr223*
* org.codehaus.groovy.jsr223
*groovy-nio*
org.codehaus.groovy.runtime
*groovy-sql*
* org.codehaus.groovy.runtime
*groovy-swing*
* groovy.inspect.swingui
* org.codehaus.groovy.runtime
*groovy-test*
* groovy.lang
* groovy.mock.interceptor
* groovy.test
* groovy.transform
* groovy.util
* org.codehaus.groovy.runtime
* org.codehaus.groovy.transform
*groovy-testng*
* org.codehaus.groovy.testng
*groovy-xml*
* groovy.util
* groovy.xml
* groovy.xml.streamingmarkupsupport
* org.codehaus.groovy.runtime
* org.codehaus.groovy.tools.xml
Some of these packages are small (sometimes only 1 class) or common packages
duplicated between modules which may not really need documentation. I listed
them here for completeness.
was:
A few packages have a {{package.html}}. We should add additional
{{package.html}} files for packages that are not currently described. At the
moment, this would include
* groovy.beans
* groovy.grape
* groovy.transform
* groovy.transform.builder
* groovy.transform.stc
* groovy.ui
* groovy.util.logging
* groovy.xml
For internal classes, we would add for
* org.codehaus.groovy.antlr.java
* org.codehaus.groovy.ast.builder
* org.codehaus.groovy.ast.decompiled
* org.codehaus.groovy.ast.tools
* org.codehaus.groovy.asm.indy
* org.codehaus.groovy.asm.indy.sc
* org.codehaus.groovy.asm.sc
* org.codehaus.groovy.cli
* org.codehaus.groovy.control.customizers
* org.codehaus.groovy.control.customizers.builder
* org.codehaus.groovy.plugin
* org.codehaus.groovy.reflection.android
* org.codehaus.groovy.reflection.stdclasses
* org.codehaus.groovy.reflection.v7
* org.codehaus.groovy.runtime.callsite
* org.codehaus.groovy.runtime.dgmimpl
* org.codehaus.groovy.runtime.dgmimpl.arrays
* org.codehaus.groovy.runtime.m12n
* org.codehaus.groovy.runtime.memoize
* org.codehaus.groovy.runtime.powerassert
* org.codehaus.groovy.tools.ast
* org.codehaus.groovy.tools.gse
* org.codehaus.groovy.tools.shell
* org.codehaus.groovy.tools.shell.util
* org.codehaus.groovy.transform
* org.codehaus.groovy.transform.sc
* org.codehaus.groovy.transform.sc.transformers
* org.codehaus.groovy.transform.stc
* org.codehaus.groovy.transform.tailrec
* org.codehaus.groovy.transform.trait
* org.codehaus.groovy.vmplugin
* org.codehaus.groovy.vmplugin.v6
* org.codehaus.groovy.vmplugin.v7
And for the modules:
*groovy-ant*
* groovy.util
* groovy-console*
* groovy.inspect
* groovy.ui.view
*groovy-docgenerator*
* org.codehaus.groovy.tools
*groovy-groovydoc*
* org.codehaus.groovy.tools.groovydoc
* org.codehaus.groovy.tools.groovydoc.gstringTemplates
*groovy-groovysh*
* org.codehaus.groovy.tools.shell.commands
* org.codehaus.groovy.tools.shell.completion
*groovy-jmx*
* groovy.jmx.builder
* groovy.util
*groovy-json*
* groovy.json
* groovy.json.internal
*groovy-jsr223*
* org.codehaus.groovy.jsr223
*groovy-nio*
org.codehaus.groovy.runtime
*groovy-sql*
* org.codehaus.groovy.runtime
*groovy-swing*
* groovy.inspect.swingui
* org.codehaus.groovy.runtime
*groovy-test*
* groovy.lang
* groovy.mock.interceptor
* groovy.test
* groovy.transform
* groovy.util
* org.codehaus.groovy.runtime
* org.codehaus.groovy.transform
*groovy-testng*
* org.codehaus.groovy.testng
*groovy-xml*
* groovy.util
* groovy.xml
* groovy.xml.streamingmarkupsupport
* org.codehaus.groovy.runtime
* org.codehaus.groovy.tools.xml
Some of these packages are small (sometimes only 1 class) or common packages
duplicated between modules which may not really need documentation. I listed
them here for completeness.
> package.html not present for all packages
> -----------------------------------------
>
> Key: GROOVY-7525
> URL: https://issues.apache.org/jira/browse/GROOVY-7525
> Project: Groovy
> Issue Type: Documentation
> Reporter: Keegan Witt
>
> A few packages have a {{package.html}}. We should add additional
> {{package.html}} files for packages that are not currently described. At the
> moment, this would include
> * groovy.beans
> * groovy.grape
> * groovy.transform
> * groovy.transform.builder
> * groovy.transform.stc
> * groovy.ui
> * groovy.util.logging
> * groovy.xml
> For internal classes, we would add for
> * org.codehaus.groovy.antlr.java
> * org.codehaus.groovy.ast.builder
> * org.codehaus.groovy.ast.decompiled
> * org.codehaus.groovy.ast.tools
> * org.codehaus.groovy.asm.indy
> * org.codehaus.groovy.asm.indy.sc
> * org.codehaus.groovy.asm.sc
> * org.codehaus.groovy.cli
> * org.codehaus.groovy.control.customizers
> * org.codehaus.groovy.control.customizers.builder
> * org.codehaus.groovy.plugin
> * org.codehaus.groovy.reflection.android
> * org.codehaus.groovy.reflection.stdclasses
> * org.codehaus.groovy.reflection.v7
> * org.codehaus.groovy.runtime.callsite
> * org.codehaus.groovy.runtime.dgmimpl
> * org.codehaus.groovy.runtime.dgmimpl.arrays
> * org.codehaus.groovy.runtime.m12n
> * org.codehaus.groovy.runtime.memoize
> * org.codehaus.groovy.runtime.powerassert
> * org.codehaus.groovy.tools.ast
> * org.codehaus.groovy.tools.gse
> * org.codehaus.groovy.tools.shell
> * org.codehaus.groovy.tools.shell.util
> * org.codehaus.groovy.transform
> * org.codehaus.groovy.transform.sc
> * org.codehaus.groovy.transform.sc.transformers
> * org.codehaus.groovy.transform.stc
> * org.codehaus.groovy.transform.tailrec
> * org.codehaus.groovy.transform.trait
> * org.codehaus.groovy.vmplugin
> * org.codehaus.groovy.vmplugin.v6
> * org.codehaus.groovy.vmplugin.v7
> And for the modules:
> *groovy-ant*
> * groovy.util
> *groovy-console*
> * groovy.inspect
> * groovy.ui.view
> *groovy-docgenerator*
> * org.codehaus.groovy.tools
> *groovy-groovydoc*
> * org.codehaus.groovy.tools.groovydoc
> * org.codehaus.groovy.tools.groovydoc.gstringTemplates
> *groovy-groovysh*
> * org.codehaus.groovy.tools.shell.commands
> * org.codehaus.groovy.tools.shell.completion
> *groovy-jmx*
> * groovy.jmx.builder
> * groovy.util
> *groovy-json*
> * groovy.json
> * groovy.json.internal
> *groovy-jsr223*
> * org.codehaus.groovy.jsr223
> *groovy-nio*
> org.codehaus.groovy.runtime
> *groovy-sql*
> * org.codehaus.groovy.runtime
> *groovy-swing*
> * groovy.inspect.swingui
> * org.codehaus.groovy.runtime
> *groovy-test*
> * groovy.lang
> * groovy.mock.interceptor
> * groovy.test
> * groovy.transform
> * groovy.util
> * org.codehaus.groovy.runtime
> * org.codehaus.groovy.transform
> *groovy-testng*
> * org.codehaus.groovy.testng
> *groovy-xml*
> * groovy.util
> * groovy.xml
> * groovy.xml.streamingmarkupsupport
> * org.codehaus.groovy.runtime
> * org.codehaus.groovy.tools.xml
> Some of these packages are small (sometimes only 1 class) or common packages
> duplicated between modules which may not really need documentation. I listed
> them here for completeness.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
