From 55101f5821c01b7f8f355582782761f412f4fb7e Mon Sep 17 00:00:00 2001
From: Ankur Dave <ankurdave@gmail.com>
Date: Sat, 11 Jan 2014 12:35:41 -0800
Subject: [PATCH] One-line Scaladoc comments in Edge and EdgeDirection
---
.../scala/org/apache/spark/graphx/Edge.scala | 19 +++++++------------
.../apache/spark/graphx/EdgeDirection.scala | 13 +++----------
2 files changed, 10 insertions(+), 22 deletions(-)
diff --git a/graphx/src/main/scala/org/apache/spark/graphx/Edge.scala b/graphx/src/main/scala/org/apache/spark/graphx/Edge.scala
index b3a2a21862..85f27d2c8d 100644
--- a/graphx/src/main/scala/org/apache/spark/graphx/Edge.scala
+++ b/graphx/src/main/scala/org/apache/spark/graphx/Edge.scala
@@ -8,18 +8,13 @@ package org.apache.spark.graphx
* @tparam ED type of the edge attribute
*/
case class Edge[@specialized(Char, Int, Boolean, Byte, Long, Float, Double) ED] (
- /**
- * The vertex id of the source vertex
- */
- var srcId: VertexID = 0,
- /**
- * The vertex id of the target vertex.
- */
- var dstId: VertexID = 0,
- /**
- * The attribute associated with the edge.
- */
- var attr: ED = nullValue[ED]) extends Serializable {
+ /** The vertex id of the source vertex */
+ var srcId: VertexID = 0,
+ /** The vertex id of the target vertex. */
+ var dstId: VertexID = 0,
+ /** The attribute associated with the edge. */
+ var attr: ED = nullValue[ED])
+ extends Serializable {
/**
* Given one vertex in the edge return the other vertex.
diff --git a/graphx/src/main/scala/org/apache/spark/graphx/EdgeDirection.scala b/graphx/src/main/scala/org/apache/spark/graphx/EdgeDirection.scala
index 99910ab87b..05103f6883 100644
--- a/graphx/src/main/scala/org/apache/spark/graphx/EdgeDirection.scala
+++ b/graphx/src/main/scala/org/apache/spark/graphx/EdgeDirection.scala
@@ -1,6 +1,5 @@
package org.apache.spark.graphx
-
/**
* The direction of a directed edge relative to a vertex.
*/
@@ -18,18 +17,12 @@ sealed abstract class EdgeDirection {
object EdgeDirection {
- /**
- * Edges arriving at a vertex.
- */
+ /** Edges arriving at a vertex. */
case object In extends EdgeDirection
- /**
- * Edges originating from a vertex
- */
+ /** Edges originating from a vertex. */
case object Out extends EdgeDirection
- /**
- * All edges adjacent to a vertex
- */
+ /** All edges adjacent to a vertex. */
case object Both extends EdgeDirection
}
--
GitLab