+1 to suppress such warnings globally. IMO, usually, meaningful Javadoc description is quite enough to understand what this method does.
> On 1 Apr 2019, at 18:21, Kenneth Knowles <k...@apache.org> wrote: > > Personally, I would like to suppress the warnings globally. I think requiring > javadoc everywhere is already enough to remind someone to write something > meaningful. And I think @param rarely adds anything beyond the function > signature and @return rarely adds anything beyond the description. > > Kenn > > On Mon, Apr 1, 2019 at 6:53 AM Michael Luckey <adude3...@gmail.com > <mailto:adude3...@gmail.com>> wrote: > Hi, > > currently our console output gets cluttered by thousands of Javadoc warnings > [1]. Most of them are warnings caused by missinlng @return or @param tags > [2]. > > So currently, this signal is completely ignored, and even worse, makes it > difficult to parse through the log. > > As I could not find a previous discussion on the list on how to handle > param/return on java docs, I felt the need to ask here first, how we would > like to improve this situation. > > Some options > 1. fix those warnings > 2. do not insist on those tags being present and disable doclint warnings > (probably not doable on tag granularity). This is already done on doc > aggregation task [3] > > Thoughts? > > > [1] https://builds.apache.org/job/beam_PreCommit_Java_Cron/1131/console > <https://builds.apache.org/job/beam_PreCommit_Java_Cron/1131/console> > [2] https://builds.apache.org/job/beam_PreCommit_Java_Cron/1131/java/ > <https://builds.apache.org/job/beam_PreCommit_Java_Cron/1131/java/> > [3] > https://github.com/apache/beam/blob/master/sdks/java/javadoc/build.gradle#L77-L78 > > <https://github.com/apache/beam/blob/master/sdks/java/javadoc/build.gradle#L77-L78> >
