Re: [PATCH] Support for C++ comments next to arguments of macro function

Christian Schoenebeck via Doxygen-develop <[email protected]> Sun, 10 Dec 2017 20:14:53 +0100
Newsgroups gmane.text.doxygen.devel
Message-ID <3401181.rk53T6dEXp@silver>
On Sonntag, 10. Dezember 2017 19:50:06 CET Albert wrote:
> Dear Christian,
> 
> What happens in case of multi-line inline comments?
> E.g.:
> DECLARE_ENUM(Foo_t,
>      foo1 = 0x000000001, ///< First comment.
>                                     ///< continuation of first comment
>      foo2 = 22, ///< Second comment.
>                     ///< continuation of second comment
>      foo3
>  );

Internally that example macro would first be expanded by the lexer like this:

enum Foo_t {     foo1 = 0x000000001, /**< First comment. */                                    /**< continuation of first comment */     foo2 = 22, /**< Second comment. */                    /**< continuation of second comment */     foo3 };

Everything in one line at this point.

And in the final (i.e. html) document the enum member "foo1" for example would then end up with the following explanation text (tested):

---------------------------
First comment
[NEW-LINE]
continuation of first comment
---------------------------

Best regards,
Christian Schoenebeck

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot