#+OPTIONS: author:nil
* Overview
+:PROPERTIES:
+:CUSTOM_ID: overview
+:END:
*JavaInspect* utility simplifies understanding the computer program
code by automatically visualizing its structure.
+ [[https://www3.svjatoslav.eu/projects/sixth-3d/graphs/][See example produced graphs]] for [[https://www3.svjatoslav.eu/projects/sixth-3d/][Sixth 3D - 3D engine project]].
* Installation
+:PROPERTIES:
+:CUSTOM_ID: installation
+:END:
[[http://www.graphviz.org/][GraphViz]] - shall be installed on the computer.
On Ubuntu/Debian GraphViz can be installed using:
#+END_SRC
* TO DO
+:PROPERTIES:
+:CUSTOM_ID: todo
+:END:
Note: Because this is side project (and I have many of them) I can
only contribute few hours per year at average. Any help is welcome. A
LOT of cool ideas could be implemented. For intstance:
- FEATURE: Configurable maven plugin to generate graphs as part of the
project build/release process.
* See also
+:PROPERTIES:
+:CUSTOM_ID: see-also
+:END:
Similar or alternative solutions:
+ http://www.class-visualizer.net/
+ [[https://github.com/pahen/madge][Madge - similar tool for JavaScript]]
* Available commandline arguments
+:PROPERTIES:
+:CUSTOM_ID: available-commandline-arguments
+:END:
- -j (existing files)... :: JAR file(s) to render.
- -t (options: png, svg) :: Target image type. Default is: svg.
* Specifying classes to render
+:PROPERTIES:
+:CUSTOM_ID: specifying-classes-to-render
+:END:
Normal Java application has immense complexity. In addition to code
that was directly written by particular project developers, lots of
those also to the graph.
* Examples
+:PROPERTIES:
+:CUSTOM_ID: examples
+:END:
Visualize java Jar file. All classes. Hide orphaned classes: