Re: PDFBox 2.0 and documentation

2015-03-27 Thread John Hewson
> On 24 Mar 2015, at 11:44, Maruan Sahyoun wrote: > > Hi John, > >> Am 24.03.2015 um 19:25 schrieb John Hewson : >> >> >>> On 19 Mar 2015, at 02:49, Maruan Sahyoun wrote: >>> >>> I'm about to start to enhance the documentation for PDFBox 2.0.0 with the >>> initial step to enhance the java

Re: PDFBox 2.0 and documentation

2015-03-24 Thread Maruan Sahyoun
Hi John, > Am 24.03.2015 um 19:25 schrieb John Hewson : > > >> On 19 Mar 2015, at 02:49, Maruan Sahyoun wrote: >> >> 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). >> >> C

Re: PDFBox 2.0 and documentation

2015-03-24 Thread John Hewson
> On 19 Mar 2015, at 02:49, Maruan Sahyoun wrote: > > 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 retu

Re: PDFBox 2.0 and documentation

2015-03-19 Thread Maruan Sahyoun
> Am 19.03.2015 um 18:37 schrieb Tilman Hausherr : > > John once mentioned that "Returns xxx" is legit according to an Oracle java > style guide. My own IDE (which is developed by Oracle) brings out a warning. > > http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@re

Re: PDFBox 2.0 and documentation

2015-03-19 Thread Andreas Lehmkuehler
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

Re: PDFBox 2.0 and documentation

2015-03-19 Thread Tilman Hausherr
John once mentioned that "Returns xxx" is legit according to an Oracle java style guide. My own IDE (which is developed by Oracle) brings out a warning. http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@return Tilman Am 19.03.2015 um 10:49 schrieb Maruan Sahyoun:

PDFBox 2.0 and documentation

2015-03-19 Thread 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 alwa