www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 17618] New: parse booktables manually to check whether

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

          Issue ID: 17618
           Summary: parse booktables manually to check whether symbols
                    haven't been mentioned
           Product: D
           Version: D2
          Hardware: x86_64
                OS: Linux
            Status: NEW
          Severity: enhancement
          Priority: P1
         Component: dlang.org
          Assignee: nobody puremagic.com
          Reporter: greensunny12 gmail.com

Grouped booktables are awesome - they look very nice and give the reader and
quick overview (except for std.traits).

However, it repeatedly happened that when new symbols get added, these
booktables aren't updated.

Two ideas:

For all modules with a booktable

1) Parse the public symbols and check whether all have been mentioned in the
module comment (a simple `find` could do)
2) Use a Group: xxx key in the function comment header and build the booktable
as postprocessing of Ddoc.

Probably doing (1) as a DScanner check is the easiest.

https://github.com/dlang/phobos/pull/5570/files

--
Jul 07