GNOME Bugzilla – Bug 334445
\todo destroys argument list
Last modified: 2006-07-23 07:12:20 UTC
When \todo occurs inside procedure, its argument list is lost. I will also attach a source code that reproduces this problem. *********************************************************************** This output is normally emitted: Function Documentation HUDAQLIBPUBLIC void HUDAQAPI stepout ( HUDAQHANDLE handle, unsigned channel, long TargetPosition ) Move stepping motor to a target position. During a first time call it resets internal position counter and sets 2 internal counters for driving one stepper motor. Parameters: [in] handle Device handle. [in] channel number of counter (0 - 1) [in] TargetPosition Position to move stepping motor. (It is absolute position, not a difference.) *********************************************************************** This output is emitted when \todo occurs inside procedure: Function Documentation HUDAQLIBPUBLIC void HUDAQAPI stepout ( HUDAQHANDLE handle, unsigned channel, long TargetPosition ) Move stepping motor to a target position. Todo: * dodelat reset a vracet polohu!
Created attachment 61180 [details] Example code, that produces a described bug.
This a feature, not a bug. Special comments (i.e. with /// or //!) are extracted from the body of a function and added to its documentation. Use "//\todo" or "// TODO:" or something similar if this is unintended behaviour. Doxygen also has a HIDE_IN_BODY_DOCS config option, but this is broken at the moment (there is another bug reports file for that already).
Excuse me. I am sure that this is a BUG. May be that you don't understand me, that I wrote it not clean. I AM HAPPY, THAT COMMENTS FROM BODY OF FUNCTION IS EXTRACTED. BUT OTHER COMMENT IS LOST.
Please look at doxygen output differences again. This piece of documentation is permanently lost: --------------------------- Parameters: [in] handle Device handle. [in] channel number of counter (0 - 1) [in] TargetPosition Position to move stepping motor. (It is absolute position, not a difference.) ---------------------------- You are writing: "Special comments (i.e. with /// or //!) are extracted from the body of a function and added to its documentation.". This means ADDING but not cutting or shorting existing piece of documentation.
Created attachment 61945 [details] Possible Workaround Would this file be an acceptable workaround for you? You might find the commenting style in my attatchment better to use, and the /todo does not emit anything.
emit = omit, sorry :)
Unfortunatelly no. For this task I need to have full comment inside header. Duplicating a same comment seems to me also bad idea. I am using another workaround: // \todo xxxx -- it is not doxygen comment and it makes me less problem not to see bugs and todos at all.
Since the problem could not be proven by Dimitri or I, I am marking this bug as incomplete. The problem described in this bug report was apparently "argument list is lost". I could not find a way to duplicate the bug with Jaroslav's sample using the latest CVS build. If any one else finds out a way to duplicate this bug, please comment.
I could make a new test with your latest build. I could attempt to get latest snapshot, or you could send me doxygen.exe to JaFojtik@seznam.cz If a problem disappear, I close this report.
I confirm that this bug disappeared with 1.4.7. I tested it at home. I will test it at work, but I hope it will be also good. Bug 310521 Summary: HIDE_IN_BODY_DOCS no longer working http://bugzilla.gnome.org/show_bug.cgi?id=310521