Hi,

Am 19.03.2015 um 10:49 schrieb Maruan Sahyoun:
I'm about to start to enhance the documentation for PDFBox 2.0.0 with the 
initial step to enhance the javadoc files (also covering xmpbox, preflight, 
fontbox).

Currently we have a rule - at least in Checkstyle - that a method returning a 
non-void type should have a @return tag. That's not always the case and leads 
to violations of the rule. So shall we either

- disable the rule
- or mandate it

I'd go for mandating it as this will allow to tell that even for simple methods 
if they are really so or if there is additional complexity.
+1, we should follow our own rules. They exists for years and I don't see any good reason to change them. If we would make such docs optional people tend to not to add them even in complex cases.

Good sample IMHO for a JavaDoc coding style 
https://www.liferay.com/de/community/wiki/-/wiki/Main/Javadoc+Guidelines#section-Javadoc+Guidelines-Method+Javadoc+Tags


BR
Maruan



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@pdfbox.apache.org
For additional commands, e-mail: dev-h...@pdfbox.apache.org


BR
Andreas

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@pdfbox.apache.org
For additional commands, e-mail: dev-h...@pdfbox.apache.org

Reply via email to