X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.org;h=4293347a099d84abaf18d7c0e26eec9137b11265;hb=e063acd00b41c61a5881af71156c5b24b6a44f77;hp=9ee436a13c1005a2e57190946d039f91bea27ebd;hpb=56ead4ec8d0bc5a1d1e5a9b5c6f7db1fadb92a4a;p=javainspect.git
diff --git a/doc/index.org b/doc/index.org
index 9ee436a..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
@@ -154,7 +164,7 @@ Declare JavaInspect as dependency:
eu.svjatoslavjavainspect
- 1.5-SNAPSHOT
+ 1.6
...
@@ -182,10 +192,10 @@ On Ubuntu/Debian use:
sudo apt-get install graphviz
#+END_SRC
* 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.
+- 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