improved project documentation

[javainspect.git] / src / main / java / eu / svjatoslav / inspector / java / structure / example / RenderJavaInspect.java

diff --git a/src/main/java/eu/svjatoslav/inspector/java/structure/example/RenderJavaInspect.java b/src/main/java/eu/svjatoslav/inspector/java/structure/example/RenderJavaInspect.java
index f993e22..560c172 100644 (file)
--- a/src/main/java/eu/svjatoslav/inspector/java/structure/example/RenderJavaInspect.java
+++ b/src/main/java/eu/svjatoslav/inspector/java/structure/example/RenderJavaInspect.java
@@ -18,9 +18,44 @@ public class RenderJavaInspect {
 
        public static void main(final String[] args) throws FileNotFoundException {
 
+               handpickClassesExample();
+
+               fullProjectExample();
+
+       }
+
+       private static void fullProjectExample() {
+               final ClassGraph graph = new ClassGraph();
+
+               // 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");
+       }
+
+       private static void handpickClassesExample() {
+               /*
+                * This example demonstrates generating of class graph from hand picked
+                * classes.
+                */
+
                // Create graph
                final ClassGraph graph = new ClassGraph();
 
+               // 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 object to the graph.
                graph.addObject(graph);
 
@@ -28,7 +63,7 @@ public class RenderJavaInspect {
                graph.addClass(Utils.class);
 
                // Produce bitmap image titled "JavaInspect.png" to the user Desktop
-               // directory.
+               // directory and keep intermediary GraphViz DOT file for reference.
                graph.generateGraph("JavaInspect", true);
        }
 }