search

piccolo2d / piccolo2d.java

Structured 2D Graphics Framework
http://piccolo2d.org
Other
51 stars 14 forks source link

Bad javadoc for PNode.moveToFront(), PNode.moveToBack(), PNode.moveInFrontOf(PNode) and PNode.moveInBackOf(PNode) #165

Closed mro closed 9 years ago

mro commented 9 years ago

Originally reported on Google Code with ID 165

The javadoc descriptions for PNode.moveToFront(), PNode.moveToBack(),
PNode.moveInFrontOf(PNode) and PNode.moveInBackOf(PNode) are misleading or
wrong.

They should read

Change the order of this node in its parent's children list so that it will
draw behind the specified sibling node.

void moveInBackOf(PNode sibling)

Change the order of this node in its parent's children list so that it will
draw in front of the specified sibling node.

void moveInFrontOf(PNode sibling)

Change the order of this node in its parent's children list so that it will
draw behind all of its other sibling nodes.

void moveToBack()

Change the order of this node in its parent's children list so that it will
draw in front of all of its other sibling nodes.

void moveToFront()

Reported by heuermh on 2010-02-26 17:46:28

mro commented 9 years ago

Reported by heuermh on 2010-02-26 21:53:51

mro commented 9 years ago 
Oops, trying out the new svn commit message to issue tracker integration feature and
put the wrong issue number in the commit message, should have been issue 165.

$ svn commit -m "Issue 166 ; improved javadoc comments for moveToFront and related.

Fixes issue 166." .
Sending        core/src/main/java/edu/umd/cs/piccolo/PNode.java
Transmitting file data .
Committed revision 974.

Reported by heuermh on 2010-02-26 22:00:59

mro commented 9 years ago

Reported by heuermh on 2010-03-03 03:12:05