[Issue 9758] New: Ddoc: empty ddoc comment and unittest block generates no Examples section
d-bugmail at puremagic.com
d-bugmail at puremagic.com
Tue Mar 19 08:24:10 PDT 2013
http://d.puremagic.com/issues/show_bug.cgi?id=9758
Summary: Ddoc: empty ddoc comment and unittest block generates
no Examples section
Product: D
Version: D2
Platform: All
OS/Version: All
Status: NEW
Keywords: ddoc
Severity: minor
Priority: P2
Component: DMD
AssignedTo: nobody at puremagic.com
ReportedBy: k.hara.pg at gmail.com
--- Comment #0 from Kenji Hara <k.hara.pg at gmail.com> 2013-03-19 08:24:08 PDT ---
>From the discussion in https://github.com/D-Programming-Language/dmd/pull/1765
Currently, this code:
/// test
void foo(){}
///
unittest { }
Will generate:
void foo();
test
There is no "Examples:" section, because unittest block has empty ddoc comment
and code block. But I think generating "Examples:" section is sometimes useful,
even if there is no text. For example making placeholder to represent necessity
of later documentation writing.
--
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
More information about the Digitalmars-d-bugs
mailing list