X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.html;h=82116d1b48119ebe138d303969485b7aa71a35c6;hb=ea8fbce1f61f7abecf4331e597dd2272285beeca;hp=59f486327e453b0d20cc144747467e7ad2027931;hpb=13eb4378a21127f9ebfb226b7f883ec4ca538215;p=javainspect.git diff --git a/doc/index.html b/doc/index.html old mode 100644 new mode 100755 index 59f4863..82116d1 --- a/doc/index.html +++ b/doc/index.html @@ -20,13 +20,16 @@ Homepage: http://svjatoslav.eu Email: svjatoslav@svjatoslav.eu -This software is distributed under GNU GENERAL PUBLIC LICENSE Version 2. +This software is distributed under GNU LESSER GENERAL PUBLIC LICENSE version 3 or later.
++-// 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);
@@ -94,6 +104,33 @@ Result:Usage example 2
+ +++ ++ // 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"); +
+ + +Result: + Generated PNG image: JavaInspect full project.png + +Embedding JavaInspect in your project
@@ -107,7 +144,7 @@ Declare JavaInspect as dependency: <dependency> <groupId>eu.svjatoslav</groupId> <artifactId>javainspect</artifactId> - <version>1.0</version> + <version>1.3</version> </dependency> </dependencies>