Improved documentation on base graph class slots
authorGary King <gwking@metabang.com>
Sun, 12 Feb 2006 16:56:56 +0000 (11:56 -0500)
committerGary King <gwking@metabang.com>
Sun, 12 Feb 2006 16:56:56 +0000 (11:56 -0500)
darcs-hash:20060212165656-3cc5d-0c23a40b775957dfcaec07121bbc34e3b9ed33ec.gz

dev/graph.lisp

index 32a9bd6..8a17dc1 100644 (file)
@@ -161,11 +161,11 @@ something is putting something on the vertexes plist's
    (largest-vertex-id 0 r)
    (largest-edge-id 0 r)
    (vertex-class 'basic-vertex ir
-                 "The class of the vertexes in the graph.")
+                 "The class of the vertexes in the graph. This must extend the base-class for vertexes of the graph type. E.g., all vertexes of a graph-container must extend graph-container-vertex.")
    (directed-edge-class 'basic-directed-edge ir
-                        "The class used to create directed edges in the graph.")
+                        "The class used to create directed edges in the graph. This must extend the base-class for edges of the graph type and directed-edge-mixin. E.g., the directed-edge-class of a graph-container must extend graph-container-edge and directed-edge-mixin.")
    (undirected-edge-class 'basic-edge ir
-                          "The class used to create undirected edges in the graph.")
+                          "The class used to create undirected edges in the graph. This must extend the base-class for edges of the graph type. E.g., all edges of a graph-container must extend graph-container-edge")
    (contains-directed-edge-p nil ar 
                              "Returns true if graph contains at least one directed edge. [?? Not sure if this is really keep up-to-date.]")
    (contains-undirected-edge-p nil ar