Re: [PATCH 5/6] utils: Ensure wl_list's doxygen formats properly

2013-09-17 Thread Bill Spitzak
Doxygen itself can parse nested C comments. So a solution I found is this: #ifdef THIS_IS_NOT_DEFINED /** This is some documentation. * Example: * \code * /* look this is a c-style comment! */ * \endcode */ #endif Unfortunately, it doesn't seem possible to get Doxygen not to escape the amp

Re: [PATCH 5/6] utils: Ensure wl_list's doxygen formats properly

2013-09-17 Thread Kristian Høgsberg
On Tue, Sep 17, 2013 at 1:47 AM, Aaron Faanes wrote: > On Tue, Sep 17, 2013 at 12:09 AM, Kristian Høgsberg > wrote: >> >> On Sun, Sep 15, 2013 at 01:37:10PM -0500, Aaron Faanes wrote: >> > This changes the "struct foo" mentions to use , which appears as >> > monospaced font. This also wraps code

Re: [PATCH 5/6] utils: Ensure wl_list's doxygen formats properly

2013-09-17 Thread Aaron Faanes
On Tue, Sep 17, 2013 at 12:09 AM, Kristian Høgsberg wrote: > On Sun, Sep 15, 2013 at 01:37:10PM -0500, Aaron Faanes wrote: > > This changes the "struct foo" mentions to use , which appears as > > monospaced font. This also wraps code examples with \code tags to > > ensure they're detected as code.

Re: [PATCH 5/6] utils: Ensure wl_list's doxygen formats properly

2013-09-17 Thread Kristian Høgsberg
On Sun, Sep 15, 2013 at 01:37:10PM -0500, Aaron Faanes wrote: > This changes the "struct foo" mentions to use , which appears as > monospaced font. This also wraps code examples with \code tags to > ensure they're detected as code. Is there a doxygen markup we can use instead of ? Most of the us

[PATCH 5/6] utils: Ensure wl_list's doxygen formats properly

2013-09-15 Thread Aaron Faanes
This changes the "struct foo" mentions to use , which appears as monospaced font. This also wraps code examples with \code tags to ensure they're detected as code. The code example uses C++ style // comments. I would have preferred to use /* */ comments for consistency, but this is not possible si