RE: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-09-08 Thread Eric Douglas
svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline/ layoutmgr/table/] +1! On 08.09.2010 13:02:29 Vincent Hennebert wrote: > Ok, let me summarise this: > > * a @[asf.]

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-09-08 Thread Jeremias Maerki
+1! On 08.09.2010 13:02:29 Vincent Hennebert wrote: > Ok, let me summarise this: > > • a @[asf.]todo tag marginally improves the formatting of a javadoc > comment > • nobody really likes the idea of using a namespaced version of todo > (@asf.todo) > • it is possible to tweak Checkstyle and th

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-09-08 Thread Vincent Hennebert
Ok, let me summarise this: • a @[asf.]todo tag marginally improves the formatting of a javadoc comment • nobody really likes the idea of using a namespaced version of todo (@asf.todo) • it is possible to tweak Checkstyle and the javadoc command to enable the use of @todo That said: • todo s

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-09-02 Thread J.Pietschmann
On 02.09.2010 12:14, Glenn Adams wrote: also the doclet options to permit use of @todo without warnings. I could try to experiment some to see if that is feasible, then we could return to the former usage of @todo. Javadoc 1.5 or later can be passed a command line option defining additional to

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-09-02 Thread Glenn Adams
On Thu, Sep 2, 2010 at 6:04 PM, Jeremias Maerki wrote: > I'm not sure we have the tooling to make sure noone > uses @todo. > Actually, checkstyle 5.1 will report warnings for any use of a non-standard tag that is not qualified with a dotted prefix. Also the standard Doclet in recent JDKs will com

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-09-02 Thread Jeremias Maerki
Just to add my 0.05 CHF: I normally use @todo when adding TODOs as part of a method or class comment and I use //TODO inline. That's because plain "TODO" lets the full text bleed into the Javadocs which is certainly something we don't want. See for example: org.apache.fop.area.DestinationData.resol

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-08-31 Thread Glenn Adams
I don't have a strong opinion on whether to keep the @asf.todo or TODO. My main interest was removing the javadocs warnings produced (under jdk1.6 doclet) through the former use of @todo. My point in bringing it up was to request that we discuss beforehand prospective changes that back-out or reve

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-08-31 Thread Vincent Hennebert
Hi, I just thought I would homogenize our usage of todo tags and match what seems to be the de facto standard (“TODO”) among current committers. Most @todo indeed come from very old commits. I didn’t realise that javadoc could do something with them, which is why that looked to me like a minor cha

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-08-28 Thread Glenn Adams
by way of an amusing anecdote on this point, when I was managing the Unix servers at the MIT AI Lab in the mid 80's I got in a bit of a contest with RMS (richard stallman) about his liberal sharing of his login credentials with literally *anyone* that asked; one day i found about 100 incoming FTP s

Re: TODO tag [was: Re: svn commit: r990148 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop: area/ fo/ fo/flow/ fo/flow/table/ fo/pagination/ fo/properties/ hyphenation/ layoutmgr/ layoutmgr/inline

2010-08-28 Thread Glenn Adams
for what it's worth, i don't have a strong opinion on this issue (i.e., whether to use @asf.todo or TODO); i explained below why i made the original change, and, yes, it was not discussed at the time; the point i was making below, which you echo, is that is indeed better to first discuss a change