The javadocs on ConfigurationProperties look fine in the html generated by gradle, but it doesn't render properly in IntelliJ (some properties have javadocs that are fine but more complex ones are broken in the IDE). I think we should prefer having javadocs that are useful both in IDEs and as html viewed in a browser, and it's fixable (Kevin just looked into this with me). However, given that it's not borked in the gradle-generated html, I'm guessing there's no way to automate detecting subtle problems like this. Anyone else know or have ideas -- like a more sophisticated 3rd party gradle plugin for javadocs?
-Kirk On Fri, Aug 12, 2016 at 5:00 PM, Kirk Lund <kl...@pivotal.io> 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 >> > >> > >
