Bug 17678 – Ddoc should ignore private symbols while aggregating /// ditto or documentated examples

Status
NEW
Severity
enhancement
Priority
P4
Component
dmd
Product
D
Version
D2
Platform
x86_64
OS
Linux
Creation time
2017-07-24T11:08:50Z
Last change time
2024-12-13T18:53:36Z
Assigned to
No Owner
Creator
Seb
Moved to GitHub: dmd#17808 →

Comments

Comment #0 by greensunny12 — 2017-07-24T11:08:50Z
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
Comment #1 by robert.schadek — 2024-12-13T18:53:36Z
THIS ISSUE HAS BEEN MOVED TO GITHUB https://github.com/dlang/dmd/issues/17808 DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB