2016-01-08 20:00 GMT+01:00 Konstantin Kolinko <knst.koli...@gmail.com>:
> /** > - * Return the member that represents this node. > - * > - * @return Member > + * @return the member that represents this node. > */ > public Member getLocalMember(); > > /** > - * Return response status code that is used to reject denied request. > + * @return response status code that is used to reject denied request. > */ > > > The first sentence of description of a method goes into summary - into > the table that lists class methods. > > E.g.: > > http://tomcat.apache.org/tomcat-8.0-doc/api/org/apache/catalina/filters/RequestFilter.html#method_summary > > If everything is moved into @return tag, the method summary becomes > empty and that table would list just the method names. > > I think that a simple > @return Member > @return Member or null > @return Boolean > @return value > will fix the javadoc tool warning and is better than moving all method > description into @return tag. > > This was done like that elsewhere and I like it. Rémy
