[Issue 14307] New: Ddoc: issue error on all functions that are missing ddoc sections
via Digitalmars-d-bugs
digitalmars-d-bugs at puremagic.com
Wed Mar 18 11:42:10 PDT 2015
https://issues.dlang.org/show_bug.cgi?id=14307
Issue ID: 14307
Summary: Ddoc: issue error on all functions that are missing
ddoc sections
Product: D
Version: D2
Hardware: All
OS: All
Status: NEW
Severity: enhancement
Priority: P1
Component: DMD
Assignee: nobody at puremagic.com
Reporter: bugzilla at digitalmars.com
Add switch to compiler that causes Ddoc to issue error for public functions
that:
1. have no Ddoc comment
2. have a non-void return but no Returns: section
3. have parameters but no Params: section
4. have no Example: section
Rationale:
Far too many functions in Phobos have essentially non-existent documentation.
--
More information about the Digitalmars-d-bugs
mailing list