Add comments

astares · Oct 14, 2019 · 3b845cf · 3b845cf
1 parent cebea56
commit 3b845cf
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git a/src/Moose-Algos-Graph/MalGraphEdge.class.st b/src/Moose-Algos-Graph/MalGraphEdge.class.st
@@ -1,3 +1,16 @@
+"
+I represent an edge in a graph.  I'm part of the edges of a MalGraphAlgorithm and I link two MalNode together.
+
+Public API and Key Messages
+- from
+- to 
+- model 
+ 
+Instance Variables
+	from: <MalNode>
+	to: <MalNode>
+	model: <Object>
+"
 Class {
 	#name : #MalGraphEdge,
 	#superclass : #Object,

diff --git a/src/Moose-Algos-Graph/MalGraphReducer.class.st b/src/Moose-Algos-Graph/MalGraphReducer.class.st
@@ -1,7 +1,7 @@
 "
 The reduced graph of G is the graph G where each strongly connected components was merged into one vertice / node.
 
-circuitsNodes instance variabel will collect all nodes created by merging nodes in a circuit.
+circuitsNodes instance variable will collect all nodes created by merging nodes in a circuit.
 "
 Class {
 	#name : #MalGraphReducer,
@@ -102,7 +102,7 @@ MalGraphReducer >> removeReferencesToMergedNodes [
 MalGraphReducer >> run [
 	self findCircuits.
 	self mergeNodesInCircuits.
-	^ nodes
+	^ self nodes
 ]
 
 { #category : #updating }

diff --git a/src/Moose-Algos-Graph/MalWeightedEdge.class.st b/src/Moose-Algos-Graph/MalWeightedEdge.class.st
@@ -1,3 +1,12 @@
+"
+I represent a weighted edge in a graph. 
+
+Public API and Key Messages
+- weight
+ 
+Instance Variables
+	weight: <Number>
+"
 Class {
 	#name : #MalWeightedEdge,
 	#superclass : #MalGraphEdge,