Worst Phobos documentation evar!
Ary Borenszweig via Digitalmars-d
digitalmars-d at puremagic.com
Wed Dec 31 14:53:13 PST 2014
On 12/31/14 7:46 PM, Dicebot wrote:
> On Wednesday, 31 December 2014 at 22:41:41 UTC, Ary Borenszweig wrote:
>> You are right. I browsed some phobo's code and saw the documentation,
>> it looks clean and nice. The only exception is std.algorithm which is
>> full of macros and barely readable.
>>
>> So where is that other macro code? The one that has $(BLANKLINE) or
>> $(COMMA) or $(DASH) and why is it needed?
>
> IMHO biggest issue is not inline documentation for functions but more
> higher level stuff like http://dlang.org/arrays.html - it was all in
> DDOC too last time I checked and changing anything about it is hardly a
> pleasure. Inline documentations only suffers when more pretty stuff like
> tables gets added.
It looks quite clean to me:
https://github.com/D-Programming-Language/dlang.org/blob/master/arrays.dd
Except for the fact that instead of the familiar HTML tags there are
macros. I see macros for:
Paragraphs: $(P)
Lists: $(UL), $(LI)
Links: $(HTTP)
These are very, very, veeeery common in documentation and sites.
Couldn't DDoc provide nice, readable ways for dealing with these?
More information about the Digitalmars-d
mailing list