Re: [Doxygen-users] Hard to find errors
Brought to you by:
dimitri
|
From: Ger v. D. <di...@as...> - 2009-12-04 15:36:42
|
After some more digging with a colleague I found why it was giving that warning.
I used JAVADOC_AUTOBRIEF=YES, so the first sentence (until the dot) was handled as the brief comment.
Cheers,
Ger
>>> On Fri, Dec 4, 2009 at 4:06 PM, in message <4B1...@as...>,
"Ger van Diepen" <di...@as...> wrote:
> Hi Paul,
>
> I found that doxygen (1.5.7) has problems with a dot in an em block.
> E.g. the following gives the errors:
>
> /Users/diepen/casacore-old/doxyproblem.hh:13: Warning: end of comment block
> while expecting command </em>
> /Users/diepen/casacore-old/doxyproblem.hh:13: Warning: end of comment block
> while expecting command </em>
> /Users/diepen/casacore-old/doxyproblem.hh:12: Warning: found </em> tag without
> matching <em>
>
> while it is fine when removing the dot. The same seems to be the case for
> <tt>.
> I've reported it on April 11th 2008, but got no reply.
>
> Cheers,
> Ger
>
>
> #ifndef CASA_QUANTUM_H
> #define CASA_QUANTUM_H
>
> namespace casa { //# NAMESPACE CASA - BEGIN
>
> /** \ingroup Quantum
> \brief
> Quantities (i.e. dimensioned values)
> */
> template <class Qtype> class Quantum {
> public:
> /** <em> The dot at the end gives em problems. </em>
> */
> static Bool read(Quantity &res, MUString &in);
> };
> } //# NAMESPACE CASA - END
>
>
>
>>>> On Fri, Dec 4, 2009 at 3:49 PM, in message
> <125...@im...>, Paul Floyd <pa...@fr...> wrote:
>> Hi
>>
>> With Doxygen 1.6.1 I have a couple of errors that look like
>>
>> <unknown>:0: Warning: end of comment block while expecting command </em>
>> (twice)
>>
>> and
>>
>> <adms_checkpoint>:1: Warning: argument 'exec' of command @param is not found
>> in
>> the argument list of adms_checkpoint(char *filename, howT how)
>> (many times, with other arguments)
>>
>> Till now I've usually found that such errors are due to "stray" comments
>> that
>> predated our use of Doxygen and just happened to match some markup patterns.
>> Finding them is usually somewhat empirical, trying to remove anything in or
>> around the files (or files containing the functions) until the error goes
>> away.
>> However, these two have now been around for a few months (our code base is
>> over
>> a million LOC, and I only run Doxygen twice a week).
>>
>> Does anyone have any ideas as to how I could track down these errors?
>>
>> A+
>> Paul
>
>
> ------------------------------------------------------------------------------
> Join us December 9, 2009 for the Red Hat Virtual Experience,
> a free event focused on virtualization and cloud computing.
> Attend in-depth sessions from your desk. Your couch. Anywhere.
> http://p.sf.net/sfu/redhat-sfdev2dev
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
|