gh-1612 - missing javadoc added

gchq · Jan 11, 2018 · 84a3de5 · 84a3de5
1 parent 73b045f
commit 84a3de5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/core/data/src/main/java/uk/gov/gchq/gaffer/data/graph/function/walk/ExtractWalkVertex.java b/core/data/src/main/java/uk/gov/gchq/gaffer/data/graph/function/walk/ExtractWalkVertex.java
@@ -20,6 +20,10 @@
 import uk.gov.gchq.gaffer.data.graph.Walk;
 import uk.gov.gchq.koryphe.function.KorypheFunction;
 
+/**
+ * An {@code ExtractWalkVertex} is a utility {@link KorypheFunction},
+ * for simplifying the extraction of the starting Vertex from a {@link Walk} object.
+ */
 public class ExtractWalkVertex extends KorypheFunction<Walk, Object> {
     @Override
     public Object apply(final Walk walk) {