groovy

Node is missing documentation

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 1.8.6
  • Fix Version/s: 2.0.6, 2.1.0-beta-1, 1.8.9
  • Component/s: GroovyDoc
  • Labels:
    None
  • Number of attachments :
    0

Description

The Groovy class Node is missing a lot of documentation:

http://groovy.codehaus.org/api/groovy/util/Node.html

Take, for example, the parent() method. What does it return for the root Node? Is it null or this?

Activity

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

As is a bunch of other XML classes, such as GPathResult.

Show
Uri Moszkowicz added a comment - As is a bunch of other XML classes, such as GPathResult.
Hide
Permalink
Paul King added a comment -

Agreed. Obviously something that we should do. Contributions welcome of course!

Show
Paul King added a comment - Agreed. Obviously something that we should do. Contributions welcome of course!
Hide
Permalink
Uri Moszkowicz added a comment -

I guess I'm filing enough issues at this point to do so First step is still to open issues to identify work and for discussion.

Show
Uri Moszkowicz added a comment - I guess I'm filing enough issues at this point to do so First step is still to open issues to identify work and for discussion.
Hide
Permalink
Paul King added a comment -

So, I guess we never answered the original question. The parent() method returns null for the root node.

Show
Paul King added a comment - So, I guess we never answered the original question. The parent() method returns null for the root node.
Hide
Permalink
Pascal Schumacher added a comment -

Submitted pull request https://github.com/groovy/groovy-core/pull/71 with additional java doc for groovy.util.Node.

Show
Pascal Schumacher added a comment - Submitted pull request https://github.com/groovy/groovy-core/pull/71 with additional java doc for groovy.util.Node.
Hide
Permalink
Paul King added a comment -

pull request applied - thanks!

Show
Paul King added a comment - pull request applied - thanks!

People

  • Assignee:
    Paul King
    Reporter:
    Uri Moszkowicz
Vote (0)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: