Bug 23093 – DDOC: display detailed documentation of public imports

Status
NEW
Severity
enhancement
Priority
P4
Component
dmd
Product
D
Version
D2
Platform
x86
OS
Windows
Creation time
2022-05-05T18:11:36Z
Last change time
2024-12-13T19:22:39Z
Assigned to
No Owner
Creator
John Hall
Moved to GitHub: dmd#18103 →

Comments

Comment #0 by john.michael.hall — 2022-05-05T18:11:36Z
Issue 10665 [1] was enhancement to list the publicly imported modules. There might be value in an option (perhaps a pragma) such has the effect of expanding the public imports so that all the documentation is displayed instead of just a list. For instance, the PR [2] has an example of three modules ```d /// This is module b module b; /// This is a function in module b void bFunction() { } ``` ```d /// This is module c module c; /// This is a function in module c void cFunction() { } ``` ```d /// This is module a module a; /// This is a public import comment public import b; /// This is a private import comment private import c; /// This is a function in module a void aFunction() { } ``` In this example, if the public import of `b` were changed to also include a `pragma(detailed-public-import)` or something similar, then the resulting documentation would incorporate every symbol within `b`, so in this case it would just be `bfunction`. [1] https://issues.dlang.org/show_bug.cgi?id=10665
Comment #1 by robert.schadek — 2024-12-13T19:22:39Z
THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dmd/issues/18103 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB