Skip to content

ddoc: Low discoverability of core.sys #22375

@Inkrementator

Description

@Inkrementator

The documentation index as well as the sidebar there doesn't provide hyperlinks to anything in core.sys.

I believe the root cause is that core.sys doesn't have a package.d with a ddoc comment and ddoc doesn't link it in that case. I think symbols inside a file that don't have a doc-comment attached also don't get displayed.

Some files in core.sys can be found via search engine if they contain ddoc comments: https://dlang.org/phobos/core_sys_linux_fs.html . I wonder where google gets these links.

Right now, the best way to discover stuff in these modules is either to look at the source directly or possibly rely on IDE autocompletion.

I think the two fixes to this are either to add an empty ddoc comment to every public symbol in core.sys as well as stub package.d files. Alternatively, ddoc could be modified to work more like adrdox, which indexes the whole module-tree just fine.

This is a duplicate of dlang/phobos#10465 , edited to make it more actionable. Maybe the phobos issue should be closed.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions