Thread overview | ||||||||
---|---|---|---|---|---|---|---|---|
|
March 18, 2015 [Issue 14307] Ddoc: issue error on all functions that are missing ddoc sections | ||||
---|---|---|---|---|
| ||||
https://issues.dlang.org/show_bug.cgi?id=14307 Walter Bright <bugzilla@digitalmars.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |ddoc -- |
March 18, 2015 [Issue 14307] Ddoc: issue error on all functions that are missing ddoc sections | ||||
---|---|---|---|---|
| ||||
https://issues.dlang.org/show_bug.cgi?id=14307 Jonathan M Davis <issues.dlang@jmdavisProg.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |issues.dlang@jmdavisProg.co | |m --- Comment #1 from Jonathan M Davis <issues.dlang@jmdavisProg.com> --- In principle, I like the idea. However, I don't know about requiring Returns and Params sections and examples. There are plenty of cases where you want them, but there are also cases where they're so obvious that documenting them is redundant and therefore just creates noise in the file - especially on stuff like property functions. -- |
March 18, 2015 [Issue 14307] Ddoc: issue error on all functions that are missing ddoc sections | ||||
---|---|---|---|---|
| ||||
https://issues.dlang.org/show_bug.cgi?id=14307 --- Comment #2 from hsteoh@quickfur.ath.cx --- Note that Example: sections may have been generated by ddoc'd unittest blocks rather than an explicit Example section in the ddoc comment. In fact, ddoc's unittest blocks are preferred, because then you know that the test suite actually verifies that the example works, rather than some random code inside a ddoc'd comment that may or may not even compile, and of dubious correctness. -- |
March 19, 2015 [Issue 14307] Ddoc: issue error on all functions that are missing ddoc sections | ||||
---|---|---|---|---|
| ||||
https://issues.dlang.org/show_bug.cgi?id=14307 Jacob Carlborg <doob@me.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |doob@me.com --- Comment #3 from Jacob Carlborg <doob@me.com> --- If you implement this, it should apply for protected symbols as well. -- |
December 17, 2022 [Issue 14307] Ddoc: issue error on all functions that are missing ddoc sections | ||||
---|---|---|---|---|
| ||||
https://issues.dlang.org/show_bug.cgi?id=14307 Iain Buclaw <ibuclaw@gdcproject.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Priority|P1 |P4 -- |
December 13 [Issue 14307] Ddoc: issue error on all functions that are missing ddoc sections | ||||
---|---|---|---|---|
| ||||
https://issues.dlang.org/show_bug.cgi?id=14307 --- Comment #4 from dlangBugzillaToGithub <robert.schadek@posteo.de> --- THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dmd/issues/18960 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB -- |
Copyright © 1999-2021 by the D Language Foundation