Skip to content

index entries for library declarations should point at the declaration itself, not the start of the synopsis #1562

Open
@zygoloid

Description

@zygoloid

This is particularly obvious for very long synopses. We generally write index entries at the start of the synopsis block, but we should really be pointing them at the point within the synopsis where the indexed entity is declared.

We probably need a new macro for marking up a library entity in a synopsis that adds an index entry and emits the name of that entity, so we can write something like:

int @\libdecl{myfunction}@(int, int);

to emit and index the name (with another form for member functions).

Metadata

Metadata

Assignees

No one assigned

    Labels

    bigAn issue causing a large set of changes, scattered across most of the text.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions