One-line Scaladoc comments in Edge and EdgeDirection

This commit is contained in:
Ankur Dave 2014-01-11 12:35:41 -08:00
parent 64f73f73a0
commit 55101f5821
2 changed files with 10 additions and 22 deletions

View file

@ -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.

View file

@ -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
}