X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.html;h=b826e7ab64548dee0863791f357afd010ef6805a;hb=8285a2e198a01177b14e528f8e12de2f7d5273e9;hp=9028b5cd2dc82fe1692abd9b5d97769e1838c722;hpb=75e481b8054fb685f94eeb59e92c4fb50e6d4611;p=javainspect.git

diff --git a/doc/index.html b/doc/index.html
index 9028b5c..b826e7a 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -27,6 +27,10 @@ This software is distributed under <a
 
 	<h2>General</h2>
 
+	Goal: simplify/speed up understanding the computer program code by
+	automatically visualizing its structure.
+	  
+	<br/><br/>
 	JavaInspect is a Java library that you can embed into your Java project
 	with a few lines of Maven configuration and then visualize any part of
 	your Java program structure with few simple JavaInspect API calls at
@@ -66,24 +70,31 @@ This software is distributed under <a
 	<img src="legend.png" />
 
 
-	<h2>Usage example</h2>
+	<h2>Usage example 1</h2>
 
-	Following example produces graph for JavaInspect itself:
-
-	<pre>
+<pre>
 <code>
-// Create graph
-final Graph graph = new Graph();
+		/*
+		 * This example demonstrates generating of class graph from hand picked
+		 * classes.
+		 */
+
+		// Create graph
+		final ClassGraph graph = new ClassGraph();
 
-// Add some object to the graph.
-graph.addObject(graph);
+		// While classes and objects can be immediately passed to ClassGraph
+		// constructor as arguments, it is also possible to add then one by one
+		// as in the following example.
 
-// Add some class to the graph.
-graph.addClass(Utils.class);
+		// Add some object to the graph.
+		graph.addObject(graph);
 
-// Produce bitmap image titled "JavaInspect.png" to the user Desktop
-// directory.
-graph.generateGraph("JavaInspect", true);
+		// Add some class to the graph.
+		graph.addClass(Utils.class);
+
+		// Produce bitmap image titled "JavaInspect.png" to the user Desktop
+		// directory and keep intermediary GraphViz DOT file for reference.
+		graph.generateGraph("JavaInspect", true);
 </code>
 
 
@@ -94,6 +105,33 @@ Result:
 </pre>
 
 
+	<h2>Usage example 2</h2>
+
+<pre>
+<code>
+		// Recursively scan current directory for Java source code and attempt
+		// to detect class names from there to be added to the graph.
+		graph.addProject(".");
+
+		// Blacklist example classes from being shown on the graph
+		graph.getFilter().blacklistClassPattern(
+				"eu.svjatoslav.inspector.java.structure.example.*");
+
+		// do not show single classes with no relationships on the graph
+		graph.hideOrphanedClasses();
+
+		// Produce bitmap image titled "JavaInspect full project.png" to the
+		// user Desktop directory.
+		graph.generateGraph("JavaInspect full project");
+</code>
+
+
+Result:
+    Generated PNG image: <a href="JavaInspect full project.png">JavaInspect full project.png</a>
+
+</pre>
+
+
 
 	<h2>Embedding JavaInspect in your project</h2>
 	<pre>
@@ -107,7 +145,7 @@ Declare JavaInspect as dependency:
         &lt;dependency&gt;
             &lt;groupId&gt;eu.svjatoslav&lt;/groupId&gt;
             &lt;artifactId&gt;javainspect&lt;/artifactId&gt;
-            &lt;version&gt;1.0-SNAPSHOT&lt;/version&gt;
+            &lt;version&gt;1.2&lt;/version&gt;
         &lt;/dependency&gt;
  
     &lt;/dependencies&gt;