Added some starter javadoc for overview and a few packages.

nagyistoce · Aug 29, 2013 · dede81a · dede81a
1 parent 6723bfe
commit dede81a
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 1 deletion.
diff --git a/build.sh b/build.sh
@@ -169,7 +169,7 @@ function build_javadoc() {
     echo "creating javadoc files..."
     local CLASSPATH="${JAR_ROOT}${SEP}${DEPENDENCIES}${SEP}${JAR_ROOT}/hadoop/${DEFAULT_HADOOP_VERSION}/*"
     mkdir -p target/logs
-    "${JAVADOC}" -classpath "${CLASSPATH}" -d "${OUTDIR}"/javadoc -sourcepath "${SRC}" -subpackages hex:water >& target/logs/javadoc_build.log
+    "${JAVADOC}" -overview ${SRC}/overview.html -classpath "${CLASSPATH}" -d "${OUTDIR}"/javadoc -sourcepath "${SRC}" -subpackages hex:water >& target/logs/javadoc_build.log
 }
 
 function build_package() {
@@ -182,6 +182,10 @@ function junit() {
     "$JAVA" -ea -cp ${JAR_FILE} water.Boot -mainClass water.JUnitRunner
 }
 
+if [ "$1" = "onlydoc" ]; then
+    build_javadoc
+    exit 0
+fi
 if [ "$1" = "noclean" ]; then
     shift
 else

diff --git a/src/main/java/hex/gbm/package.html b/src/main/java/hex/gbm/package.html
@@ -0,0 +1,5 @@
+<body>
+
+Gradient Boosting Machine.
+
+</body>
diff --git a/src/main/java/hex/package.html b/src/main/java/hex/package.html
@@ -0,0 +1,5 @@
+<body>
+
+The hex package contains math and machine learning algorithms for H2O.
+
+</body>
diff --git a/src/main/java/hex/rf/package.html b/src/main/java/hex/rf/package.html
@@ -0,0 +1,5 @@
+<body>
+
+Random Forest.
+
+</body>
diff --git a/src/main/java/hex/rng/package.html b/src/main/java/hex/rng/package.html
@@ -0,0 +1,5 @@
+<body>
+
+Random number generators.
+
+</body>
diff --git a/src/main/java/overview.html b/src/main/java/overview.html
@@ -0,0 +1,13 @@
+<body>
+
+H2O is the open source math and prediction engine for Big Data Science.
+
+The main two package groups are "water" and "hex".
+
+The water package contains the implementation of H2O's core, including
+the distributed key value store, parsing, and I/O.
+
+The hex package conceptually layers on top of the water package, and
+contains math and machine learning algorithms.
+
+</body>
diff --git a/src/main/java/water/package.html b/src/main/java/water/package.html
@@ -0,0 +1,5 @@
+<body>
+
+The water package contains the implementation of H2O's core.
+
+</body>