documentation

src/thor/node.clj

@@ -7,18 +7,27 @@
 
 ; 
 (def INFINITY (Integer/MAX_VALUE))
-(defstruct pos :x :y )
-(defstruct mem :total :free)
-(defstruct data :size :content)
-
-(defn create-data [size content]
+(defstruct pos 
+           "Position variable contains {:x :y }"
+           :x :y )
+(defstruct mem 
+           "Memory definition {:total :free}"
+           :total :free)
+(defstruct data 
+           "Data type {:size :content}"
+           :size :content)
+
+(defn create-data 
+  "Create data of certain size and content"
+  [size content]
   (struct-map data :size size :content content))
 
 (defn create-memory [size] 
   (struct-map mem :total size :free size))
 
 
 (defrecord Node 
+  "Node data structure"
   [id
    name
    memory