[Doxygen-users] problem with backslash in markdown
Brought to you by:
dimitri
From: Yngve I. L. <yng...@es...> - 2015-11-24 11:05:47
|
<html> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8"> </head> <body bgcolor="#FFFFFF" text="#000000"> Hi all,<br> <br> I am having an issue with backslash in markdown file which I am starting to wonder if is a bug. My README.md which I want to include as front page looks like this (simplified to make it clear):<br> <br> <blockquote type="cite"># MyCode Version 1.0.0<br> <br> <br> ## INSTALLATION INSTRUCTIONS<br> <br> The compiling is based on CMake. To build the executables, run<br> ```<br> mkdir build<br> cd build<br> cmake ..<br> make<br> ```<br> <br> ## EXAMPLES<br> <br> <br> Run examples by typing:<br> ```<br> build\mycode examples\example1.in<br> ```<br> and<br> ```<br> build\mycode examples\example2.in<br> ```<br> <br> Some other information...</blockquote> <br> The trouble here I suspect, is that \example <file> is a <a href="http://www.stack.nl/%7Edimitri/doxygen/manual/commands.html#cmdexample">command in Doxygen</a>. Doxygen thinks I want to include files 1.in and 2.in as examples (?). I should escape this by using \\ if I understand correctly. This does work in markdown if I do it outside the 'code-block', but inside the code block I then see two backslash also in the generated output. I tried to find a way to globally ignore backslash in doxygen (and only rely on @), but I could not find that.<br> <br> Could someone perhaps help me explain what I do wrong?<br> <br> Cheers,<br> Yngve<br> <br> </body> </html> |