arrow-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jacques Nadeau <jacq...@apache.org>
Subject Re: [Discuss][Java] Check-style rules for methods
Date Tue, 07 May 2019 01:41:22 GMT
Per my comments on PR, I'm fine as well.

On Tue, May 7, 2019 at 12:29 AM Bryan Cutler <cutlerb@gmail.com> wrote:

> I'm fine with not requiring param/return tags for now. It will be great to
> enforce just having a javadoc and I think a good description is usually
> enough.
>
> Bryan
>
> On Sun, May 5, 2019 at 3:49 PM Micah Kornfield <emkornfield@gmail.com>
> wrote:
>
> > I've submitted a pull request [1] that enables the javadoc method check
> > style rules and added missing javadocs where the rule was failing.
> >
> > Jacques pointed out that that we might want to tweak the existing check
> > style rules.
> >
> > The current configuration ignores anything in a test directory, with
> > an @Override annotation, main methods and methods with a less then 2
> lines
> > of code.  It does not require @param, @throws or @return tags.  I've
> pasted
> > the exact configuration below.  The complete set of configuration
> > possibilities is documented in the check-style documentation [2].
> >
> > Personally, I'm happy with the current settings because I think a lot of
> > value can be derived from method javadoc without having the additional
> > tags, which can often times be redundant.
> >
> > What do others thing?
> >
> > Thanks,
> > Micah
> >
> > [1] https://github.com/apache/arrow/pull/4243
> > [2] http://checkstyle.sourceforge.net/config_javadoc.html
> >
> > The exact XML is:
> >
> > <module name="JavadocMethod">
> >     <property name="scope" value="public"/>
> >     <property name="allowMissingParamTags" value="true"/>
> >     <property name="allowMissingThrowsTags" value="true"/>
> >     <property name="allowMissingReturnTag" value="true"/>
> >     <property name="minLineCount" value="2"/>
> >     <property name="allowedAnnotations" value="Override, Test"/>
> >     <property name="allowThrowsTagsForSubclasses" value="true"/>
> >     <property name="ignoreMethodNamesRegex" value="main"/>
> > </module>
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message