groovy

Name of NodeChildren class incorrect in JavaDoc (NoChildren)

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Trivial Trivial
  • Resolution: Not A Bug
  • Affects Version/s: 1.7.1
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None
  • Environment:
    All
  • Number of attachments :
    0

Description

The javadoc for NodeChildren should be at http://groovy.codehaus.org/api/groovy/util/slurpersupport/NodeChildren.html
There is no NodeChildren doc - you have to go to http://groovy.codehaus.org/api/groovy/util/slurpersupport/NoChildren.html and the class is referred to as NoChildren instead of NodeChildren throught, both in the doc for the class itself and the package index

Issue Links

is related to

Improvement - An improvement or enhancement to an existing feature or task. GROOVY-4136 gapi document generation ignores access modifiers set on groovydoc

  • Trivial - Cosmetic problem like misspelt words or misaligned text.
  • Open - The issue is open and ready for the assignee to start work on it.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
blackdrag blackdrag added a comment -

NoChildren and NodeChildren are different... but were is NodeChildren referenced from?

Show
blackdrag blackdrag added a comment - NoChildren and NodeChildren are different... but were is NodeChildren referenced from?
Hide
Permalink
Roshan Dawrani added a comment -

gapi documentation has it. See http://groovy.codehaus.org/gapi/groovy/util/slurpersupport/package-summary.html, which has some doc for extra classes like Attributes, NodeChildren, etc.

I am again trying to remember what is the difference between api / gapi doc. (both NoChildren and NodeChildren are java classes)

Show
Roshan Dawrani added a comment - gapi documentation has it. See http://groovy.codehaus.org/gapi/groovy/util/slurpersupport/package-summary.html , which has some doc for extra classes like Attributes, NodeChildren, etc. I am again trying to remember what is the difference between api / gapi doc. (both NoChildren and NodeChildren are java classes)
Hide
Permalink
Mike Hayes added a comment -

OK. This looks like it's down to my own confusion. To be fair, it's not at all obvious!

Show
Mike Hayes added a comment - OK. This looks like it's down to my own confusion. To be fair, it's not at all obvious!
Hide
Permalink
Roshan Dawrani added a comment -

Mike, I looked a bit more into it. The documentation for NodeChildren/Attributes classes in this package is not generated because these classes are package-private and the documentation for private/package-private members is not generated by groovy.

Can you please tell how you arrived at this link? Was another part of documentation linking to this URL, or you manually came up with the URL as you expected it there?

Show
Roshan Dawrani added a comment - Mike, I looked a bit more into it. The documentation for NodeChildren/Attributes classes in this package is not generated because these classes are package-private and the documentation for private/package-private members is not generated by groovy. Can you please tell how you arrived at this link? Was another part of documentation linking to this URL, or you manually came up with the URL as you expected it there?
Hide
Permalink
Mike Hayes added a comment -

I was trying to learn about XmlSlurper and how it was used. I wanted to see what the difference was between NodeChild and NodeChildren.
I googled NodeChild first which landed me at the 'api' docs. I tried to find NodeChildren from the same place but could only find NoChild and wrongly assumed that it was a mistake.
Thanks for the explanation - though I'm a bit confused about the difference between gapi and api still. I'll figure it out eventually.
Thanks for getting back to me - do I need to do something to close this bug or is that something you do?

Show
Mike Hayes added a comment - I was trying to learn about XmlSlurper and how it was used. I wanted to see what the difference was between NodeChild and NodeChildren. I googled NodeChild first which landed me at the 'api' docs. I tried to find NodeChildren from the same place but could only find NoChild and wrongly assumed that it was a mistake. Thanks for the explanation - though I'm a bit confused about the difference between gapi and api still. I'll figure it out eventually. Thanks for getting back to me - do I need to do something to close this bug or is that something you do?
Hide
Permalink
Roshan Dawrani added a comment -

There is one little thing to fix that has come out of this - that 'gapi' doc is including package-private stuff as well, which it shouldn't.

Let the issue be open till that is fixed. Thanks.

Show
Roshan Dawrani added a comment - There is one little thing to fix that has come out of this - that 'gapi' doc is including package-private stuff as well, which it shouldn't. Let the issue be open till that is fixed. Thanks.
Hide
Permalink
Roshan Dawrani added a comment -

Missing 'api' javadoc was for package-private stuff, as explained earlier.

Regarding gapi not excluding private/package-private members, I looked into it a bit and groovydoc tool doesn't seem to be dealing correctly with the modifiers at all when it creates the AST for the sources. So, I will open a separate improvement issue.

Show
Roshan Dawrani added a comment - Missing 'api' javadoc was for package-private stuff, as explained earlier. Regarding gapi not excluding private/package-private members, I looked into it a bit and groovydoc tool doesn't seem to be dealing correctly with the modifiers at all when it creates the AST for the sources. So, I will open a separate improvement issue.

People

  • Assignee:
    Roshan Dawrani
    Reporter:
    Mike Hayes
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: