digitalmars.D.learn - Generate docs for generated code?
- wjoe (15/15) Jul 23 2021 Is there a way for the compiler to consider doc comments in auto
- user1234 (3/18) Jul 23 2021 unfortunately no and this is considered as a
- wjoe (2/22) Jul 23 2021 bummer but thanks for the link.
- Adam D Ruppe (13/15) Jul 23 2021 If you use my adrdox generator (which runs on the dpldocs.info
- wjoe (3/18) Jul 23 2021 Cool! I take it.
Is there a way for the compiler to consider doc comments in auto generated, mixed in code? E.g. ```D string fooImpl = q{ /// Bar does fancy things. const void bar() { /*do something fancy*/ } }; /// This is Foo struct Foo(A, B, C) { mixin(fooImpl); } ``` So that the documentation for ```struct Foo``` has that of the member ```bar()``` ?
Jul 23 2021
On Friday, 23 July 2021 at 10:04:55 UTC, wjoe wrote:Is there a way for the compiler to consider doc comments in auto generated, mixed in code? E.g. ```D string fooImpl = q{ /// Bar does fancy things. const void bar() { /*do something fancy*/ } }; /// This is Foo struct Foo(A, B, C) { mixin(fooImpl); } ``` So that the documentation for ```struct Foo``` has that of the member ```bar()``` ?unfortunately no and this is considered as a [bug](https://issues.dlang.org/show_bug.cgi?id=2420)
Jul 23 2021
On Friday, 23 July 2021 at 10:42:22 UTC, user1234 wrote:On Friday, 23 July 2021 at 10:04:55 UTC, wjoe wrote:bummer but thanks for the link.Is there a way for the compiler to consider doc comments in auto generated, mixed in code? E.g. ```D string fooImpl = q{ /// Bar does fancy things. const void bar() { /*do something fancy*/ } }; /// This is Foo struct Foo(A, B, C) { mixin(fooImpl); } ``` So that the documentation for ```struct Foo``` has that of the member ```bar()``` ?unfortunately no and this is considered as a [bug](https://issues.dlang.org/show_bug.cgi?id=2420)
Jul 23 2021
On Friday, 23 July 2021 at 10:04:55 UTC, wjoe wrote:Is there a way for the compiler to consider doc comments in auto generated, mixed in code?If you use my adrdox generator (which runs on the dpldocs.info website), it handles mixin templates. See http://dpldocs.info/experimental-docs/std.net.curl.HTTP.html#mixed-in-members for example. Mine also actually handles mixin(q{ /// code void foo() {} }); as if it was direct. But my generator only handles mixin templates and mixin string literals, not actually generated code returned from a function.
Jul 23 2021
On Friday, 23 July 2021 at 10:54:33 UTC, Adam D Ruppe wrote:On Friday, 23 July 2021 at 10:04:55 UTC, wjoe wrote:Cool! I take it. Thanks for making adrdox :)Is there a way for the compiler to consider doc comments in auto generated, mixed in code?If you use my adrdox generator (which runs on the dpldocs.info website), it handles mixin templates. See http://dpldocs.info/experimental-docs/std.net.curl.HTTP.html#mixed-in-members for example. Mine also actually handles mixin(q{ /// code void foo() {} }); as if it was direct. But my generator only handles mixin templates and mixin string literals, not actually generated code returned from a function.
Jul 23 2021