projects / sixth-3d.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 916ecef)
Added JavaDoc to web site
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Fri, 18 Jan 2019 23:25:10 +0000 (01:25 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Fri, 18 Jan 2019 23:25:10 +0000 (01:25 +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 cfc264a..16b071f 100644 (file)
--- 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 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <title>Sixth 3D - 3D engine</title>
-<!-- 2019-01-19 Sat 00:51 -->
+<!-- 2019-01-19 Sat 01:21 -->
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="Org-mode">
@@ -211,6 +211,9 @@ git clone https://www2.svjatoslav.eu/git/sixth-3d.git
 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
 </li>
 
+<li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
+</li>
+
 <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
@@ -323,10 +326,16 @@ operating systems.
 </div>
 
 <div id="outline-container-sec-2" class="outline-2">
-<h2 id="sec-2"><span class="section-number-2">2</span> <span class="label label-primary TODO">TODO</span> API documentation</h2>
+<h2 id="sec-2"><span class="section-number-2">2</span> API documentation</h2>
 <div class="outline-text-2" id="text-2">
+<ul class="org-ul">
+<li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
+</li>
+</ul>
+
 <p>
-Documentation currently missing for the lack of time.
+Note: due to a lack of time, there is still big room for improvement
+on documentation.
 </p>
 
 <p>
@@ -471,7 +480,7 @@ becomes visible.
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2019-01-19 Sat 00:51</p>
+<p class="date">Created: 2019-01-19 Sat 01:21</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 b71817e..904739d 100644 (file)
--- 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 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -64,7 +64,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>
@@ -73,6 +73,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 c210d82..f4ff6e0 100755 (executable)
--- 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 ""
Unnamed repository; edit this file 'description' to name the repository.