X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.org;h=4293347a099d84abaf18d7c0e26eec9137b11265;hb=e063acd00b41c61a5881af71156c5b24b6a44f77;hp=728fff77d95382367b56ad9a67496c94b592df78;hpb=dda66ce5668b5e27e696759ef5c895d044a572bc;p=javainspect.git
diff --git a/doc/index.org b/doc/index.org
index 728fff7..4293347 100644
--- a/doc/index.org
+++ b/doc/index.org
@@ -12,7 +12,17 @@
- Homepage: http://svjatoslav.eu
- Email: mailto://svjatoslav@svjatoslav.eu
-- [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
+- [[http://www.svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
+
+* (document settings) :noexport:
+** use dark style for TWBS-HTML exporter
+#+HTML_HEAD:
+#+HTML_HEAD:
+#+HTML_HEAD: "
+#+HTML_HEAD:
* General
Goal: simplify/speed up understanding the computer program code by
@@ -41,7 +51,7 @@ unimportant parts, JavaInspect produces GraphViz dot file that
describes data to be visualized. Then launches GraphViz to generate
bitmap graph in PNG format. By default on your Desktop directory.
-Note: GraphViz is developed and tested so far only on GNU Linux.
+Note: GraphViz is developed and tested so far only on GNU/Linux.
* Example graphs
+ A very simple example:
@@ -52,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/doc/][Sixth]] project: [[http://www2.svjatoslav.eu/projects/sixth/codegraphs/][architecture graphs]].
++ 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]].
* Usage
Currently the only way to control JavaInspect is by using Java
@@ -141,33 +151,37 @@ graph.generateGraph("JavaInspect full project");
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]].
+2. Inspect and run *DataGraph.java*.
+
* Embedding JavaInspect in your Maven project
Declare JavaInspect as dependency:
#+BEGIN_SRC xml
-
- ...
-
- eu.svjatoslav
- javainspect
- 1.5-SNAPSHOT
-
- ...
-
+
+ ...
+
+ eu.svjatoslav
+ javainspect
+ 1.6
+
+ ...
+
#+END_SRC
Add Maven repository to retrieve artifact from:
#+BEGIN_SRC xml
-
- ...
-
- svjatoslav.eu
- Svjatoslav repository
- http://www2.svjatoslav.eu/maven/
-
- ...
-
+
+ ...
+
+ svjatoslav.eu
+ Svjatoslav repository
+ http://www2.svjatoslav.eu/maven/
+
+ ...
+
#+END_SRC
* Requirements
@@ -177,11 +191,11 @@ On Ubuntu/Debian use:
#+BEGIN_SRC sh
sudo apt-get install graphviz
#+END_SRC
-* TODO
-- BUG: Should not hide references if there are too many of them to
- classes if referring classes are not visible anyway because of
- blacklist/whitelist rules. Basically reference counting should
- exclude not visible classes.
+* TO DO
+- BUG: Should not hide references if there are too many of them to classes if
+ referring classes are not visible anyway because of blacklist/whitelist rules.
+ Basically reference counting should exclude not visible classes.
+- FEATURE: integarte with [[http://plantuml.com/class-diagram][PlantUML]].
- FEATURE: add dark theme
- FEATURE: sort Class fields by alphabet
- FEATURE: visualize also concrete field values so it could be used as