projects / svjatoslav_commons.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: cd703af)
Added JavaDoc
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Sat, 19 Jan 2019 00:03:43 +0000 (02:03 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Sat, 19 Jan 2019 00:03:43 +0000 (02:03 +0200)
.gitignore patch | blob | history
doc/index.html patch | blob | history
doc/index.org patch | blob | history
pom.xml patch | blob | history
tools/update web site patch | blob | history

diff --git a/.gitignore b/.gitignore
index 78de0c3..47b3ebe 100755 (executable)
--- a/.gitignore
+++ b/.gitignore
@@ -2,5 +2,6 @@
 /.project
 /.classpath
 /target/
+/doc/apidocs/
 /.idea/
 svjatoslavcommons.iml
\ No newline at end of file
diff --git a/doc/index.html b/doc/index.html
index 35d0e25..72581b6 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -2,14 +2,14 @@
 <html lang="en">
 <head>
 <title>Svjatoslav Commons - Java library of commonly used functions</title>
-<!-- 2019-01-19 Sat 01:27 -->
+<!-- 2019-01-19 Sat 02:02 -->
 <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/4/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>"
+<link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
 <style type="text/css">
 footer {background-color: #111 !important;}
 pre {background-color: #111; color: #ccc;}
@@ -196,14 +196,15 @@ $(function() {
 <body>
 <div id="content" class="container">
 <div class="row"><div class="col-md-9"><h1 class="title">Svjatoslav Commons - Java library of commonly used functions</h1>
-<hr >
-<ul class="org-ul">
-<li><a href="https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.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.
+<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">
+<ul class="org-ul">
+<li>This program is free software: you can redistribute it and/or modify
+it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
 </li>
 
 <li>Program author:
@@ -217,14 +218,42 @@ License</a> or later as published by the Free Software Foundation.
 </ul>
 </li>
 
-<li><a href="http://www.svjatoslav.eu/programs.jsp">other applications hosted at svjatoslav.eu</a>
+<li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
 </li>
 </ul>
+</div>
 
-<div id="outline-container-sec-1" class="outline-2">
-<h2 id="sec-1"><span class="section-number-2">1</span> Library contents</h2>
-<div class="outline-text-2" id="text-1">
+<div id="outline-container-sec-1-1" class="outline-3">
+<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="https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
+</li>
+
+<li><a href="https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=summary">Browse Git repository online</a>
+</li>
+
+<li>Clone Git repository using command:
+<pre class="example">
+git clone https://www2.svjatoslav.eu/git/svjatoslav_commons.git
+
+</pre>
+</li>
+
+<li>See <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">JavaDoc</a>.
+</li>
+</ul>
+</div>
+</div>
+</div>
+
+<div id="outline-container-sec-2" class="outline-2">
+<h2 id="sec-2"><span class="section-number-2">2</span> Library contents</h2>
+<div class="outline-text-2" id="text-2">
+<ul class="org-ul">
+<li>See <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">JavaDoc</a>.
+</li>
+
 <li>Commandline Interface helper
 <pre class="example">
 eu.svjatoslav.commons.commandline.CLIHelper
@@ -328,9 +357,9 @@ eu.svjatoslav.commons.string.WildCardMatcher#match
 </div>
 </div>
 
-<div id="outline-container-sec-2" class="outline-2">
-<h2 id="sec-2"><span class="section-number-2">2</span> Usage</h2>
-<div class="outline-text-2" id="text-2">
+<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>
 Instructions to embed svjatoslav-commons in your project as a library:
 </p>
@@ -368,15 +397,20 @@ 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. Library contents</a></li>
-<li><a href="#sec-2">2. Usage</a></li>
+<li><a href="#sec-1">1. General</a>
+<ul class="nav">
+<li><a href="#sec-1-1">1.1. Source code</a></li>
+</ul>
+</li>
+<li><a href="#sec-2">2. Library contents</a></li>
+<li><a href="#sec-3">3. Usage</a></li>
 </ul>
 </div>
 </nav>
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2019-01-19 Sat 01:27</p>
+<p class="date">Created: 2019-01-19 Sat 02:02</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>
diff --git a/doc/index.org b/doc/index.org
index fd1101a..6da7fc0 100644 (file)
--- a/doc/index.org
+++ b/doc/index.org
@@ -1,30 +1,41 @@
 #+TITLE: Svjatoslav Commons - Java library of commonly used functions
 
------
-- [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]]
+* (document settings) :noexport:
+** use dark style for TWBS-HTML exporter
+#+HTML_HEAD: <link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
+#+HTML_HEAD: <style type="text/css">
+#+HTML_HEAD:   footer {background-color: #111 !important;}
+#+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
+#+HTML_HEAD: </style>
 
-- This program is free software; you can redistribute it and/or modify
-  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.
+* General
+- This program is free software: you can redistribute it and/or modify
+  it under the terms of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] as
+  published by the Free Software Foundation, either version 3 of the
+  License, or (at your option) any later version.
 
 - Program author:
   - Svjatoslav Agejenko
   - Homepage: https://svjatoslav.eu
   - Email: mailto://svjatoslav@svjatoslav.eu
 
-- [[http://www.svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
+- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
 
-* (document settings) :noexport:
-** use dark style for TWBS-HTML exporter
-#+HTML_HEAD: <link href="https://bootswatch.com/4/darkly/bootstrap.min.css" rel="stylesheet">
-#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
-#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
-#+HTML_HEAD: <style type="text/css">
-#+HTML_HEAD:   footer {background-color: #111 !important;}
-#+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
-#+HTML_HEAD: </style>
+** Source code
+- [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
+
+- [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=summary][Browse Git repository online]]
+
+- Clone Git repository using command:
+  : git clone https://www2.svjatoslav.eu/git/svjatoslav_commons.git
+
+- See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
 
 * Library contents
+- See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
+
 - Commandline Interface helper
   : eu.svjatoslav.commons.commandline.CLIHelper
 
diff --git a/pom.xml b/pom.xml
index 090631d..b721a9e 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -51,7 +51,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.9</version>
+                <version>3.0.1</version>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
@@ -60,6 +60,9 @@
                         </goals>
                     </execution>
                 </executions>
+                <configuration>
+                    <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
+                </configuration>
             </plugin>
 
             <plugin>
diff --git a/tools/update web site b/tools/update web site
index ddc6eaa..cdc02ae 100755 (executable)
--- a/tools/update web site
+++ b/tools/update web site
@@ -5,6 +5,11 @@ if [ "$1" != "T" ]; then gnome-terminal -e "'$0' T"; exit; fi
 cd "${0%/*}"
 cd ..
 
+mvn clean package
+
+rm -rf doc/apidocs/
+cp -r target/apidocs/ doc/
+
 rsync -avz --delete  -e 'ssh -p 10006' doc/ n0@www3.svjatoslav.eu:/mnt/big/projects/svjatoslav_commons/
 
 echo
Unnamed repository; edit this file 'description' to name the repository.