X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.org;h=09f1266b64a0ffbf811c1b77625b67d5b568712a;hb=52abcfeed07d308b2b377985b5cb8a776bb2e375;hp=9ee436a13c1005a2e57190946d039f91bea27ebd;hpb=56ead4ec8d0bc5a1d1e5a9b5c6f7db1fadb92a4a;p=javainspect.git diff --git a/doc/index.org b/doc/index.org index 9ee436a..09f1266 100644 --- 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. -- Program author: +- Program authors: - 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: +#+HTML_HEAD: +#+HTML_HEAD: " +#+HTML_HEAD: * 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. -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 +66,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 +168,7 @@ Declare JavaInspect as dependency: eu.svjatoslav javainspect - 1.5-SNAPSHOT + 1.6 ... @@ -182,10 +196,12 @@ 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: 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