Bug 16068 – DDoc sections have serious design issues

Status
NEW
Severity
normal
Priority
P3
Component
dmd
Product
D
Version
D2
Platform
All
OS
All
Creation time
2016-05-24T14:22:15Z
Last change time
2024-12-13T18:48:04Z
Keywords
ddoc
Assigned to
No Owner
Creator
Leandro Lucarella
Moved to GitHub: dmd#19133 →

Attachments

IDFilenameSummaryContent-TypeSize
1598bad.pngDDoc outputimage/png7418

Comments

Comment #0 by leandro.lucarella — 2016-05-24T14:22:15Z
Created attachment 1598 DDoc output I don't want to make a full rant about DDoc (although I think is to D what the D preprocessor is to C/C++). I found a very fundamental problem. According to how sections are parsed, you can accidentally build new unintended sections just by formatting your paragraphs. For example: --- The contains() function is more convenient for trivial lookup cases: --- if (contains ("fubar", '!')) ... --- --- This is a real example of text inside DDoc. This text produces the attached output (basically "cases:" is interpreted as a new section). I'm not sure this has a solution, is just the whole DDoc system seems too broken by design, but if someone can think of any heuristics to make this more sensible (maybe requiring sections to have an empty line before?), it would be interesting to know.
Comment #1 by dfj1esp02 — 2016-05-25T12:51:42Z
Or use two colons to markup sections.
Comment #2 by leandro.lucarella — 2016-05-25T13:51:15Z
Even having links in their own line is triggering this issue: --- http://example.com/ --- Will generate a section called "http" with "//example.com/" as content. Using `::` could be an option, I guess. Although I think it might be better to move more towards markdown or some other well known text-friendly markup language.
Comment #3 by robert.schadek — 2024-12-13T18:48:04Z
THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dmd/issues/19133 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB