PlantUML integration idea.
[javainspect.git] / doc / index.html
index b3da463..af7b23b 100644 (file)
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
-<html>\r
-<head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
-<title>JavaInspect</title>\r
-</head>\r
-<body>\r
-       <h1>JavaInspect - Utility to visualize java software</h1>\r
-       <a\r
-               href="http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">Download</a>\r
-       &nbsp;&nbsp;\r
-       <a\r
-               href="http://www2.svjatoslav.eu/gitbrowse/javainspect/doc/index.html">Online\r
-               homepage</a> &nbsp;&nbsp;\r
-       <a href="http://svjatoslav.eu/programs.jsp">Other applications\r
-               hosted on svjatoslav.eu</a>\r
-       <pre>\r
-<b>Program author:</b>\r
-    Svjatoslav Agejenko\r
-    Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>\r
-    Email: <a href="mailto:svjatoslav@svjatoslav.eu">svjatoslav@svjatoslav.eu</a>\r
-\r
-This software is distributed under <a\r
-                       href="http://www.gnu.org/licenses/gpl-2.0.html">GNU GENERAL PUBLIC LICENSE Version 2</a>.\r
-\r
-</pre>\r
-\r
-       <h2>General</h2>\r
-\r
-       Goal: simplify/speed up understanding the computer program code by\r
-       automatically visualizing its structure.\r
-         \r
-       <br/><br/>\r
-       JavaInspect is a Java library that you can embed into your Java project\r
-       with a few lines of Maven configuration and then visualize any part of\r
-       your Java program structure with few simple JavaInspect API calls at\r
-       application runtime.\r
-\r
-       <br />\r
-       <br /> JavaInspect uses Java reflection to discover class relations and\r
-       structure and produces GraphViz dot file that describes your\r
-       application. Then launches GraphViz to generate bitmap graph in PNG\r
-       format on your Desktop directory.\r
-\r
-\r
-       <h2>Current status</h2>\r
-\r
-       This is simple utility, quickly written. Tested on Linux (can be\r
-       relatively simply ported to other operating systems too). So far I used\r
-       it for my own needs. There might be bugs and missing features. Feedback\r
-       and code contributions are welcome.\r
-\r
-\r
-       <h2>Example graphs</h2>\r
-\r
-       Example visualization of\r
-       <a href="http://www2.svjatoslav.eu/gitbrowse/sixth/doc/">Sixth</a>\r
-       project:\r
-       <a\r
-               href="http://www2.svjatoslav.eu/gitbrowse/sixth/doc/architecture%20graphs/index.html">architecture\r
-               graphs</a>\r
-\r
-       <br />\r
-       <br /> A very simple example:\r
-       <br />\r
-       <a href="example.png"><img src="example.resized.png" /></a>\r
-\r
-       <br /> Graph legend:\r
-       <br />\r
-       <img src="legend.png" />\r
-\r
-\r
-       <h2>Usage example</h2>\r
-\r
-       Following example produces graph for JavaInspect itself:\r
-\r
-       <pre>\r
-\r
-<code>\r
-// Create graph\r
-final ClassGraph graph = new ClassGraph();\r
-\r
-// Add some object to the graph.\r
-graph.addObject(graph);\r
-\r
-// Add some class to the graph.\r
-graph.addClass(Utils.class);\r
-\r
-// Produce bitmap image titled "JavaInspect.png" to the user Desktop\r
-// directory.\r
-graph.generateGraph("JavaInspect", true);\r
-</code>\r
-\r
-\r
-Result:\r
-    Generated DOT file: <a href="JavaInspect.dot">JavaInspect.dot</a>\r
-    Generated PNG image: <a href="JavaInspect.png">JavaInspect.png</a>\r
-\r
-</pre>\r
-\r
-\r
-\r
-       <h2>Embedding JavaInspect in your project</h2>\r
-       <pre>\r
-\r
-Declare JavaInspect as dependency:\r
-\r
-    &lt;dependencies&gt;\r
-\r
-        ...\r
-\r
-        &lt;dependency&gt;\r
-            &lt;groupId&gt;eu.svjatoslav&lt;/groupId&gt;\r
-            &lt;artifactId&gt;javainspect&lt;/artifactId&gt;\r
-            &lt;version&gt;1.0&lt;/version&gt;\r
-        &lt;/dependency&gt;\r
\r
-    &lt;/dependencies&gt;\r
-    \r
-  \r
-  \r
-Add Maven repository to retrieve artifact from:\r
-  \r
-    &lt;repositories&gt;\r
-        &lt;repository&gt;\r
-            &lt;id&gt;svjatoslav.eu&lt;/id&gt;\r
-            &lt;name&gt;Svjatoslav repository&lt;/name&gt;\r
-            &lt;url&gt;http://www2.svjatoslav.eu/maven/&lt;/url&gt;\r
-        &lt;/repository&gt;\r
-    &lt;/repositories&gt;\r
-</pre>\r
-\r
-\r
-\r
-\r
-       <h2>Requirements</h2>\r
-\r
-       <br>\r
-       <a href="http://www.graphviz.org/">GraphViz</a> - shall be installed on\r
-       the computer.\r
-\r
-\r
-</body>\r
-</html>\r
+<!doctype html>
+<html lang="en">
+<head>
+<title>JavaInspect - Utility to visualize java software</title>
+<!-- 2017-04-18 Tue 12:32 -->
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="generator" content="Org-mode">
+<meta name="author" content="Svjatoslav Agejenko">
+<link href="https://bootswatch.com/darkly/bootstrap.min.css" rel="stylesheet">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
+<style type="text/css">
+footer {background-color: #111 !important;}
+pre {background-color: #111; color: #ccc;}
+</style>
+<style type="text/css">
+/* org mode styles on top of twbs */
+
+html {
+    position: relative;
+    min-height: 100%;
+}
+
+body {
+    font-size: 18px;
+    margin-bottom: 105px;
+}
+
+footer {
+    position: absolute;
+    bottom: 0;
+    width: 100%;
+    height: 101px;
+    background-color: #f5f5f5;
+}
+
+footer > div {
+    padding: 10px;
+}
+
+footer p {
+    margin: 0 0 5px;
+    text-align: center;
+    font-size: 16px;
+}
+
+#table-of-contents {
+    margin-top: 20px;
+    margin-bottom: 20px;
+}
+
+blockquote p {
+    font-size: 18px;
+}
+
+pre {
+    font-size: 16px;
+}
+
+.footpara {
+    display: inline-block;
+}
+
+figcaption {
+  font-size: 16px;
+  color: #666;
+  font-style: italic;
+  padding-bottom: 15px;
+}
+
+/* from twbs docs */
+
+.bs-docs-sidebar.affix {
+    position: static;
+}
+@media (min-width: 768px) {
+    .bs-docs-sidebar {
+        padding-left: 20px;
+    }
+}
+
+/* All levels of nav */
+.bs-docs-sidebar .nav > li > a {
+    display: block;
+    padding: 4px 20px;
+    font-size: 14px;
+    font-weight: 500;
+    color: #999;
+}
+.bs-docs-sidebar .nav > li > a:hover,
+.bs-docs-sidebar .nav > li > a:focus {
+    padding-left: 19px;
+    color: #A1283B;
+    text-decoration: none;
+    background-color: transparent;
+    border-left: 1px solid #A1283B;
+}
+.bs-docs-sidebar .nav > .active > a,
+.bs-docs-sidebar .nav > .active:hover > a,
+.bs-docs-sidebar .nav > .active:focus > a {
+    padding-left: 18px;
+    font-weight: bold;
+    color: #A1283B;
+    background-color: transparent;
+    border-left: 2px solid #A1283B;
+}
+
+/* Nav: second level (shown on .active) */
+.bs-docs-sidebar .nav .nav {
+    display: none; /* Hide by default, but at >768px, show it */
+    padding-bottom: 10px;
+}
+.bs-docs-sidebar .nav .nav > li > a {
+    padding-top: 1px;
+    padding-bottom: 1px;
+    padding-left: 30px;
+    font-size: 12px;
+    font-weight: normal;
+}
+.bs-docs-sidebar .nav .nav > li > a:hover,
+.bs-docs-sidebar .nav .nav > li > a:focus {
+    padding-left: 29px;
+}
+.bs-docs-sidebar .nav .nav > .active > a,
+.bs-docs-sidebar .nav .nav > .active:hover > a,
+.bs-docs-sidebar .nav .nav > .active:focus > a {
+    padding-left: 28px;
+    font-weight: 500;
+}
+
+/* Nav: third level (shown on .active) */
+.bs-docs-sidebar .nav .nav .nav {
+    padding-bottom: 10px;
+}
+.bs-docs-sidebar .nav .nav .nav > li > a {
+    padding-top: 1px;
+    padding-bottom: 1px;
+    padding-left: 40px;
+    font-size: 12px;
+    font-weight: normal;
+}
+.bs-docs-sidebar .nav .nav .nav > li > a:hover,
+.bs-docs-sidebar .nav .nav .nav > li > a:focus {
+    padding-left: 39px;
+}
+.bs-docs-sidebar .nav .nav .nav > .active > a,
+.bs-docs-sidebar .nav .nav .nav > .active:hover > a,
+.bs-docs-sidebar .nav .nav .nav > .active:focus > a {
+    padding-left: 38px;
+    font-weight: 500;
+}
+
+/* Show and affix the side nav when space allows it */
+@media (min-width: 992px) {
+    .bs-docs-sidebar .nav > .active > ul {
+        display: block;
+    }
+    /* Widen the fixed sidebar */
+    .bs-docs-sidebar.affix,
+    .bs-docs-sidebar.affix-bottom {
+        width: 213px;
+    }
+    .bs-docs-sidebar.affix {
+        position: fixed; /* Undo the static from mobile first approach */
+        top: 20px;
+    }
+    .bs-docs-sidebar.affix-bottom {
+        position: absolute; /* Undo the static from mobile first approach */
+    }
+    .bs-docs-sidebar.affix .bs-docs-sidenav,.bs-docs-sidebar.affix-bottom .bs-docs-sidenav {
+        margin-top: 0;
+        margin-bottom: 0
+    }
+}
+@media (min-width: 1200px) {
+    /* Widen the fixed sidebar again */
+    .bs-docs-sidebar.affix-bottom,
+    .bs-docs-sidebar.affix {
+        width: 263px;
+    }
+}
+</style>
+<script type="text/javascript">
+$(function() {
+    'use strict';
+
+    $('.bs-docs-sidebar li').first().addClass('active');
+
+    $(document.body).scrollspy({target: '.bs-docs-sidebar'});
+
+    $('.bs-docs-sidebar').affix();
+});
+</script>
+</head>
+<body>
+<div id="content" class="container">
+<div class="row"><div class="col-md-9"><h1 class="title">JavaInspect - Utility to visualize java software</h1>
+<hr >
+<ul class="org-ul">
+<li><a href="http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">download latest snapshot</a>
+</li>
+
+<li>This program is free software; you can redistribute it and/or modify
+it under the terms of version 3 of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public
+License</a> or later as published by the Free Software Foundation.
+</li>
+
+<li>Program author:
+<ul class="org-ul">
+<li>Svjatoslav Agejenko
+</li>
+<li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
+</li>
+<li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
+</li>
+</ul>
+</li>
+
+<li><a href="http://svjatoslav.eu/programs.jsp">other applications hosted at svjatoslav.eu</a>
+</li>
+</ul>
+
+<div id="outline-container-sec-1" class="outline-2">
+<h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
+<div class="outline-text-2" id="text-1">
+<p>
+Goal: simplify/speed up understanding the computer program code by
+automatically visualizing its structure.
+</p>
+
+<p>
+JavaInspect is a Java library that primarily uses Java reflection to
+discover and visualize any part of Java program provided that
+classes to be visualised are available in the classpath.
+</p>
+
+<p>
+JavaInspect currently has no GUI, configuration files, embedded
+scripting support, direct Maven or Ant integration. The only way to
+instuct Javainspect what to do is by using its Java API.
+</p>
+
+<p>
+To get JavaInspect into same classpath with your projecs I so far came
+up with 2 solutions:
+</p>
+
+<ol class="org-ol">
+<li>Add JavaInspect library in your project as a dependency.
+</li>
+<li>Create new Java project for the purpose visualizing your other
+projects and include JavaInspect and your projecs binary artifacts
+(Jar's) into new project classpath. Built binary Jar's (with no
+source code) are sufficient because JavaInspect operates via
+reflection.
+</li>
+</ol>
+
+<p>
+After discovering application structure and optionally filtering out
+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.
+</p>
+
+<p>
+Note: GraphViz is developed and tested so far only on GNU/Linux.
+</p>
+</div>
+</div>
+
+<div id="outline-container-sec-2" class="outline-2">
+<h2 id="sec-2"><span class="section-number-2">2</span> Example graphs</h2>
+<div class="outline-text-2" id="text-2">
+<ul class="org-ul">
+<li>A very simple example:
+
+
+<figure>
+<p><a href="example.png"><img src="example.resized.png" class="img-responsive" alt="example.resized.png"></a>
+</p>
+</figure>
+
+<p>
+Graph legend:
+</p>
+
+
+<figure>
+<p><img src="legend.png" class="img-responsive" alt="legend.png">
+</p>
+</figure>
+</li>
+
+<li>Example visualization of <a href="http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/">Sixth 3D</a> project: <a href="http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/codeGraph/">architecture graphs</a>.
+</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-sec-3" class="outline-2">
+<h2 id="sec-3"><span class="section-number-2">3</span> Usage</h2>
+<div class="outline-text-2" id="text-3">
+<p>
+Currently the only way to control JavaInspect is by using Java
+API. Simple Java based control/configuration code needs to be written
+for each project. I usually put such code into directories devoted for
+JUnit tests. Because it needs not to be compiled/embedded into final
+product or project artifact I'm just willing to visualize.
+</p>
+
+<p>
+Control code in general does the following:
+</p>
+<ol class="org-ol">
+<li>Create graph object.
+</li>
+<li>Java reflection/classloaders does not provide mechanism for
+discovering all classes under given package. Therefore you need to
+declare at least some classes to be added to the graph by:
+<ul class="org-ul">
+<li>Manually adding individual classes to the graph.
+</li>
+<li>and/or: Let GraphViz recursively scan and parse specified
+directories with Java source code files to discover class names.
+</li>
+<li>For every class added to the graph, GraphViz will recursively
+inspect it and add all referecned classes to the graph as well.
+</li>
+</ul>
+</li>
+<li>Graphs easilly get very big and complex so optionally we filter
+important code using classname wildcards patterns based blacklist
+and/or whitelist.
+</li>
+<li>Optionally we can tune some rendering parameters like:
+<ul class="org-ul">
+<li>Possibility to remove orphaned classes (classes with no
+references) from the graph.
+</li>
+<li>Specify target directory for generated visualization
+files. (Default is user desktop directory)
+</li>
+<li>Keep intermediate GraphViz dot file for later inspection.
+</li>
+</ul>
+</li>
+<li>Render graph.
+</li>
+</ol>
+</div>
+
+
+<div id="outline-container-sec-3-1" class="outline-3">
+<h3 id="sec-3-1"><span class="section-number-3">3.1</span> example 1: individually picked objects</h3>
+<div class="outline-text-3" id="text-3-1">
+<p>
+This example demonstrates generating of class graph from hand picked
+classes and visualizing GraphViz itself.
+</p>
+
+<div class="org-src-container">
+
+<pre class="src src-java"><span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Create graph</span>
+<span style="color: #F92672;">final</span> <span style="color: #66D9EF;">ClassGraph</span> <span style="color: #FD971F;">graph</span> = <span style="color: #F92672;">new</span> <span style="color: #66D9EF;">ClassGraph</span>();
+
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Add some random object to the graph. GraphViz will detect Class from</span>
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">the object.</span>
+graph.add(graph);
+
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Also add some random class to the graph.</span>
+graph.add(Utils.<span style="color: #F92672;">class</span>);
+
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Keep intermediary GraphViz DOT file for reference.</span>
+graph.setKeepDotFile(<span style="color: #FF80F4;">true</span>);
+
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Produce bitmap image titled "JavaInspect.png" to the user Desktop</span>
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">directory</span>
+graph.generateGraph(<span style="color: #EEDC82;">"JavaInspect"</span>);
+</pre>
+</div>
+
+<p>
+Note: if desired, more compact version of the above:
+</p>
+<div class="org-src-container">
+
+<pre class="src src-java"><span style="color: #F92672;">new</span> <span style="color: #66D9EF;">ClassGraph</span>().add(randomObject, RandomClass.<span style="color: #F92672;">class</span>)
+                .setKeepDotFile(<span style="color: #FF80F4;">true</span>).generateGraph(<span style="color: #EEDC82;">"JavaInspect"</span>);
+</pre>
+</div>
+
+
+<p>
+Result:
+</p>
+<ul class="org-ul">
+<li>Generated DOT file: <a href="JavaInspect.dot">JavaInspect.dot</a>
+</li>
+<li>Generated PNG image: <a href="JavaInspect.png">JavaInspect.png</a>
+</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-sec-3-2" class="outline-3">
+<h3 id="sec-3-2"><span class="section-number-3">3.2</span> example 2: scan java code, apply filters</h3>
+<div class="outline-text-3" id="text-3-2">
+<div class="org-src-container">
+
+<pre class="src src-java"><span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Create graph</span>
+<span style="color: #F92672;">final</span> <span style="color: #66D9EF;">ClassGraph</span> <span style="color: #FD971F;">graph</span> = <span style="color: #F92672;">new</span> <span style="color: #66D9EF;">ClassGraph</span>();
+
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Recursively scan current directory for Java source code and attempt</span>
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">to detect class names from there to be added to the graph.</span>
+graph.addProject(<span style="color: #EEDC82;">"."</span>);
+
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Blacklist example classes from being shown on the graph</span>
+graph.blacklistClassPattern(<span style="color: #EEDC82;">"eu.svjatoslav.inspector.java.structure.example.*"</span>);
+
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">do not show single classes with no relationships on the graph</span>
+graph.hideOrphanedClasses();
+
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Produce bitmap image titled "JavaInspect full project.png" to the</span>
+<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">user Desktop directory.</span>
+graph.generateGraph(<span style="color: #EEDC82;">"JavaInspect full project"</span>);
+</pre>
+</div>
+<p>
+Result:
+</p>
+<ul class="org-ul">
+<li>Generated PNG image: <a href="JavaInspect%20full%20project.png">JavaInspect full project.png</a>
+</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-sec-3-3" class="outline-3">
+<h3 id="sec-3-3"><span class="section-number-3">3.3</span> example 3: GraphViz embedded in another project</h3>
+<div class="outline-text-3" id="text-3-3">
+<ol class="org-ol">
+<li>Download project Sixth <a href="http://www2.svjatoslav.eu/gitweb/?p=sixth.git;a=snapshot;h=HEAD;sf=tgz">code snapshot</a>.
+</li>
+<li>Inspect and run *DataGraph.java*.
+</li>
+</ol>
+</div>
+</div>
+</div>
+
+<div id="outline-container-sec-4" class="outline-2">
+<h2 id="sec-4"><span class="section-number-2">4</span> Embedding JavaInspect in your Maven project</h2>
+<div class="outline-text-2" id="text-4">
+<p>
+Declare JavaInspect as dependency:
+</p>
+<div class="org-src-container">
+
+<pre class="src src-xml">&lt;<span style="color: #A6E22E;">dependencies</span>&gt;
+    ...
+    &lt;<span style="color: #A6E22E;">dependency</span>&gt;
+        &lt;<span style="color: #A6E22E;">groupId</span>&gt;eu.svjatoslav&lt;/<span style="color: #A6E22E;">groupId</span>&gt;
+        &lt;<span style="color: #A6E22E;">artifactId</span>&gt;javainspect&lt;/<span style="color: #A6E22E;">artifactId</span>&gt;
+        &lt;<span style="color: #A6E22E;">version</span>&gt;1.5&lt;/<span style="color: #A6E22E;">version</span>&gt;
+    &lt;/<span style="color: #A6E22E;">dependency</span>&gt;
+    ...
+&lt;/<span style="color: #A6E22E;">dependencies</span>&gt;
+</pre>
+</div>
+
+
+<p>
+Add Maven repository to retrieve artifact from:
+</p>
+<div class="org-src-container">
+
+<pre class="src src-xml">&lt;<span style="color: #A6E22E;">repositories</span>&gt;
+    ...
+    &lt;<span style="color: #A6E22E;">repository</span>&gt;
+        &lt;<span style="color: #A6E22E;">id</span>&gt;svjatoslav.eu&lt;/<span style="color: #A6E22E;">id</span>&gt;
+        &lt;<span style="color: #A6E22E;">name</span>&gt;Svjatoslav repository&lt;/<span style="color: #A6E22E;">name</span>&gt;
+        &lt;<span style="color: #A6E22E;">url</span>&gt;http://www2.svjatoslav.eu/maven/&lt;/<span style="color: #A6E22E;">url</span>&gt;
+    &lt;/<span style="color: #A6E22E;">repository</span>&gt;
+    ...
+&lt;/<span style="color: #A6E22E;">repositories</span>&gt;
+</pre>
+</div>
+</div>
+</div>
+
+<div id="outline-container-sec-5" class="outline-2">
+<h2 id="sec-5"><span class="section-number-2">5</span> Requirements</h2>
+<div class="outline-text-2" id="text-5">
+<p>
+<a href="http://www.graphviz.org/">GraphViz</a> - shall be installed on the computer.
+</p>
+
+<p>
+On Ubuntu/Debian use:
+</p>
+<div class="org-src-container">
+
+<pre class="src src-sh">sudo apt-get install graphviz
+</pre>
+</div>
+</div>
+</div>
+<div id="outline-container-sec-6" class="outline-2">
+<h2 id="sec-6"><span class="section-number-2">6</span> TO DO</h2>
+<div class="outline-text-2" id="text-6">
+<ul class="org-ul">
+<li>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.
+</li>
+<li>FEATURE: integarte with <a href="http://plantuml.com/class-diagram">PlantUML</a>.
+</li>
+<li>FEATURE: add dark theme
+</li>
+<li>FEATURE: sort Class fields by alphabet
+</li>
+<li>FEATURE: visualize also concrete field values so it could be used as
+ultra cool runtime logging framework
+</li>
+<li>FEATURE: possibility to visualize structure and data from JVM
+snapshot
+</li>
+<li>FEATURE: possibility to attach to remote process to visualize
+data/structure using JVM debug port and mechanism.
+</li>
+<li>FEATURE: possibility to attach to JVM using JVM agent
+</li>
+<li>FEATURE: possibility to script javainspect behavior
+</li>
+<li>FEATURE: possibility to select classes/fields/values to be
+visualized in SQL like syntax
+</li>
+<li>FEATURE: configurable maven plugin to generate graphs as part of the
+project build/release process
+</li>
+</ul>
+</div>
+</div>
+</div><div class="col-md-3"><nav id="table-of-contents">
+<div id="text-table-of-contents" class="bs-docs-sidebar">
+<ul class="nav">
+<li><a href="#sec-1">1. General</a></li>
+<li><a href="#sec-2">2. Example graphs</a></li>
+<li><a href="#sec-3">3. Usage</a>
+<ul class="nav">
+<li><a href="#sec-3-1">3.1. example 1: individually picked objects</a></li>
+<li><a href="#sec-3-2">3.2. example 2: scan java code, apply filters</a></li>
+<li><a href="#sec-3-3">3.3. example 3: GraphViz embedded in another project</a></li>
+</ul>
+</li>
+<li><a href="#sec-4">4. Embedding JavaInspect in your Maven project</a></li>
+<li><a href="#sec-5">5. Requirements</a></li>
+<li><a href="#sec-6">6. TO DO</a></li>
+</ul>
+</div>
+</nav>
+</div></div></div>
+<footer id="postamble" class="">
+<div><p class="author">Author: Svjatoslav Agejenko</p>
+<p class="date">Created: 2017-04-18 Tue 12:32</p>
+<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.4.1 (<a href="http://orgmode.org">Org-mode</a> 8.2.10)</p>
+</div>
+</footer>
+</body>
+</html>