[Hawkular-dev] Checkstyle javadoc settings

Gary Brown gbrown at redhat.com
Tue Feb 3 13:19:50 EST 2015


It checks presence of javadoc, and matching entries for parameters and return values.

----- Original Message -----
> Does this just look to see if all public methods have SOME javadoc? (i.e. it
> just sees if they are missing)
> 
> Does it impose some type of formatting as well?
> 
> ----- Original Message -----
> > Hi
> > 
> > Just started using the hawkular parent pom and noticed that the checkstyle
> > config does not check the javadoc comments.
> > 
> > Not sure if this was previously discussed and decided that it shouldn't be
> > checked, but thought I had better check, as this is one area that can be
> > time consuming to update code after enabling.
> > 
> > Previously I had been using this config in Overlord:
> > https://github.com/Governance/overlord-commons/blob/master/overlord-commons-build/src/main/resources/checkstyle/checkstyle.xml#L83-L97
> > 
> > Regards
> > Gary
> > _______________________________________________
> > hawkular-dev mailing list
> > hawkular-dev at lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/hawkular-dev
> > 
> _______________________________________________
> hawkular-dev mailing list
> hawkular-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hawkular-dev
> 


More information about the hawkular-dev mailing list