From 18154d6a35b1ddbaec5d7b9d14d04aaa172010c3 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Thu, 4 Jan 2018 00:25:57 +0200 Subject: [PATCH] Updated documentation. --- doc/index.html | 15 ++++++++++----- doc/index.org | 9 ++++++--- javainspect.iml | 12 ++++++------ 3 files changed, 22 insertions(+), 14 deletions(-) diff --git a/doc/index.html b/doc/index.html index a9ae900..710488f 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ JavaInspect - Utility to visualize java software - + @@ -240,8 +240,13 @@ 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. +See example produced graphs for Sixth 3D - 3D engine project. +

+ +

+JavaInspect can be used as a standalone commandline utility as well as +java library. JavaInspect uses primarily Java built-in reflection to +discover and visualize any part of Java program.

@@ -292,7 +297,7 @@ Graph legend: -

  • Example visualization of Sixth 3D project: architecture graphs. +
  • See example produced graphs for Sixth 3D - 3D engine project.
    • @@ -726,7 +731,7 @@ project build/release process. diff --git a/doc/index.org b/doc/index.org index eb25b72..e0fb65c 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 @@ -59,7 +62,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: diff --git a/javainspect.iml b/javainspect.iml index 4edf0f0..a802616 100644 --- a/javainspect.iml +++ b/javainspect.iml @@ -1,12 +1,12 @@ - - - - - - + + + + + + -- 2.20.1