Making Phobos's documentation better

[Seb]

JackStouffer is doing a lot of work lately on this check and I 
think we can help him too:

https://github.com/dlang/phobos/projects/1

So if you have 15 spare minutes why not help out and make 
Phobos's documentation better?
After all, almost everyone in the State of D survey agreed that 
the documentation isn't superb yet.

How can I help?
---------------

1) If you don't have Phobos setup. Fork & clone the four main 
repos

---
mkdir ~/dlang && cd dlang
git clone https://github.com/<username>/dmd
git clone https://github.com/<username>/druntime
git clone https://github.com/<username>/phobos
git clone https://github.com/<username>/tools
cd phobos
make -f posix.mak
---

2) Pick a module and remove it from the has_public_example 
blacklist in .dscanner.ini

3) Run make -f posix.mak dscanner

4) Add unittest

5) Run the tests with either

- make -f std/mymodule.test (this rebuilds Phobos before running 
the tests)
- ~/dlang/dmd/generated/linux/release/64/dmd -unittest -main -i 
-run std/mymodule.d (faster as it doesn't rebuild Phobos)
- make -f std/mymodule.publictests (this extracts the public 
tests into a separate file to prevent any private access problems)

6) Submit a PR

7) GOTO 2 (or celebrate)


There are also a few other blacklists here too:

https://github.com/dlang/phobos/projects