-D option = Embedded documentation

[Trass3r]

Am 16.12.2011, 19:45 Uhr, schrieb dune <do-not at email.com>:

> I didn't realize that stuff like this will not work as expected:
>
> [code]
> /***********************************
>  * Brief summary of what
>  * myfunc does, forming the summary section.
>  *
>  * First paragraph of synopsis description.
>  *
>  * Second paragraph of
>  * synopsis description.
>  */
>
> void myfunc() { }
>
> /***********************************
>  * This is just some text that
>  * should be added to the
>  * documentation
>  */
>
> // below is the next chunk of code
> [/code]
>
> The second block of documentation will not show up.

How is the doc generator supposed to know where that doc fragment is  
supposed to end up?
If it's related to a declaration, put it there.
If it's just a module-level comment, put it into the module doc comment.