projects / javainspect.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
updated project documentation
[javainspect.git] / doc / index.html
diff --git a/doc/index.html b/doc/index.html
index 4e2b55e..0a0c3ca 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <title>JavaInspect - Utility to visualize java software</title>
-<!-- 2018-06-24 Sun 02:25 -->
+<!-- 2021-01-10 P 00:37 -->
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="Org-mode">
@@ -211,11 +211,11 @@ License, or (at your option) any later version.
 <ul class="org-ul">
 <li>Svjatoslav Agejenko
 <ul class="org-ul">
-<li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
+<li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a>
 </li>
 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
 </li>
-<li><a href="http://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
+<li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
 </li>
 </ul>
 </li>
@@ -236,15 +236,16 @@ License, or (at your option) any later version.
 <h3 id="sec-1-1"><span class="section-number-3">1.1</span> Source code</h3>
 <div class="outline-text-3" id="text-1-1">
 <ul class="org-ul">
-<li><a href="http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
+<li><a href="https://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
 </li>
 
-<li><a href="http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=summary">Browse Git repository online</a>
+<li><a href="https://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=summary">Browse Git repository online</a>
 </li>
 
 <li>Clone Git repository using command:
 <pre class="example">
-git clone http://www2.svjatoslav.eu/git/javainspect.git
+git clone https://www2.svjatoslav.eu/git/javainspect.git
+
 </pre>
 </li>
 </ul>
@@ -261,7 +262,7 @@ automatically visualizing its structure.
 </p>
 
 <p>
-<a href="http://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="http://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
+<a href="https://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
 </p>
 
 <p>
@@ -279,16 +280,10 @@ how to instuct Javainspect what to do.
 <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
+describes data to be visualized. Then launches <a href="https://graphviz.org/">GraphViz</a> to generate
 bitmap graph in PNG or SVG format.
 </p>
 
-<p>
-By default on your Desktop directory when operated in library mode or
-current working directory when operated as standalone commandline
-application.
-</p>
-
 <p>
 Notes:
 </p>
@@ -309,7 +304,7 @@ Notes:
 
 
 <figure>
-<p><a href="example.png"><img src="example.resized.png" class="img-responsive" alt="example.resized.png"></a>
+<p><img src="example.png" class="img-responsive" alt="example.png">
 </p>
 </figure>
 
@@ -323,8 +318,11 @@ Graph legend:
 </p>
 </figure>
 </li>
+</ul>
+
 
-<li><a href="http://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="http://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
+<ul class="org-ul">
+<li><a href="https://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
 </li>
 </ul>
 </div>
@@ -352,6 +350,7 @@ To enable commandline support, (study and) execute script:
 </p>
 <pre class="example">
 commandline launcher/install
+
 </pre>
 
 <p>
@@ -430,21 +429,14 @@ Control code in general does the following:
 </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>
+declare at least some classes to be added to the graph by manually
+adding individual classes to the graph. For every class added to
+the graph, GraphViz will recursively inspect it and add all
+referecned classes to the graph as well.
 </li>
 <li>Graphs easilly get very big and complex so optionally we filter
-important code using classname wildcards patterns based blacklist
-and/or whitelist.
+important code using classname <a href="https://en.wikipedia.org/wiki/Glob_(programming)">glob</a> patterns based blacklist and/or
+whitelist.
 </li>
 <li>Optionally we can tune some rendering parameters like:
 <ul class="org-ul">
@@ -452,7 +444,7 @@ and/or whitelist.
 references) from the graph.
 </li>
 <li>Specify target directory for generated visualization
-files. (Default is user desktop directory)
+files. (Default is current directory)
 </li>
 <li>Keep intermediate GraphViz dot file for later inspection.
 </li>
@@ -474,22 +466,23 @@ classes and visualizing GraphViz itself.
 
 <div class="org-src-container">
 
-<pre class="src src-java">// Create graph
-final ClassGraph graph = new ClassGraph();
+<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>();
 
-// Add some random object to the graph. GraphViz will detect Class from
-// the object.
+<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);
 
-// Also add some random class to the graph.
-graph.add(Utils.class);
+<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>);
 
-// Keep intermediary GraphViz DOT file for reference.
-graph.setKeepDotFile(true);
+<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>);
 
-// Produce bitmap image titled "JavaInspect.png" to the user Desktop
-// directory
-graph.generateGraph("JavaInspect");
 </pre>
 </div>
 
@@ -498,8 +491,8 @@ Note: if desired, more compact version of the above:
 </p>
 <div class="org-src-container">
 
-<pre class="src src-java">new ClassGraph().add(randomObject, RandomClass.class)
-                .setKeepDotFile(true).generateGraph("JavaInspect");
+<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>
 
@@ -517,67 +510,34 @@ Result:
 </div>
 
 <div id="outline-container-sec-4-2-2" class="outline-4">
-<h4 id="sec-4-2-2"><span class="section-number-4">4.2.2</span> example 2: scan java code, apply filters</h4>
+<h4 id="sec-4-2-2"><span class="section-number-4">4.2.2</span> example 2: GraphViz embedded in another project</h4>
 <div class="outline-text-4" id="text-4-2-2">
-<div class="org-src-container">
-
-<pre class="src src-java">// Create graph
-final ClassGraph graph = new ClassGraph();
-
-// Recursively scan current directory for Java source code and attempt
-// to detect class names from there to be added to the graph.
-graph.addProject(".");
-
-// Blacklist example classes from being shown on the graph
-graph.blacklistClassPattern("eu.svjatoslav.inspector.java.structure.example.*");
-
-// do not show single classes with no relationships on the graph
-graph.hideOrphanedClasses();
-
-// Produce bitmap image titled "JavaInspect full project.png" to the
-// user Desktop directory.
-graph.generateGraph("JavaInspect full project");
-</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-4-2-3" class="outline-4">
-<h4 id="sec-4-2-3"><span class="section-number-4">4.2.3</span> example 3: GraphViz embedded in another project</h4>
-<div class="outline-text-4" id="text-4-2-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>Download project Sixth <a href="https://www2.svjatoslav.eu/gitweb/?p=sixth.git;a=snapshot;h=HEAD;sf=tgz">code snapshot</a>.
 </li>
-<li>Inspect and run *DataGraph.java*.
+<li>Inspect and run <b>DataGraph.java</b>.
 </li>
 </ol>
 </div>
 </div>
 
-<div id="outline-container-sec-4-2-4" class="outline-4">
-<h4 id="sec-4-2-4"><span class="section-number-4">4.2.4</span> Embedding JavaInspect in your Maven project</h4>
-<div class="outline-text-4" id="text-4-2-4">
+<div id="outline-container-sec-4-2-3" class="outline-4">
+<h4 id="sec-4-2-3"><span class="section-number-4">4.2.3</span> Embedding JavaInspect in your Maven project</h4>
+<div class="outline-text-4" id="text-4-2-3">
 <p>
 Declare JavaInspect as dependency:
 </p>
 <div class="org-src-container">
 
-<pre class="src src-xml">&lt;dependencies&gt;
+<pre class="src src-xml">&lt;<span style="color: #A6E22E;">dependencies</span>&gt;
     ...
-    &lt;dependency&gt;
-        &lt;groupId&gt;eu.svjatoslav&lt;/groupId&gt;
-        &lt;artifactId&gt;javainspect&lt;/artifactId&gt;
-        &lt;version&gt;1.6&lt;/version&gt;
-    &lt;/dependency&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.7&lt;/<span style="color: #A6E22E;">version</span>&gt;
+    &lt;/<span style="color: #A6E22E;">dependency</span>&gt;
     ...
-&lt;/dependencies&gt;
+&lt;/<span style="color: #A6E22E;">dependencies</span>&gt;
 </pre>
 </div>
 
@@ -587,15 +547,15 @@ Add Maven repository to retrieve artifact from:
 </p>
 <div class="org-src-container">
 
-<pre class="src src-xml">&lt;repositories&gt;
+<pre class="src src-xml">&lt;<span style="color: #A6E22E;">repositories</span>&gt;
     ...
-    &lt;repository&gt;
-        &lt;id&gt;svjatoslav.eu&lt;/id&gt;
-        &lt;name&gt;Svjatoslav repository&lt;/name&gt;
-        &lt;url&gt;http://www2.svjatoslav.eu/maven/&lt;/url&gt;
-    &lt;/repository&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;/repositories&gt;
+&lt;/<span style="color: #A6E22E;">repositories</span>&gt;
 </pre>
 </div>
 </div>
@@ -690,8 +650,10 @@ of operation).
 </ul>
 </li>
 
-<li>FEATURE: Replace internal java parser in package
-eu.svjatoslav.inspector.java.methods with: <a href="https://javaparser.org/">https://javaparser.org/</a>
+<li>FEATURE: Implement (or integrate existing java parser
+<a href="https://javaparser.org/">https://javaparser.org/</a>) to be able to produce code visualizations
+based on source code (in addition to current reflection based
+approach).
 </li>
 
 <li>FEATURE: Integarte with <a href="http://plantuml.com/class-diagram">PlantUML</a>.
@@ -718,7 +680,7 @@ data/structure using JVM debug port and mechanism.
 <li>FEATURE: Possibility to attach to JVM using JVM agent.
 </li>
 
-<li>FEATURE: Possibility to inspect graphs in 3D using <a href="http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/index.html">Sixth 3D engine</a>.
+<li>FEATURE: Possibility to inspect graphs in 3D using <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D engine</a>.
 </li>
 
 <li>FEATURE: Possibility to select classes/fields/values to be
@@ -739,6 +701,18 @@ project build/release process.
 </ul>
 </div>
 </div>
+<div id="outline-container-sec-7" class="outline-2">
+<h2 id="sec-7"><span class="section-number-2">7</span> See also</h2>
+<div class="outline-text-2" id="text-7">
+<p>
+Similar or alternative solutions:
+</p>
+<ul class="org-ul">
+<li><a href="http://www.class-visualizer.net/">http://www.class-visualizer.net/</a>
+</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">
@@ -757,14 +731,15 @@ project build/release process.
 </li>
 <li><a href="#sec-5">5. Requirements</a></li>
 <li><a href="#sec-6">6. TO DO</a></li>
+<li><a href="#sec-7">7. See also</a></li>
 </ul>
 </div>
 </nav>
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2018-06-24 Sun 02:25</p>
-<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 25.1.1 (<a href="http://orgmode.org">Org-mode</a> 8.2.10)</p>
+<p class="date">Created: 2021-01-10 P 00:37</p>
+<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 26.1 (<a href="http://orgmode.org">Org-mode</a> 9.1.9)</p>
 </div>
 </footer>
 </body>
Unnamed repository; edit this file 'description' to name the repository.