Skip to content

doxygen: misleading entries in references links #6340

@backwardsEric

Description

@backwardsEric

With ed7ed82 , run doxygen (doxygen src/doc/doxygen.conf), use a web browser to look at src/doc/_doxygen/player-path_8c.html, and look at the documentation for its local function is_valid_pf(). That function is said to reference p (a global from the src/tests/artifact/name.c test cases) but what it does reference is the p argument to the function.

There may be other globals (either in the test cases or, perhaps, the game itself) that trigger similar spurious links in doxygen's output.

Could declare p in src/tests/artifact/name.c as static to avoid this. Other possible solutions would be to exclude the test cases from doxygen's output, some change to src/doc/doxygen.conf so it knows that the test cases are separate and reference the game's source code but the game's source code does not reference the test cases, or rename function arguments so they are not confused for globals.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions