www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - Ddoc issues

reply Khu <tretton gmail.com> writes:
In documentation comments, it seems Ddoc treats any leading "word:" as a
standard section, no matter what it is. This snippet yields sections "See
Also:" which is empty, and "http:" which contains the rest of the URL:

/**
 * Blah, blah.
 *
 * See_Also:
 *   http://www.someurl.com/
 */
void foo() {}

Is this intentional?

Also, unmatched standard parentheses can twist the output:

/**
 * Blah, blah.
 *
 * Params:
 *   stuff = in interval [0,1)
 */
void bar(int stuff) {}

The above snippet, as well as flipping the ends of the interval to (0,1],
causes either a "$(DDOC_MODULE_MEMBERS" to appear above the documentation
comment or the last parenthesis to get shifted below the comment.

Thanks!
-Khu
Jan 07 2009
parent bearophile <bearophileHUGS lycos.com> writes:
Khu:
 Is this intentional?

Yes.
 Also, unmatched standard parentheses can twist the output:

I agree, that's a bug. ddoc has several such small bugs still. Bye, bearophile
Jan 07 2009