X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.html;h=0a0c3caf917ca5aeedf566e3dac9211aa8557332;hb=55f41b6dc0506aaa9b197ce6675d131379fed666;hp=9bbe3f6e8b594da19e195669f2b83a0ac7bb0a0d;hpb=8fca62d9f6b263ff2fc41d49155afdaafc113ae1;p=javainspect.git diff --git a/doc/index.html b/doc/index.html index 9bbe3f6..0a0c3ca 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@
After discovering application structure and optionally filtering out unimportant parts, JavaInspect produces GraphViz dot file that -describes data to be visualized. Then launches GraphViz to generate +describes data to be visualized. Then launches GraphViz to generate bitmap graph in PNG or SVG format.
--By default on your Desktop directory when operated in library mode or -current working directory when operated as standalone commandline -application. -
-Notes:
@@ -435,21 +429,14 @@ Control code in general does the following:-// Create graph -final ClassGraph graph = new ClassGraph(); +// Create graph +final ClassGraph graph = new ClassGraph(); -// Add some random object to the graph. GraphViz will detect Class from -// the object. +// Add some random object to the graph. GraphViz will detect Class from +// the object. graph.add(graph); -// Also add some random class to the graph. -graph.add(Utils.class); +// Also add some random class to the graph. +graph.add(Utils.class); -// Keep intermediary GraphViz DOT file for reference. -graph.setKeepDotFile(true); +// Keep intermediary GraphViz DOT file for reference. +graph.setKeepDotFile(true); -// Produce bitmap image titled "JavaInspect.png" to the user Desktop -// directory -graph.generateGraph("JavaInspect"); +// Produce bitmap image titled "JavaInspect.png" to the user Desktop +// directory +graph.generateGraph("JavaInspect");
new ClassGraph().add(randomObject, RandomClass.class) - .setKeepDotFile(true).generateGraph("JavaInspect"); +new ClassGraph().add(randomObject, RandomClass.class) + .setKeepDotFile(true).generateGraph("JavaInspect");
// Create graph -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.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: -
-Declare JavaInspect as dependency:
<dependencies> +<dependencies> ... - <dependency> - <groupId>eu.svjatoslav</groupId> - <artifactId>javainspect</artifactId> - <version>1.6</version> - </dependency> + <dependency> + <groupId>eu.svjatoslav</groupId> + <artifactId>javainspect</artifactId> + <version>1.7</version> + </dependency> ... -</dependencies> +</dependencies>
<repositories> +<repositories> ... - <repository> - <id>svjatoslav.eu</id> - <name>Svjatoslav repository</name> - <url>http://www2.svjatoslav.eu/maven/</url> - </repository> + <repository> + <id>svjatoslav.eu</id> + <name>Svjatoslav repository</name> + <url>http://www2.svjatoslav.eu/maven/</url> + </repository> ... -</repositories> +</repositories>
+Similar or alternative solutions: +
+ +