Bug 10769 – Text describing Sections in Documentation Generator page inaccurate

Status
NEW
Severity
minor
Priority
P3
Component
dlang.org
Product
D
Version
D2
Platform
All
OS
All
Creation time
2013-08-07T01:30:24Z
Last change time
2024-12-15T15:22:20Z
Assigned to
No Owner
Creator
Andre Artus
Moved to GitHub: dlang.org#3938 →

Comments

Comment #0 by andre.artus — 2013-08-07T01:30:24Z
The text describing Sections in Documentation Generator page (http://dlang.org/ddoc.html) is not accurate. > Sections > The document comment is a series of Sections. A Section is a name that is the first non-blank character > on a line immediately followed by a ':'. This name forms the section name. The section name is not case > sensitive. 1. A section is not a name. It has a name (except when it doesn't). May I propose: " A section is a block of text that is given special meaning by the document generator based on either position or a{n} [predefined?] (identifier|name|label|keyword). Details of each kind of section follow" 2. A name can be more than one character. I believe all the standard sections have names longer than 1 character. 3. Some sections do not end their identifiers with a colon (':') to wit "Escapes=". 4. The wording leaves the impression that arbitrary named sections are possible, is this the case? Or are the named sections predefined (i.e. those listed as standard and special sections)?
Comment #1 by nick — 2022-08-07T16:34:06Z
> 3. Some sections do not end their identifiers with a colon (':') to wit "Escapes=". That seems to be the only one. https://github.com/dlang/dlang.org/pull/3367
Comment #2 by robert.schadek — 2024-12-15T15:22:20Z
THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dlang.org/issues/3938 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB