opencensus-java icon indicating copy to clipboard operation
opencensus-java copied to clipboard

Consider changing the Javadoc policy to allow omitting unnecessary param and return tags.

Open sebright2 opened this issue 8 years ago • 1 comments

This is related to the discussion in https://github.com/census-instrumentation/opencensus-java/pull/485#discussion_r130210392. Javadocs written with the current style (https://github.com/census-instrumentation/opencensus-java/blob/master/CONTRIBUTING.md#javadoc) can sometimes clutter the documentation and hide the most relevant points.

sebright2 avatar Aug 08 '17 20:08 sebright2

Thanks for raising this. You captured my concern succinctly!

codefromthecrypt avatar Aug 09 '17 00:08 codefromthecrypt