Consider this:
/// document foo
void foo(int) {...}
void foo(string) {...}
///
unittest
{
// use foo like this!
foo(1);
}
The unit test is not included in the documentation, because foo(string) was not ditto'd. But clearly, the unit test was supposed to be part of the documentation.
I propose we make a documented unit test that isn't attached to any symbol a warning when generating documentation.
Comment #1 by dlang-bot — 2022-10-05T14:51:19Z
@ntrel created dlang/dmd pull request #14527 "Fix Issue 14622 - documented unit test following undocumented symbol" fixing this issue:
- Fix Issue 14622 - documented unit test following undocumented symbol
https://github.com/dlang/dmd/pull/14527
Comment #2 by robert.schadek — 2024-12-13T18:43:02Z