Re: [Doxygen-users] Hard to find errors

[René S. <Ren...@ag...>]

forgot to post to list

René Staffen schrieb:
> 
> Paul Floyd schrieb:
>> 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)
> this one is easy.
> you dokumented a parem (with keyword @param) that does not exist
> 
> example:
> 
> good:
> /**
>  * creates a checkpoint
>  * @param filename  the filename o checkpoint
>  * @param how       what ever
>  */
> adms_checkpoint(char *filename, howT how)
> 
> 
> bad:
> /**
>  * creates a checkpoint
>  * @param anyOtherWordThanFilenameOrHow  some text
>  * @param anyOtherWordThanHowOrFilename  some text
>  */
> adms_checkpoint(char *filename, howT how)
> 
> 
>> 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
> 

-- 

Dipl.-Inf. (FH) René Staffen
Softwareentwickler
eMail: Ren...@ag...
Tel:   +49 (0)30 2000 429 332


Hella Aglaia Mobile Vision GmbH
Treskowstr. 14
D-13089 Berlin
Amtsgericht Berlin-Charlottenburg HRB 66976
Geschäftsführer: Thomas Schilling

URL:  www.aglaia-gmbh.de
URL:  www.mobilevision.de

Dieses Dokument ist vertraulich zu behandeln.
Die Weitergabe sowie Vervielfältigung, Verwertung und Mitteilung
seines Inhalts ist nur mit unserer ausdrücklichen Genehmigung gestattet.
Alle Rechte vorbehalten, insbesondere für den Fall der Schutzrechtsanmeldung.

This document has to be treated confidentially.
Its contents are not to be passed on, duplicated, exploited or disclosed
without our express permission. All rights reserved,
especially the right to apply for protective rights.