www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 17678] New: Ddoc should ignore private symbols while

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

          Issue ID: 17678
           Summary: Ddoc should ignore private symbols while aggregating
                    /// ditto or documentated examples
           Product: D
           Version: D2
          Hardware: x86_64
                OS: Linux
            Status: NEW
          Severity: enhancement
          Priority: P1
         Component: dmd
          Assignee: nobody puremagic.com
          Reporter: greensunny12 gmail.com

Consider this example:

///
void dirName(C)(C[] path) {}

private void _dirName(R)(R path){}

/// <- not part of the docs
 safe unittest
{
    //assert(dirName("") == ".");
}

Ddoc: http://dlang.org/phobos/std_path.html#dirName (without examples)
Ddox: https://dlang.org/library/std/path/dir_name.html (with examples)


I believe that it would be sensible for Ddoc to ignore the private symbols on
symbol aggregation search (like e.g. Ddox does).

See also: https://github.com/dlang-community/D-Scanner/issues/500

--
Jul 24