Updated documentation.
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Tue, 26 Dec 2017 15:15:26 +0000 (17:15 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Tue, 26 Dec 2017 15:15:26 +0000 (17:15 +0200)
doc/index.html
doc/index.org
src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java

index c850b47..f3738e8 100644 (file)
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <title>Svjatoslav Commons - Java library of commonly used functions</title>
-<!-- 2017-11-29 Wed 23:58 -->
+<!-- 2017-12-26 Tue 17:13 -->
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="Org-mode">
@@ -222,55 +222,94 @@ License</a> or later as published by the Free Software Foundation.
 </ul>
 
 <div id="outline-container-sec-1" class="outline-2">
-<h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
+<h2 id="sec-1"><span class="section-number-2">1</span> Library contents</h2>
 <div class="outline-text-2" id="text-1">
-<p>
-Library contains:
-</p>
 <ul class="org-ul">
 <li>Commandline Interface helper
+<pre class="example">
+eu.svjatoslav.commons.commandline.CLIHelper
+</pre>
 </li>
 
 <li>Commandline arguments parser and validator.
+<pre class="example">
+eu.svjatoslav.commons.commandline.parameterparser
+</pre>
 </li>
 
 <li>Bit input and output streams.
+<pre class="example">
+eu.svjatoslav.commons.data.BitInputStream
+eu.svjatoslav.commons.data.BitOutputStream
+</pre>
 </li>
 
 <li>Slightly enhanced data input and output streams.
+<pre class="example">
+eu.svjatoslav.commons.data.EnhancedDataInputStream
+eu.svjatoslav.commons.data.EnhancedDataOutputStream
+</pre>
 </li>
 
 <li>Byte array to HEX string converter.
+<pre class="example">
+eu.svjatoslav.commons.data.HexConverter
+</pre>
 </li>
 
-<li>Utility that tries to quess user desktop directory.
+<li>Utility that tries to quess user desktop directory. (Quite ugly and
+unreliable. Better solution is needed.)
+<pre class="example">
+eu.svjatoslav.commons.file.CommonPathResolver
+</pre>
 </li>
 
 <li>File path parser.
+<pre class="example">
+eu.svjatoslav.commons.file.FilePathParser
+</pre>
 </li>
 
 <li>File IO helper.
+<pre class="example">
+eu.svjatoslav.commons.file.IOHelper
+</pre>
 </li>
 
 <li>Graphical error dialog.
 <ul class="org-ul">
 <li>Reusable graphical dialog to capture and show program exceptions
 and associated program call stack traceback.
+<pre class="example">
+eu.svjatoslav.commons.gui.dialog.ExceptionDialog
+</pre>
 </li>
 </ul>
 </li>
 
 <li>Primitive and simple component to add navigation menus to the web
 sites.
+<pre class="example">
+eu.svjatoslav.commons.network.navigation
+</pre>
 </li>
 
 <li>String tokenizer.
+<pre class="example">
+eu.svjatoslav.commons.string.tokenizer
+</pre>
 </li>
 
 <li>Improved String, optimized for dealing with prefixes and suffixes.
+<pre class="example">
+eu.svjatoslav.commons.string.String2
+</pre>
 </li>
 
 <li>Wildcards matcher. (?, *)
+<pre class="example">
+eu.svjatoslav.commons.string.WildCardMatcher#match
+</pre>
 </li>
 </ul>
 </div>
@@ -294,7 +333,7 @@ Maven pom.xml file snippet:
     &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;svjatoslavcommons&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;">version</span>&gt;1.7&lt;/<span style="color: #A6E22E;">version</span>&gt;
     &lt;/<span style="color: #A6E22E;">dependency</span>&gt;
     ...
 &lt;/<span style="color: #A6E22E;">dependencies</span>&gt;
@@ -316,7 +355,7 @@ Maven pom.xml file snippet:
 </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-1">1. Library contents</a></li>
 <li><a href="#sec-2">2. Usage</a></li>
 </ul>
 </div>
@@ -324,7 +363,7 @@ Maven pom.xml file snippet:
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2017-11-29 Wed 23:58</p>
+<p class="date">Created: 2017-12-26 Tue 17:13</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>
 </div>
 </footer>
index 2f3ef57..13205f5 100644 (file)
 #+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
 #+HTML_HEAD: </style>
 
-* General
-Library contains:
+* Library contents
 - Commandline Interface helper
+  : eu.svjatoslav.commons.commandline.CLIHelper
 
 - Commandline arguments parser and validator.
+  : eu.svjatoslav.commons.commandline.parameterparser
 
 - Bit input and output streams.
+  : eu.svjatoslav.commons.data.BitInputStream
+  : eu.svjatoslav.commons.data.BitOutputStream
 
 - Slightly enhanced data input and output streams.
+  : eu.svjatoslav.commons.data.EnhancedDataInputStream
+  : eu.svjatoslav.commons.data.EnhancedDataOutputStream
 
 - Byte array to HEX string converter.
+  : eu.svjatoslav.commons.data.HexConverter
 
-- Utility that tries to quess user desktop directory.
+- Utility that tries to quess user desktop directory. (Quite ugly and
+  unreliable. Better solution is needed.)
+  : eu.svjatoslav.commons.file.CommonPathResolver
 
 - File path parser.
+  : eu.svjatoslav.commons.file.FilePathParser
 
 - File IO helper.
+  : eu.svjatoslav.commons.file.IOHelper
 
 - Graphical error dialog.
   - Reusable graphical dialog to capture and show program exceptions
     and associated program call stack traceback.
+    : eu.svjatoslav.commons.gui.dialog.ExceptionDialog
 
 - Primitive and simple component to add navigation menus to the web
   sites.
+  : eu.svjatoslav.commons.network.navigation
 
 - String tokenizer.
+  : eu.svjatoslav.commons.string.tokenizer
 
 - Improved String, optimized for dealing with prefixes and suffixes.
+  : eu.svjatoslav.commons.string.String2
 
 - Wildcards matcher. (?, *)
+  : eu.svjatoslav.commons.string.WildCardMatcher#match
 
 * Usage
 Instructions to embed svjatoslav-commons in your project as a library:
@@ -66,7 +81,7 @@ Maven pom.xml file snippet:
     <dependency>
         <groupId>eu.svjatoslav</groupId>
         <artifactId>svjatoslavcommons</artifactId>
-        <version>1.5</version>
+        <version>1.7</version>
     </dependency>
     ...
 </dependencies>
index 65434ef..91eb60c 100755 (executable)
@@ -11,6 +11,9 @@ package eu.svjatoslav.commons.file;
 
 import java.io.File;
 
+/**
+ * FIXME: Quite ugly and unreliable. Better solution is needed.
+ */
 public class CommonPathResolver {
 
     private static final String[] desktopNames = new String[]{"Tafelblad", "المكتب",