Agree With Dan...

-Anil.


On Mon, Feb 1, 2016 at 10:20 AM, Dan Smith <[email protected]> wrote:

> For GEODE-518, I think we should just generate javadocs for the public API
> and not worry about the internal classes right now. That might make this a
> lot easier if we do that fix.
>
> -Dan
>
> On Mon, Feb 1, 2016 at 9:26 AM, Kirk Lund <[email protected]> wrote:
>
> > When I remove this line:
> >
> > diff --git a/build.gradle b/build.gradle
> > index 13afa17..c2c5e40 100755
> > --- a/build.gradle
> > +++ b/build.gradle
> > @@ -312,7 +312,6 @@ subprojects {
> >    javadoc.classpath += configurations.provided
> >
> >    javadoc {
> > -    options.addStringOption('Xdoclint:none', '-quiet')
> >      options.encoding='UTF-8'
> >    }
> >
> > The result is a lot more javadoc warnings including missing @ tags
> > self-closing html elements. This seems to be overly restrictive and would
> > require a LOT more work than the 100s of broken tags that I already fixed
> > on feature/GEODE-805:
> >
> >
> >
> C:\dev\geode\gemfire-web-api\src\main\java\com\gemstone\gemfire\rest\internal\web\controllers\PdxBasedCrudController.java:226:
> > warning: no @param for ignoreMissingKey
> >   public ResponseEntity<?> read(
> >                            ^
> >
> >
> C:\dev\geode\gemfire-web-api\src\main\java\com\gemstone\gemfire\rest\internal\web\controllers\PdxBasedCrudController.java:49:
> > error: self-closing element not allowed
> >  * <p/>
> >    ^
> >
> >
> C:\dev\geode\gemfire-web-api\src\main\java\com\gemstone\gemfire\rest\internal\web\controllers\QueryAccessController.java:81:
> > error: self-closing element not allowed
> >    * <p/>
> >
> > Is there a build.gradle change that would turn the warnings on develop
> into
> > errors without increasing the restrictions even further?
> >
> > Thanks,
> > Kirk
> >
> >
> > On Thu, Jan 28, 2016 at 12:54 PM, Kirk Lund <[email protected]> wrote:
> >
> > > Thanks Nitin! I'm going to go ahead and fix all of the warnings and
> > > re-enable strict checking.
> > >
> > > If anyone else has already started this, please let me know.
> > >
> > > -Kirk
> > >
> > >
> > > On Thu, Jan 28, 2016 at 11:10 AM, Nitin Lamba <[email protected]> wrote:
> > >
> > > > Yes, there is.
> > > >
> > > > To re-enable strict javadoc checking in JDK8, you can remove this
> > command
> > > > line option present in build.gradle today:
> > > >
> > > >   javadoc {
> > > >     options.addStringOption('Xdoclint:none', '-quiet')
> > > >   }
> > > >
> > > > Once it is removed, the build will fail. Last checked, it was
> > generating
> > > > more than 100 errors!
> > > >
> > > > Nitin
> > > >
> > > > ________________________________________
> > > > From: Kirk Lund <[email protected]>
> > > > Sent: Thursday, January 28, 2016 10:58 AM
> > > > To: [email protected]
> > > > Subject: Broken javadocs
> > > >
> > > > The build reports lots of broken javadocs. After fixing them, is
> there
> > a
> > > > way (in gradle) to turn the warnings into errors that fail the
> build? I
> > > > would hate to go to all the effort of fixing these warnings and then
> > see
> > > > people checkin more broken javadocs after that.
> > > >
> > > > Thanks,
> > > > Kirk
> > > >
> > >
> >
>

Reply via email to