+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
the developing programmer is planning to do next. I think
taking the @ off the TODO makes sense.
-Original Message-
From: Jeremias Maerki [mailto:d...@jeremias-maerki.ch]
Sent: Wednesday, September 08, 2010 8:19 AM
To: fop-dev@xmlgraphics.apache.org
Subject: Re: TODO tag [was: Re: svn commit
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
On Thu, Sep 2, 2010 at 6:04 PM, Jeremias Maerki d...@jeremias-maerki.chwrote:
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
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
and then
make the change. @asf.todo is specific enough that we could have
changed it at any time. That said, Glenn's change was also made
without a discussion. My javadoc does not complain about the @todo
tag, and I had not understood that this was a motivation.
The javadoc documentation (of my sun
not complain about the @todo
tag, and I had not understood that this was a motivation.
The javadoc documentation (of my sun-java6-jdk) is not clear about
this topic, and uses @todo liberally in its section about the -tag
option. Its most informative paragraph is this:
Avoiding Conflicts
It would indeed have been better to first have a discussion and then
make the change. @asf.todo is specific enough that we could have
changed it at any time. That said, Glenn's change was also made
without a discussion. My javadoc does not complain about the @todo
tag, and I had not understood
