Bug 16989 – Ensure that every Phobos function has Returns/Params

Status
NEW
Severity
enhancement
Priority
P4
Component
phobos
Product
D
Version
D2
Platform
x86_64
OS
Linux
Creation time
2016-12-20T00:28:02Z
Last change time
2024-12-01T16:28:24Z
Assigned to
No Owner
Creator
Seb
Moved to GitHub: phobos#10212 →

Comments

Comment #0 by greeenify — 2016-12-20T00:28:02Z
From https://wiki.dlang.org/Vision/2016H2: > Make sure every function in Phobos has Params: and Returns: sections http://www.digitalmars.com/d/archives/digitalmars/D/Phobos_Documentation_-_call_to_action_258777.html I started to hack together a Dscanner plugin that yields a list of undocumented functions: https://github.com/Hackerpilot/Dscanner/pull/390 It's about 1K and we should think how we can crowd-source this. Maybe adding a blacklist and then gradually removing modules from this blacklist? Unfortunately Dscanner doesn't support partial blacklisting for checks, so we could either 1) implement partial blacklisting for checks in Dscanner 2) add a workaround like running dscaner in the `style` target in the `posix.mak` at Phobos again with the blacklist and: echo 'properly_documented_public_functions = "enabled"' > .dscanner.ini
Comment #1 by greensunny12 — 2017-07-12T17:04:00Z
DScanner now supports partial blacklisting and `properly_documented_public_functions` can be fixed modulewise.
Comment #2 by robert.schadek — 2024-12-01T16:28:24Z
THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/phobos/issues/10212 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB