-D option = Embedded documentation

dune do-not at email.com
Fri Dec 16 10:45:59 PST 2011

I didn't realize that stuff like this will not work as expected:

 * 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

The second block of documentation will not show up.

Here the section of the D2 DDoc documentation I apparently missed:

"Documentation comments not associated with a declaration are ignored."

(from http://www.d-programming-language.org/ddoc.html)

...which in turn is not logical to me because the condition "/**" and "*/" are met.

Anyway, thanks for the help; it guided me in the right direction.

Thanks again

More information about the Digitalmars-d-learn mailing list