Changes between Version 27 and Version 28 of ErlangShellInterface

Timestamp:

Apr 13, 2013, 7:29:10 PM (12 years ago)

Author:

manualwiki

Comment:

Added tutorial for generating smart graph.

ErlangShellInterface

@@ -254 +254 @@
 {{{#!erlang
 ri:print_dep/1
+}}}
+{{{#!comment
+3. For drawing smart graph:
+{{{#!erlang
+ri:generate_smart_graph/1
+}}}
 }}}
 
@@ -274 +280 @@
  * {{{dot}}}
     The file path of the generated {{{.dot}}} graph description. Unless it is a non-existing absolute path, the graph will be placed into the {{{./dep_files}}} directory. This option is only available when using {{{draw_dep}}}.
+{{{#!comment
+ * {{{output_path | string() }}}
+    This parameter is only for drawing smart graphs, and is optional. Smart graphs are stored in {{{.html}}} files. If this parameter is not set, the output will be a randomly generated {{{.html}}} file in your {{{tool/data}}} directory.
+}}}
 
 You can specify entities either with graph nodes (such as {{{{'$gn', func, 123}}}}) or with their identifier. Modules can be specified with their names as atoms (e.g. 'mnesia'), while functions are specified by their MFA descriptor as a string (e.g. "io:format/2")
@@ -326 +336 @@
 {{{#!erlang
 ri:print_dep([{level, func}, {gnode, ["cycle4:f5/1"]}]).
+}}}
+
+{{{#!comment
+* Drawing a smart graph by giving the output path.
+{{{#!erlang
+ri:generate_smart_graph([{dependency_options, [{type, all}]}, {dependency_level, func}, {output_path, "/tmp/alma.html"}]).
+}}}
+{{{#!erlang
+"Open a browser and go to file:///tmp/alma.html to see the result."
+}}}
+
+* Drawing a smart graph without the output path parameter.
+{{{#!erlang
+ri:generate_smart_graph([{dependency_options, [{type, all}]}, {dependency_level, mod}]).
+}}}
+{{{#!erlang
+"Open a browser and go to file:///home/aszabo/Dokumentumok/refactorerl/trunk/tool/data/sq_g3IAA2QAFXJlZmFjdG9yZXJsQGxvY2FsaG9zdAMAABJVAAAAAAAAAAA.html to see the result."
+}}}
 }}}