Bug 13272 – [ddoc] Should merge docs for eponymous template with single public member

Status
NEW
Severity
enhancement
Priority
P4
Component
dmd
Product
D
Version
D2
Platform
x86_64
OS
Linux
Creation time
2014-08-09T14:41:14Z
Last change time
2024-12-13T18:23:43Z
Keywords
ddoc
Assigned to
No Owner
Creator
hsteoh
Moved to GitHub: dmd#17675 →

Comments

Comment #0 by hsteoh — 2014-08-09T14:41:14Z
The example is from std.parallelism: ------ /** ... */ final class TaskPool { /// template amap(functions...) { /** ... */ auto amap(Args...)(Args args) if (...) { } } } ------ Currently, ddoc will output template amap(functions...) as a separate outer layer, followed by the docs for amap(Args...)(Args args). It should merge the two together since this is an eponymous template.
Comment #1 by nick — 2023-10-31T17:18:24Z
A related example is when documented unittests for an eponymous template come after it. ddoc then formats them like this: * `template` ddoc * unittests ddoc * eponymous member ddoc The member ddoc is often needed to be read (e.g. function signature) before seeing the documented unittests.
Comment #2 by robert.schadek — 2024-12-13T18:23:43Z
THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dmd/issues/17675 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB