Added reference to Tony Bargnesi github page.

[javainspect.git] / doc / index.org

diff --git a/doc/index.org b/doc/index.org
index 8fec2b9..09f1266 100644 (file)
--- a/doc/index.org
+++ b/doc/index.org
@@ -7,12 +7,26 @@
   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.
 
   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.
 

-- Program author:
+- Program authors:

   - Svjatoslav Agejenko
   - Svjatoslav Agejenko

-  - Homepage: http://svjatoslav.eu
-  - Email: mailto://svjatoslav@svjatoslav.eu
+    - Homepage: http://svjatoslav.eu
+    - Email: mailto://svjatoslav@svjatoslav.eu

 
 

-- [[http://svjatoslav.eu/programs.jsp][other applications 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]]
+
+* (document settings) :noexport:
+** use dark style for TWBS-HTML exporter
+#+HTML_HEAD: <link href="https://bootswatch.com/4/darkly/bootstrap.min.css" rel="stylesheet">
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
+#+HTML_HEAD: <style type="text/css">
+#+HTML_HEAD:   footer {background-color: #111 !important;}
+#+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
+#+HTML_HEAD: </style>

 
 * General
 Goal: simplify/speed up understanding the computer program code by
 
 * General
 Goal: simplify/speed up understanding the computer program code by


@@ -41,7 +55,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.
 
 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:
 
 * Example graphs
 + A very simple example:


@@ -52,7 +66,7 @@ Note: GraphViz is developed and tested so far only on GNU Linux.
 
     file:legend.png
 
 
     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
 
 * Usage
 Currently the only way to control JavaInspect is by using Java


@@ -154,7 +168,7 @@ Declare JavaInspect as dependency:
     <dependency>
         <groupId>eu.svjatoslav</groupId>
         <artifactId>javainspect</artifactId>
     <dependency>
         <groupId>eu.svjatoslav</groupId>
         <artifactId>javainspect</artifactId>

-        <version>1.5-SNAPSHOT</version>
+        <version>1.6</version>

     </dependency>
     ...
 </dependencies>
     </dependency>
     ...
 </dependencies>


@@ -181,11 +195,13 @@ On Ubuntu/Debian use:
 #+BEGIN_SRC sh
 sudo apt-get install graphviz
 #+END_SRC
 #+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: replace internal java parser in package
+  eu.svjatoslav.inspector.java.methods with: https://javaparser.org/
+- 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
 - FEATURE: add dark theme
 - FEATURE: sort Class fields by alphabet
 - FEATURE: visualize also concrete field values so it could be used as