Maybe the review of the Javadoc for any class should be done as part of
the final review of a story.
Any public facing classes should be checked that the javadoc is correct
for the affected classes.
That the render correctly in the IDE, I think might be a side affect of
making sure that they docs are actually checked.
--Udo
On 13/08/2016 10:00 AM, Kirk Lund wrote:
We really need to find an automated solution for discovering javadoc errors
earlier than manual inspection or looking for warnings in the gradle
output.
We change our build to fail on javadoc errors because it starts to fail due
to 3rd party library javadocs, but at a minimum there must be some
alternative for enforcing no warnings in the build.
As for ConfigurationProperties' javadocs, I don't think it's generating any
warnings but the javadocs contain malformed html so the result is clearly
broken. I'm not sure if there's anyway to automate detecting problems like
that.
-Kirk
On Fri, Aug 12, 2016 at 4:51 PM, Dan Smith <dsm...@pivotal.io> wrote:
I'm not sure if we're publishing the nightly javadocs anywhere, but you can
build them from source. If you do a ./gradlew build, the external javadocs
are in geode-assembly/build/install/apache-geode/javadoc
-Dan
On Fri, Aug 12, 2016 at 4:31 PM, Kirk Lund <kl...@pivotal.io> wrote:
I can find the following from Google, but this is the javadocs for the M2
release:
http://geode.incubator.apache.org/releases/latest/javadoc/
Does this need manual updating for M3?
Are we publishing nightly javadocs?
When I use CTRL-J (in IntelliJ) on the ConfiguratingProperties class, the
javadocs look malformed, so I'd like to review real javadoc html for the
current state of develop.
-Kirk
