[Issue 14622] New: documented unit test that follows an undocumented symbol silently ignored

via Digitalmars-d-bugs digitalmars-d-bugs at puremagic.com
Tue May 26 11:02:06 PDT 2015


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

          Issue ID: 14622
           Summary: documented unit test that follows an undocumented
                    symbol silently ignored
           Product: D
           Version: D2
          Hardware: All
                OS: All
            Status: NEW
          Keywords: ddoc, diagnostic
          Severity: enhancement
          Priority: P1
         Component: DMD
          Assignee: nobody at puremagic.com
          Reporter: schveiguy at yahoo.com

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.

--


More information about the Digitalmars-d-bugs mailing list