I'm working on a .md page that describes coding style for a project;
when I place the following in the .md file, Doxygen does not behave as
expected:
~~~~~~~~
Some Doxygen syntax features require particular Doxygen configuration
settings,
or even externaltools. The following can be freely used:
- Automatic brief descriptions (`JAVADOC_AUTOBRIEF=YES`). Please
avoid using
the `@brief` tag.
- Markdown (`MARKDOWN_SUPPORT= YES`). Please avoid tags wherever
markdown is
easier to read (e.g.,use `_foo_` instead of `@e foo` for emphasis).
- (etc.)
~~~~~~~~
What I would expect:
Doxygen should not interpret any of the tags inside backtick code spans,
and instead render them verbatim in the output.
What happens:
Doxygen interprets the character sequence "@brief` tag." as specifying a
brief description for the page, and strips it from the output.
Furthermore, the code span is interpreted as still being open, messing
up all the following text.
Note that if I replace "@brief" with any other tag (or at least any I
did test), it is rendered verbatim as expected.
- Is this a known problem?
- Is there any sane workaround to get this particular tag to be rendered
verbatim as in-line code?
------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and their
applications. Written by three acclaimed leaders in the field,
this first edition is now available. Download your free book today!
http://p.sf.net/sfu/NeoTech
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
