antoaravinth
2015-02-27 13:14:20 UTC
I’m trying to solve the bug that is mentioned over here:
https://jira.codehaus.org/browse/GROOVY-7257?jql=project%20%3D%20GROOVY%20AND%20resolution%20%3D%20Unresolved%20AND%20priority%20%3D%20Trivial%20ORDER%20BY%20key%20DESC
Looks like if he runs the groovy doc tool with public argument and he
@PackageScope in a variable/method, it also comes in the documentation.
Something like this:
groovydoc -public -d ./doc/ GROOVY-7257.groovy
generates documentation for all the fields, regardless of @PackageScope
definition.
I tried to walkthrough the code base and found the issue is the code-base
isn’t checking the arguments at all (or I might be wrong here). The class
SimpleGroovyClassDocAssembler does the job of visiting and setting the
properties of the source file passed. In the methods like visitVariableDef,
visitMethodCall it doesn’t check the properties (instance variable which has
the arguments passed while groovydoc command is called , passed down from
org.codehays.groovy.tools.groovydoc.Main class).
Looks like we need to add checks over there in the methods, according to the
groovydoc specification.
Can I write them and give a PR. Or I’m missing some information here :)
--
View this message in context: http://groovy.329449.n5.nabble.com/Help-In-Solving-The-bug-GROOVY-7257-tp5722872.html
Sent from the groovy - dev mailing list archive at Nabble.com.
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email
https://jira.codehaus.org/browse/GROOVY-7257?jql=project%20%3D%20GROOVY%20AND%20resolution%20%3D%20Unresolved%20AND%20priority%20%3D%20Trivial%20ORDER%20BY%20key%20DESC
Looks like if he runs the groovy doc tool with public argument and he
@PackageScope in a variable/method, it also comes in the documentation.
Something like this:
groovydoc -public -d ./doc/ GROOVY-7257.groovy
generates documentation for all the fields, regardless of @PackageScope
definition.
I tried to walkthrough the code base and found the issue is the code-base
isn’t checking the arguments at all (or I might be wrong here). The class
SimpleGroovyClassDocAssembler does the job of visiting and setting the
properties of the source file passed. In the methods like visitVariableDef,
visitMethodCall it doesn’t check the properties (instance variable which has
the arguments passed while groovydoc command is called , passed down from
org.codehays.groovy.tools.groovydoc.Main class).
Looks like we need to add checks over there in the methods, according to the
groovydoc specification.
Can I write them and give a PR. Or I’m missing some information here :)
--
View this message in context: http://groovy.329449.n5.nabble.com/Help-In-Solving-The-bug-GROOVY-7257-tp5722872.html
Sent from the groovy - dev mailing list archive at Nabble.com.
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email