Skip to content

Commit

Permalink
Improve Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Eddykasp committed Nov 6, 2023
1 parent 8b02497 commit d4dc7de
Showing 1 changed file with 15 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,16 @@ private double outlineDistance(final OutlineNode outline1, final OutlineNode out

/**
* This is the recursive function that calculates the layout for one node and it's children.
* @param graph
* Children are placed such that straight edges can later be drawn from their parent to each of them.
*
* If ConsiderModelOrder is set to false, all children are arranged in a semi-circle with the parent
* initially positioned above the lowest child and then shifted toward the center of the children as
* far as possible.
*
* If ConsiderModelOrder is set to true, groups of children are arranged such that they maintain their
* inherent model order. Furthermore, the reading direction is oriented left to right and top to bottom
* as far as possible without violating the vertical position constraints and the straight edge routing
* requirement.
*/
private void recursiveStraightlinePlacement(final ElkNode graph) {

Expand Down Expand Up @@ -273,7 +282,11 @@ private void recursiveStraightlinePlacement(final ElkNode graph) {
}
}

/** Place nodes while maintaining model order and computing bendpoints for the later edges. */
/**
* Place nodes while maintaining model order and computing bendpoints for the later edges.
* The model order is fully kept intact and bendpoints for the edges are computed so that
* overlap free edge routing is still possible.
*/
private void recursiveBentlinePlacement(final ElkNode graph) {

// set up initial outlines for all nodes
Expand Down

0 comments on commit d4dc7de

Please sign in to comment.