After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 746419 - \todo at end of C# XML comment breaks following todo's
\todo at end of C# XML comment breaks following todo's
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: general
1.8.9.1
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
: 780174 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2015-03-18 20:47 UTC by Arthur Ward
Modified: 2018-07-30 10:33 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Example C# file with a working and broken \todo command. (301 bytes, text/plain)
2015-03-18 20:47 UTC, Arthur Ward
Details
Input, config, stdout & stderr from run, and output showing bug. (112.28 KB, application/zip)
2015-04-27 14:08 UTC, Arthur Ward
Details
minimal working example (3.74 KB, application/x-zip-compressed)
2018-05-16 10:36 UTC, Clemens
Details

Description Arthur Ward 2015-03-18 20:47:40 UTC
Created attachment 299764 [details]
Example C# file with a working and broken \todo command.

When using C# XML documentation comments, the \todo command must be followed by a blank comment line. Otherwise, each of the remaining todo's in the code base will cause the following to be output by Doxygen, and the formatting of the remaining todo's on the todo page is lost:

ASSERT: "0" in ..\src\docparser.cpp (5666)
todo:2: warning: Unexpected tag <dd> found
Comment 1 Dimitri van Heesch 2015-04-26 10:49:02 UTC
Hi Arthur,

I didn't manage to trigger the assert or the warning while running doxygen-1.8.9.1 on your example using a default configuration file. 

Can you please attach a more complete example (source + config file in a zip or tar) for which you verified it triggers the problem?
Comment 2 Arthur Ward 2015-04-27 14:08:18 UTC
Created attachment 302444 [details]
Input, config, stdout & stderr from run, and output showing bug.

Sorry, I didn't realize it wasn't exactly the default config. I've included the result of "doxygen > build.log 2>&1" as well so you can see what happens for me. Thanks for looking in to this!
Comment 3 Clemens 2018-05-16 10:36:30 UTC
Created attachment 372119 [details]
minimal working example
Comment 4 Clemens 2018-05-16 10:43:47 UTC
Hello

With Doxygen 1.8.14 I have the same issue with the \todo command being used inside C# XML comments.

Warnings are generated inside the log-file:
  "warning:Unexpected tag dd found"

Except the warning, the problem is that the HTML output of the TODO list (at "related pages") is damaged. 

Note that technically the TODO list is made from a HTML "description list" which may explain the mysterious warning about the <dd> tag. 

I have attached a minimal working example.

I can confirm that entering a empty comment line after the \todo mysteriously improve the situation. 
In my example code entering an empty comment line between line 38 and 39 is kind of work around.

My suspicion is that Doxygen misses to "close" the \todo block at the moment when the </remarks> end-tag appears. 

best regards
Clemens
Comment 5 albert 2018-05-16 17:13:09 UTC
I've just pushed a proposed patch to github (pull request 728, https://github.com/doxygen/doxygen/pull/728).
Comment 6 albert 2018-05-16 17:31:38 UTC
*** Bug 780174 has been marked as a duplicate of this bug. ***
Comment 7 André Klapper 2018-07-30 10:33:05 UTC
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to 

   https://github.com/doxygen/doxygen/issues

All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github.

Hence I am closing this GNOME Bugzilla ticket.
Please use the corresponding ticket in Github instead. Thanks a lot!