Skip to content

Commit 0b87e9f

Browse files
committed
Update javadoc
1 parent abd5272 commit 0b87e9f

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

patternfx-core/src/main/java/com/techsenger/patternfx/core/ParentComponent.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,16 @@ public interface ParentComponent<T extends ParentView<?, ?>> extends Component<T
4747
SubtreeIterator<ParentComponent<?>> breadthFirstIterator();
4848

4949
/**
50-
* Returns a string representation of this component and all its descendants formatted as a tree.
50+
* Returns a string representation of this component and all its descendants as a sub-tree with this
51+
* component as root.
5152
*
5253
* @return a tree-formatted string representation of this component
5354
*/
5455
String toTreeString();
5556

5657
/**
57-
* Returns a string representation of this component and all its descendants formatted as a tree, allowing the
58-
* caller to append an additional note for each component.
58+
* Returns a string representation of this component and all its descendants as a sub-tree with this component
59+
* as root, allowing the caller to customize the string output for each component.
5960
*
6061
* The provided {@code componentAppender} is invoked for each component and is responsible for appending the
6162
* complete string representation of that component to the given {@link StringBuilder}. The tree structure and

patternfx-core/src/main/java/com/techsenger/patternfx/core/ParentMediator.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,16 @@ public interface ParentMediator extends ComponentMediator {
4747
SubtreeIterator<ParentViewModel<?>> breadthFirstIterator();
4848

4949
/**
50-
* Returns a string representation of this component and all its descendants formatted as a tree.
50+
* Returns a string representation of this component and all its descendants as a sub-tree with this
51+
* component as root.
5152
*
5253
* @return a tree-formatted string representation of this component
5354
*/
5455
String toTreeString();
5556

5657
/**
57-
* Returns a string representation of this component and all its descendants formatted as a tree, allowing the
58-
* caller to append an additional note for each component.
58+
* Returns a string representation of this component and all its descendants as a sub-tree with this component
59+
* as root, allowing the caller to customize the string output for each component.
5960
*
6061
* <p>The provided {@code componentAppender} is invoked for each component and is responsible for appending the
6162
* complete string representation of that component to the given {@link StringBuilder}. The tree structure and

0 commit comments

Comments
 (0)