[PATCH 1/4] doc: use markdown tildes for code blocks

[Peter Hutterer]

On Fri, Dec 05, 2014 at 12:53:28PM -0800, Bill Spitzak wrote:
> On 12/05/2014 06:44 AM, Pekka Paalanen wrote:
> 
> >do you have any suggestions on how to get rid of the asterisks in front
> >of code examples?
> 
> All I can say is that this appears to be a Doxygen bug, and it depends both
> on the version of Doxygen and on what commands have been processed by
> Doxygen before it encounters this. For me 1.8.6 and 1.7.6.1 do not produce
> this artifact with the current git head.
> 
> I did see 1.8.6 produce this, but only if a \code was first, then a ~~~, and
> then a \comment inside that. Obviously it is easier to trigger this but that
> was the only instance I found. You said you are using 1.8.5 so maybe it has
> this bug.

I'm pretty sure it's a bug too. I saw this in libevdev too but it
disappeared after upgrading to f21. not sure what exact version of doxygen
fixes it, ETIME to bisecty that atm, sorry.

I'd leave them in for now and wait for doxygen to fix itself on your
machine :)

Cheers,
   Peter

> 
> >How should we work around the lack of comment support?
> >
> >Should we just ignore our coding style when writing code examples in
> >Doxygen comments?
> 
> I'm uncertain if removing the asterisks is even a good solution. If you have
> a line in there like "*pointer = value;" it apparently still removes the
> asterisk!
> 
> >Or maybe there is some doxygen.conf option we missed?
> 
> I doubt it.