lib/graphviz/xml.rb in ruby-graphviz-0.9.3 vs lib/graphviz/xml.rb in ruby-graphviz-0.9.4

@@ -28,14 +28,22 @@
     
     # 
     # Generate the graph
     # 
     # Options :
-    #   :output : Output format (Constants::FORMATS)
-    #   :file : Output file name
-    #   :use : Program to use (Constants::PROGRAMS)
-    #   :path : Program PATH
+    # * :output : Output format (Constants::FORMATS)
+    # * :file : Output file name
+    # * :use : Program to use (Constants::PROGRAMS)
+    # * :path : Program PATH
+    # * :<format> => <file> : <file> can be
+    #   * a file name
+    #   * nil, then the output will be printed to STDOUT
+    #   * String, then the output will be returned as a String
+    # * :errors : DOT error level (default 1)
+    #   * 0 = Error + Warning
+    #   * 1 = Error
+    #   * 2 = none
     # 
     def output( *hOpt )
       @oGraph.output( *hOpt )
     end
     
@@ -43,11 +51,11 @@
     
     # 
     # Create a graph from a XML file
     # 
     # In:
-    #   xFile : XML File
-    #   *hOpt : Graph options
+    # * xFile : XML File
+    # * *hOpt : Graph options
     # 
     def initialize( xFile, *hOpt )
       @xNodeName = "00000"
 	    @bShowText = true
 	    @bShowAttrs = true