X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Findex.org;h=e2a4f89a52c2a4c4f0c88f8c8791d89d8f819cd6;hb=b2f519fd934cd49afbb5cfc88b3d2be396af0afa;hp=be7db9b352f3fbb27de2a93a50284d56c36ef2c9;hpb=4b0c5e8b5b50bb1b168308ccb9b06119c2326c3a;p=javainspect.git
diff --git a/doc/index.org b/doc/index.org
index be7db9b..e2a4f89 100644
--- a/doc/index.org
+++ b/doc/index.org
@@ -1,38 +1,44 @@
#+TITLE: JavaInspect - Utility to visualize java software
------
-- [[http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]]
+* (document settings) :noexport:
+** use dark style for TWBS-HTML exporter
+#+HTML_HEAD:
+#+HTML_HEAD:
+#+HTML_HEAD:
+#+HTML_HEAD:
-- This program is free software; you can redistribute it and/or modify
- it under the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public
- License]] or later as published by the Free Software Foundation.
+* General
+- This program is free software: you can redistribute it and/or modify
+ it under the terms of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] as
+ published by the Free Software Foundation, either version 3 of the
+ License, or (at your option) any later version.
- Program authors:
- Svjatoslav Agejenko
- - Homepage: http://svjatoslav.eu
+ - Homepage: https://svjatoslav.eu
- Email: mailto://svjatoslav@svjatoslav.eu
+ - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
- Tony Bargnesi
- GitHub fork for the project:
https://github.com/abargnesi/javainspect
-- [[http://www.svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
+** Source code
+- [[https://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
-* (document settings) :noexport:
-** use dark style for TWBS-HTML exporter
-#+HTML_HEAD:
-#+HTML_HEAD:
-#+HTML_HEAD: "
-#+HTML_HEAD:
+- [[https://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=summary][Browse Git repository online]]
-* General
+- Clone Git repository using command:
+ : git clone https://www2.svjatoslav.eu/git/javainspect.git
+
+* Goal and operating principle
Goal: simplify/speed up understanding the computer program code by
automatically visualizing its structure.
-[[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]].
+[[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]].
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
@@ -58,13 +64,14 @@ Notes:
* Example graphs
+ A very simple example:
- [[file:example.png][file:example.resized.png]]
+ file:example.png
Graph legend:
file:legend.png
-+ [[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]].
+
++ [[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]].
* Usage
:PROPERTIES:
@@ -215,7 +222,7 @@ Result:
- Generated PNG image: [[file:JavaInspect%20full%20project.png][JavaInspect full project.png]]
*** example 3: GraphViz embedded in another project
-1. Download project Sixth [[http://www2.svjatoslav.eu/gitweb/?p=sixth.git;a=snapshot;h=HEAD;sf=tgz][code snapshot]].
+1. Download project Sixth [[https://www2.svjatoslav.eu/gitweb/?p=sixth.git;a=snapshot;h=HEAD;sf=tgz][code snapshot]].
2. Inspect and run *DataGraph.java*.
*** Embedding JavaInspect in your Maven project
@@ -312,7 +319,7 @@ LOT of cool ideas could be implemented. For intstance:
- FEATURE: Possibility to attach to JVM using JVM agent.
-- FEATURE: Possibility to inspect graphs in 3D using [[http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/index.html][Sixth 3D engine]].
+- FEATURE: Possibility to inspect graphs in 3D using [[https://www3.svjatoslav.eu/projects/sixth-3d/][Sixth 3D engine]].
- FEATURE: Possibility to select classes/fields/values to be
visualized in some graph query language. For greater flexibility in
@@ -326,3 +333,6 @@ 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
+Similar or alternative solutions:
++ http://www.class-visualizer.net/