-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/
-----------------------------------------------------------
Review request for mesos and Mesos ReviewBot.
Bugs: MESOS-1259
https://issues.apache.org/jira/browse/MESOS-1259
Repository: mesos-git
Description
-------
[MESOS-1259]: Enrich the Java Docs in the src/java files.
The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
_javadoc_ task fails if there are _Classes_ which expose _public_ fields
or methods without proper _Java Documentation_. Note that by proper I am
referring to the structure that is validated by the _Javadoc Tool_.
In addition such documentation should facilitate the development of Java
based frameworks.
Diffs
-----
src/java/src/org/apache/mesos/Executor.java cacb4e9
src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
src/java/src/org/apache/mesos/Log.java d27e4f9
src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
src/java/src/org/apache/mesos/Scheduler.java 3043f60
src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
src/java/src/org/apache/mesos/state/State.java d14d79b
src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
Diff: https://reviews.apache.org/r/20807/diff/
Testing
-------
1. ./bootstrap && mkdir build && cd build && ../configure && make
2. The API Java Docs should be at build/src/java/target/apidocs
3. Open the index and navigate through the documentation. e.g. open
build/src/java/target/apidocs/index.html
. Please note that as of now the Protos.* are not available for the Javadocs
therefore we are unable to link any reference.
Thanks,
Bernardo Gomez Palacio
