From 968fe6fc2df43441dca03d50d9fbc0cf41c746b4 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Sat, 19 Jan 2019 01:25:10 +0200 Subject: [PATCH] Added JavaDoc to web site --- .gitignore | 1 + doc/index.html | 17 +++++++++++++---- doc/index.org | 11 ++++++++--- pom.xml | 5 ++++- tools/update web site | 4 ++++ 5 files changed, 30 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index cfc264a..16b071f 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ /.project /.settings/ /doc/graphs/ +/doc/apidocs/ /*.iml \ No newline at end of file diff --git a/doc/index.html b/doc/index.html index 813ea56..c777c9d 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ Sixth 3D - 3D engine - + @@ -211,6 +211,9 @@ git clone https://www2.svjatoslav.eu/git/sixth-3d.git
  • Download latest snapshot in TAR GZ format
    • +
  • See JavaDoc. +
    • +
  • This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the @@ -323,10 +326,16 @@ operating systems.
    -

    2 TODO API documentation

    +

    2 API documentation

    + +

    -Documentation currently missing for the lack of time. +Note: due to a lack of time, there is still big room for improvement +on documentation.

    @@ -471,7 +480,7 @@ becomes visible.

    Author: Svjatoslav Agejenko

    -

    Created: 2019-01-19 Sat 00:51

    +

    Created: 2019-01-19 Sat 01:21

    Emacs 26.1 (Org-mode 9.1.9)

    diff --git a/doc/index.org b/doc/index.org index b71817e..904739d 100644 --- a/doc/index.org +++ b/doc/index.org @@ -8,7 +8,9 @@ - [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]] -+ This program is free software: you can redistribute it and/or modify +- See [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]]. + +- 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. @@ -80,8 +82,11 @@ pixel. - As a result it is easy to run on various hardware platforms and operating systems. -* TODO API documentation -Documentation currently missing for the lack of time. +* API documentation +- See [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]]. + +Note: due to a lack of time, there is still big room for improvement +on documentation. So far best resource is to download and explore source code for: + 3D engine ([[https://www3.svjatoslav.eu/projects/sixth-3d/graphs/][generated code graphs]] (generated using [[https://www3.svjatoslav.eu/projects/javainspect/][JavaInspect]])) diff --git a/pom.xml b/pom.xml index ea9c5e6..e633d71 100644 --- a/pom.xml +++ b/pom.xml @@ -64,7 +64,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 2.9 + 3.0.1 attach-javadocs @@ -73,6 +73,9 @@ + + ${java.home}/bin/javadoc + diff --git a/tools/update web site b/tools/update web site index c210d82..f4ff6e0 100755 --- a/tools/update web site +++ b/tools/update web site @@ -14,6 +14,10 @@ javainspect -j target/sixth-3d-*-SNAPSHOT.jar -d doc/graphs/ -n "raster engine" meviz index -w doc/graphs/ -t "Sixth 3D classes" + +rm -rf doc/apidocs/ +cp -r target/apidocs/ doc/ + rsync -avz --delete -e 'ssh -p 10006' doc/ n0@www3.svjatoslav.eu:/mnt/big/projects/sixth-3d/ echo "" -- 2.20.1