Skip to content

Commit 2887582

Browse files
committed
chore: add documentation
1 parent 0a198e0 commit 2887582

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

web-bundle/src/main/java/com/graphhopper/util/DirectionFilterHelper.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,11 @@ public List<LineString> filterPathsByDirection(List<LineString> lineStrings, Boo
126126
}
127127

128128
/**
129+
* Retrieves the terminal point of a LineString based on the build direction.
129130
*
130-
* @param lineString
131-
* @param buildUpstream
132-
* @return
131+
* @param lineString the LineString to extract the terminal point from
132+
* @param buildUpstream if true, returns the start point; if false, returns the end point
133+
* @return the terminal Point of the LineString
133134
*/
134135
private Point getTerminalPoint(LineString lineString, boolean buildUpstream) {
135136
return buildUpstream ? lineString.getStartPoint() : lineString.getEndPoint();

0 commit comments

Comments
 (0)