• via Digitalmars-d-bugs (26/28) Dec 19 2016 https://issues.dlang.org/show_bug.cgi?id=16989

via Digitalmars-d-bugs <digitalmars-d-bugs puremagic.com> writes:

https://issues.dlang.org/show_bug.cgi?id=16989

          Issue ID: 16989
           Summary: Ensure that every Phobos function has Returns/Params
           Product: D
           Version: D2
          Hardware: x86_64
                OS: Linux
            Status: NEW
          Severity: enhancement
          Priority: P1
         Component: phobos
          Assignee: nobody puremagic.com
          Reporter: greeenify gmail.com

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

--