X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.org;h=be7db9b352f3fbb27de2a93a50284d56c36ef2c9;hb=8248f5880cce5f072e572f9a4507bbc4d3a3b7a0;hp=eb25b72a1dbbe3a32f0fe186d9301370bca62361;hpb=b5ce3bd895a6e6c2253e070cfce197a244c78c4c;p=javainspect.git diff --git a/doc/index.org b/doc/index.org index eb25b72..be7db9b 100644 --- a/doc/index.org +++ b/doc/index.org @@ -32,8 +32,11 @@ Goal: simplify/speed up understanding the computer program code by automatically visualizing its structure. -JavaInspect is a Java library/commandline utility that primarily uses -Java reflection to discover and visualize any part of Java program. +[[http://www3.svjatoslav.eu/projects/sixth-3d/graphs/][See example produced graphs]] for [[http://www3.svjatoslav.eu/projects/sixth-3d/][Sixth 3D - 3D engine project]]. + +JavaInspect can be used as a [[id:acf1896a-74b4-4914-acf6-a77075e07f25][standalone commandline utility]] as well as +[[id:bbeeffc8-3767-440d-8d93-ec9124dd60ee][java library]]. JavaInspect uses primarily Java built-in reflection to +discover and visualize any part of Java program. JavaInspect currently has no GUI, configuration files, embedded scripting support, direct Maven or Ant integration. See [[id:2ad2889e-6c95-4662-b3f4-2c341fc74522][usage]] to learn @@ -48,7 +51,9 @@ By default on your Desktop directory when operated in library mode or current working directory when operated as standalone commandline application. -Note: GraphViz is developed and tested so far only on GNU/Linux. +Notes: ++ JavaInspect is developed and tested so far only on GNU/Linux. ++ See: [[https://github.com/pahen/madge][Madge - similar tool for JavaScript]] * Example graphs + A very simple example: @@ -59,7 +64,7 @@ Note: GraphViz is developed and tested so far only on GNU/Linux. file:legend.png -+ Example visualization of [[http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/][Sixth 3D]] project: [[http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/codeGraph/][architecture graphs]]. ++ [[http://www3.svjatoslav.eu/projects/sixth-3d/graphs/][See example produced graphs]] for [[http://www3.svjatoslav.eu/projects/sixth-3d/][Sixth 3D - 3D engine project]]. * Usage :PROPERTIES: