GNOME Bugzilla – Bug 720049
Parse issue when using @interface in Markdown style verbatim or code blocks
Last modified: 2018-07-30 10:56:34 UTC
In order to parse this following file: http://jasperblues.github.io/Typhoon/api/interface_typhoon_factory_provider.html . . I had to escape the '@', '<', and '>' characters. There is a minor problem remaining, in that the '\' character is appearing in the code snippets. Also, it would be good if Doxygen could fail/warn more loudly if it encounters a header with these characters. . the current behavior is it just strips out the doc.
The problem is that you used markdown-indentation to create the code blocks and not @code..@endcode or @snippet. Doxygen first searches for structural commands (like @interface, which is also a doxygen command) before it applies the markdown formatting. You can argue this is a bug in doxygen (so I'll leave this bug report open), but I would still recommend to use @code..@endcode so you don't need to escape and also get syntax highlighting and hyperlinks in your code snippets.
If you think it's appropriate to leave the error open, then ok. However, I think it was mostly a user error. I'm happy as long as I can get my snippets in, and @code / @endcode will work nicely. . (didn't see these). I was also looking at creating an examples directory and using @include. Thanks for very kindly providing your time to help me resolve this.
w00t! That fixed it. It even has color coding now.
Good to hear. I've update the title to better reflect the remaining issue.
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!