This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-graph.git
The following commit(s) were added to refs/heads/master by this push:
new 327b90a Javadoc
327b90a is described below
commit 327b90a2063d7386c2be9d8ff88c172ebdf558d6
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:43 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/graph/CommonsGraph.java | 10 +++++-----
.../org/apache/commons/graph/collections/FibonacciHeap.java | 2 +-
.../apache/commons/graph/shortestpath/PathSourceSelector.java | 2 +-
.../graph/shortestpath/ShortestPathAlgorithmSelector.java | 4 ++--
.../commons/graph/shortestpath/TargetSourceSelector.java | 2 +-
.../java/org/apache/commons/graph/spanning/ShortestEdges.java | 2 +-
6 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/commons/graph/CommonsGraph.java
b/src/main/java/org/apache/commons/graph/CommonsGraph.java
index 17ee17f..d47be86 100644
--- a/src/main/java/org/apache/commons/graph/CommonsGraph.java
+++ b/src/main/java/org/apache/commons/graph/CommonsGraph.java
@@ -59,7 +59,7 @@ public final class CommonsGraph
* @param <E> The Graph edges type
* @param <G> The Graph type
* @param graph the input graph
- * @return an instance of {@link ColorsBuilder}
+ * @return An instance of {@link ColorsBuilder}
*/
public static <V, E, G extends UndirectedGraph<V, E>> ColorsBuilder<V, E>
coloring( G graph )
{
@@ -89,7 +89,7 @@ public final class CommonsGraph
* @param <E> The Graph edges type
* @param <G> The Graph type
* @param graph the input graph
- * @return an instance of {@link NamedExportSelector}
+ * @return An instance of {@link NamedExportSelector}
*/
public static <V, E, G extends Graph<V, E>> NamedExportSelector<V, E>
export( G graph )
{
@@ -119,7 +119,7 @@ public final class CommonsGraph
* @param <WE> the Graph edges type
* @param <G> The Graph type
* @param graph the input edge-weighted graph
- * @return an instance of {@link FlowWeightedEdgesBuilder}
+ * @return An instance of {@link FlowWeightedEdgesBuilder}
*/
public static <V, WE, G extends DirectedGraph<V, WE>>
FlowWeightedEdgesBuilder<V, WE> findMaxFlow( G graph )
{
@@ -179,7 +179,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
* @param graphConnection the {@link GraphConnection} instance that
describes vertices
- * @return a new {@link DirectedMutableGraph} instance
+ * @return A new {@link DirectedMutableGraph} instance
*/
public static <V, E> DirectedMutableGraph<V, E> newDirectedMutableGraph(
GraphConnection<V, E> graphConnection )
{
@@ -193,7 +193,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
* @param graphConnection the {@link GraphConnection} instance that
describes vertices
- * @return a new {@link UndirectedMutableGraph} instance
+ * @return A new {@link UndirectedMutableGraph} instance
*/
public static <V, E> UndirectedMutableGraph<V, E>
newUndirectedMutableGraph( GraphConnection<V, E> graphConnection )
{
diff --git
a/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
b/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
index 1109e2f..4cb6f89 100644
--- a/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
+++ b/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
@@ -208,7 +208,7 @@ public final class FibonacciHeap<E>
*
* @param o1 the first {@link FibonacciHeap} node to be compared
* @param o2 the second {@link FibonacciHeap} node to be compared
- * @return a negative integer, zero, or a positive integer as the first
argument is
+ * @return A negative integer, zero, or a positive integer as the first
argument is
* less than, equal to, or greater than the second
*/
private int compare( FibonacciHeapNode<E> o1, FibonacciHeapNode<E> o2 )
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
b/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
index 69faa3d..50f986b 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
@@ -35,7 +35,7 @@ public interface PathSourceSelector<V, WE, W>
*
* @param <WO> the type of weight operations
* @param weightOperations the weight operations needed for the algorithm
- * @return a data structure which contains all vertex pairs shortest path.
+ * @return A data structure which contains all vertex pairs shortest path.
*/
<WO extends OrderedMonoid<W>> AllVertexPairsShortestPath<V, WE, W>
applyingFloydWarshall( WO weightOperations );
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
b/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
index 8007476..f25488b 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
@@ -46,7 +46,7 @@ public interface ShortestPathAlgorithmSelector<V, WE, W>
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
- * @return a path which describes the shortest path, if any, otherwise a
{@link PathNotFoundException} will be thrown
+ * @return A path which describes the shortest path, if any, otherwise a
{@link PathNotFoundException} will be thrown
*/
<WO extends OrderedMonoid<W>> WeightedPath<V, WE, W>
applyingBidirectionalDijkstra( WO weightOperations );
@@ -55,7 +55,7 @@ public interface ShortestPathAlgorithmSelector<V, WE, W>
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
- * @return a path which describes the shortest path, if any, otherwise a
{@link PathNotFoundException} will be thrown
+ * @return A path which describes the shortest path, if any, otherwise a
{@link PathNotFoundException} will be thrown
*/
<WO extends OrderedMonoid<W>> WeightedPath<V, WE, W> applyingDijkstra( WO
weightOperations );
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
b/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
index 52af58e..3aa9fde 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
@@ -36,7 +36,7 @@ public interface TargetSourceSelector<V, WE, W>
*
* @param <WO> the type of weight operations
* @param weightOperations the weight operations needed for the algorithm
- * @return a data structure which contains all vertex pairs shortest path.
+ * @return A data structure which contains all vertex pairs shortest path.
*/
<WO extends OrderedMonoid<W>> AllVertexPairsShortestPath<V, WE, W>
applyingBelmannFord( WO weightOperations );
diff --git a/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
b/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
index fff28be..5600fdf 100644
--- a/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
+++ b/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
@@ -107,7 +107,7 @@ final class ShortestEdges<V, WE, W>
/**
* Creates a spanning tree using the current data.
*
- * @return a spanning tree using current data
+ * @return A spanning tree using current data
*/
public SpanningTree<V, WE, W> createSpanningTree()
{
