Re: problem with backslash in markdown

Hi,

Thanks for the suggestion. Yes that works, but the same readme file
is also used by e.g. the web page of the git repository. This web
page only understands markdown, not doxygen commands.

My solution in the end was to rename the example scripts. I still
think this is somehow incorrect behaviour by doxygen though.

Cheers,

Yngve

On 24/11/15 20:05, Albert wrote:

Yngve,

When there is is no objection to using normal doxygen
commands you could use \code and \endcond or \verbatim
\endverbatim

Albert

On Tue, Nov 24, 2015 at 12:05 PM, Yngve
Inntjore Levinsen <[email protected] >
wrote:

Hi all,

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):

# MyCode Version 1.0.0

## INSTALLATION INSTRUCTIONS

The compiling is based on CMake. To build the
executables, run

```

mkdir build

cd build

cmake ..

make

```

## EXAMPLES

Run examples by typing:

```

build\mycode examples\example1.in

```

and

```

build\mycode examples\example2.in

```

Some other information...

The trouble here I suspect, is that \example <file>
is a command in Doxygen . 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.

Could someone perhaps help me explain what I do wrong?

Cheers,

Yngve

------------------------------------------------------------------------------

Go from Idea to Many App Stores Faster with Intel(R) XDK

Give your users amazing mobile app experiences with Intel(R)
XDK.

Use one codebase in this all-in-one HTML5 development
environment.

Design, debug & build mobile apps & 2D/3D
high-impact games for multiple OSs.

http://pubads.g.doubleclick.net/gampad/clk?id=254741551&iu=/4140

_______________________________________________

Doxygen-users mailing list

[email protected]

https://lists.sourceforge.net/lists/listinfo/doxygen-users

------------------------------------------------------------------------------
Go from Idea to Many App Stores Faster with Intel(R) XDK
Give your users amazing mobile app experiences with Intel(R) XDK.
Use one codebase in this all-in-one HTML5 development environment.
Design, debug & build mobile apps & 2D/3D high-impact games for multiple OSs.
http://pubads.g.doubleclick.net/gampad/clk?id=254741551&iu=/4140

_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users