You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2014/12/17 18:24:22 UTC
[48/50] [abbrv] incubator-brooklyn git commit: build apidocs with
javadoc not groovydoc
build apidocs with javadoc not groovydoc
all the main classes are java not groovy,
so there is no need to use groovydoc (which required a painful specific version of groovy).
the classes are approx the same, except we now exclude com/acme samples and other non-brooklyn things.
the html looks nicer however.
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/ebe00022
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/ebe00022
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/ebe00022
Branch: refs/heads/master
Commit: ebe000221cc4a28ccdae6e4d83d49fdd440abd84
Parents: 19901b8
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Wed Dec 17 16:02:36 2014 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Wed Dec 17 16:07:41 2014 +0000
----------------------------------------------------------------------
docs/_build/build.sh | 1 -
docs/_build/make-javadoc.sh | 57 ++++++++++--------------------
docs/_build/quick-make-few-javadoc.sh | 2 +-
3 files changed, 20 insertions(+), 40 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ebe00022/docs/_build/build.sh
----------------------------------------------------------------------
diff --git a/docs/_build/build.sh b/docs/_build/build.sh
index 8147c70..097ebe6 100755
--- a/docs/_build/build.sh
+++ b/docs/_build/build.sh
@@ -172,7 +172,6 @@ function make_javadoc() {
echo "ERROR: javadoc target directory $JAVADOC_TARGET gone; is there a jekyll already watching?"
return 1
fi
- echo mv _build/target/apidocs/* $JAVADOC_TARGET
mv _build/target/apidocs/* $JAVADOC_TARGET
fi
}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ebe00022/docs/_build/make-javadoc.sh
----------------------------------------------------------------------
diff --git a/docs/_build/make-javadoc.sh b/docs/_build/make-javadoc.sh
index 6e9dd27..d7f862c 100755
--- a/docs/_build/make-javadoc.sh
+++ b/docs/_build/make-javadoc.sh
@@ -5,22 +5,9 @@ if [ ! -x make-javadoc.sh ]; then
exit 1
fi
-if [ -z "$GROOVY_CMD" ] ; then
- if [ ! -z "$GROOVY_HOME" ] ; then
- GROOVY_CMD=$GROOVY_HOME/bin/groovysh
- else
- GROOVY_CMD=`which groovysh`
- fi
-fi
-
-if [ ! -x "$GROOVY_CMD" ] ; then
- echo groovy executable must be available on the path or in \$GROOVY_HOME/bin
- exit 1
-fi
-
if [ -z "$BROOKLYN_JAVADOC_SOURCE_PATHS" ]; then
echo detecting source paths for javadoc
- export SOURCE_PATHS=`find ../.. -name java | grep "src/main/java$" | grep -v web-console/plugins | grep -v "^../../sandbox"`
+ export SOURCE_PATHS=`find ../.. -name java | grep "src/main/java$" | grep -v "^../../sandbox" | tr "\\n" ":"`
else
echo using pre-defined source paths $BROOKLYN_JAVADOC_SOURCE_PATHS
export SOURCE_PATHS=$BROOKLYN_JAVADOC_SOURCE_PATHS
@@ -32,32 +19,26 @@ export DATESTAMP=`date "+%Y-%m-%d"`
echo "building javadoc at $DATESTAMP from:
$SOURCE_PATHS"
-
-$GROOVY_CMD -q << END
-sourcePaths = System.env['SOURCE_PATHS'].split('\\\\s+').join(':')
-title = "Brooklyn"
-ant = new AntBuilder()
-ant.taskdef(name: "groovydoc", classname: "org.codehaus.groovy.ant.Groovydoc")
-ant.groovydoc(
- destdir : "target/apidocs/",
- sourcepath : "\${sourcePaths}",
- packagenames : "**.*",
- use : "true",
- windowtitle : "\${title}",
- doctitle : "\${title}",
- header : "\${title}",
- footer : '<b>Apache Brooklyn - Multi-Cloud Application Management Platform</b> <br/> <a href="http://brooklyn.io/" target="_top">brooklyn.io</a>. Apache License. © '+System.env['DATESTAMP']+'.',
- private : "false")
-println "\njavadoc built in target/apidocs\n"
-END
-
-if (($!)) ; then echo ; echo ; echo "Groovy docs had an error." ; exit 1 ; fi
+javadoc -sourcepath $SOURCE_PATHS \
+ -public \
+ -d target/apidocs/ \
+ -subpackages "org.apache.brooklyn:io.brooklyn:brooklyn" \
+ -classpath ../../usage/all/target/brooklyn-all-0.7.0-SNAPSHOT-with-dependencies.jar \
+ -doctitle "Apache Brooklyn" \
+ -windowtitle "Apache Brooklyn" \
+ -header "Apache Brooklyn" \
+ -footer '<b>Apache Brooklyn - Multi-Cloud Application Management</b> <br/> <a href="http://brooklyn.io/" target="_top">brooklyn.io</a>. Apache License. © '$DATESTAMP'.' \
+ | tee target/javadoc.log
+
+if ((${PIPESTATUS[0]})) ; then echo ; echo ; echo "ERROR: javadoc process exited non-zero" ; exit 1 ; fi
echo ; echo
-if [ -z 'ls target/apidocs' ]; then echo ; echo ; echo "Error - no content. Are the paths right?" ; exit 1 ; fi
+if [ ! -f target/apidocs/brooklyn/entity/Entity.html ]; then echo "ERROR: missing expected content. Are the paths right?" ; exit 1 ; fi
+
+if [ ! -z "`grep warnings target/javadoc.log`" ] ; then echo "WARNINGs occurred during javadoc build. See target/javadoc.log for more information." ; fi
-if [ -d ../_site/use/api/ ] ; then
- echo "API directory detected in parent, installing docs there"
- cp -r target/apidocs/* ../_site/use/api/
+if [ -d ../_site/guide/use/api/ ] ; then
+ echo "API directory detected in test structure _site, copying docs there so they can be served with serve-site.sh"
+ cp -r target/apidocs/* ../_site/guide/use/api/
fi
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ebe00022/docs/_build/quick-make-few-javadoc.sh
----------------------------------------------------------------------
diff --git a/docs/_build/quick-make-few-javadoc.sh b/docs/_build/quick-make-few-javadoc.sh
index b51e0d1..db228df 100755
--- a/docs/_build/quick-make-few-javadoc.sh
+++ b/docs/_build/quick-make-few-javadoc.sh
@@ -1,6 +1,6 @@
#!/bin/bash
-export BROOKLYN_JAVADOC_SOURCE_PATHS="../../api"
+export BROOKLYN_JAVADOC_SOURCE_PATHS="../../api/src/main/java"
echo LIMITING build to $BROOKLYN_JAVADOC_SOURCE_PATHS for speed
./make-javadoc.sh