From bb560c052bb8360514291312f47fd247990fe017 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Tue, 26 Dec 2017 17:15:26 +0200 Subject: [PATCH] Updated documentation. --- doc/index.html | 57 ++++++++++++++++--- doc/index.org | 23 ++++++-- .../commons/file/CommonPathResolver.java | 3 + 3 files changed, 70 insertions(+), 13 deletions(-) diff --git a/doc/index.html b/doc/index.html index c850b47..f3738e8 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ Svjatoslav Commons - Java library of commonly used functions - + @@ -222,55 +222,94 @@ License or later as published by the Free Software Foundation.
-

1 General

+

1 Library contents

-

-Library contains: -

  • 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
+
@@ -294,7 +333,7 @@ Maven pom.xml file snippet: <dependency> <groupId>eu.svjatoslav</groupId> <artifactId>svjatoslavcommons</artifactId> - <version>1.5</version> + <version>1.7</version> </dependency> ... </dependencies> @@ -316,7 +355,7 @@ Maven pom.xml file snippet:
diff --git a/doc/index.org b/doc/index.org index 2f3ef57..13205f5 100644 --- a/doc/index.org +++ b/doc/index.org @@ -24,36 +24,51 @@ #+HTML_HEAD: pre {background-color: #111; color: #ccc;} #+HTML_HEAD: -* 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: eu.svjatoslav svjatoslavcommons - 1.5 + 1.7 ... diff --git a/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java b/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java index 65434ef..91eb60c 100755 --- a/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java +++ b/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java @@ -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", "المكتب", -- 2.20.1