www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 23093] New: DDOC: display detailed documentation of public

https://issues.dlang.org/show_bug.cgi?id=23093

          Issue ID: 23093
           Summary: DDOC: display detailed documentation of public imports
           Product: D
           Version: D2
          Hardware: x86
                OS: Windows
            Status: NEW
          Severity: enhancement
          Priority: P1
         Component: dmd
          Assignee: nobody puremagic.com
          Reporter: john.michael.hall gmail.com

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

--
May 05 2022