From 56f1016001b428ddb974fc6d415037fb4d982f18 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Sat, 19 Jan 2019 02:03:43 +0200 Subject: [PATCH] Added JavaDoc --- .gitignore | 1 + doc/index.html | 76 +++++++++++++++++++++++++++++++------------ doc/index.org | 41 ++++++++++++++--------- pom.xml | 5 ++- tools/update web site | 5 +++ 5 files changed, 91 insertions(+), 37 deletions(-) diff --git a/.gitignore b/.gitignore index 78de0c3..47b3ebe 100755 --- 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 --- a/doc/index.html +++ b/doc/index.html @@ -2,14 +2,14 @@ Svjatoslav Commons - Java library of commonly used functions - + - - -" + + + -- 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: -#+HTML_HEAD: -#+HTML_HEAD: " -#+HTML_HEAD: +** 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 --- a/pom.xml +++ b/pom.xml @@ -51,7 +51,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 2.9 + 3.0.1 attach-javadocs @@ -60,6 +60,9 @@ + + ${java.home}/bin/javadoc + diff --git a/tools/update web site b/tools/update web site index ddc6eaa..cdc02ae 100755 --- 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 -- 2.20.1