Worst Phobos documentation evar!

[Walter Bright via Digitalmars-d]

On 12/31/2014 12:55 PM, Ary Borenszweig wrote:
> Definitely, because Markdown is not a macro system, it's a documentation tool.

I write a lot of documentation. A macro system has saved enormous amounts of 
effort. Night and day, really. Not having a macro system is like using a 
programming language that does not have functions.

Ketmar, for example, complained mightily about Ddoc markup. I suggested he 
simply email me the Phobos documentation he wants to write, and I'd mark it up 
for him and submit the PRs. He admitted he is not interested in actually writing 
any documentation. Ddoc is not the real issue, at least for him.

I'll extend the same offer to you. Email me the fixed Phobos docs. I'll mark 
them up and submit PRs.


The thing is, with Ddoc you don't actually have to write any markup. You can write:

/****************************
This function does blah, blah, blah.

Blah, blah, blah is an amazing algorithm invented by I. M. Nerdly.

Params:
    x = the awesome input value

Returns:
    insightful description of the return value

Example:
---
int foo(int x) { ... stunning D code ... }
---
***************************/