llvm/llvm-project

Doxygen links to wrong implementation file

Open

#139512 opened on May 12, 2025

View on GitHub
 (5 comments) (0 reactions) (1 assignee)C++ (26,378 stars) (10,782 forks)batch import
documentationgood first issue

Description

The documentation for llvm::Use::zap refers to the implementation at line 35 of llvm/lib/IR/Use.cpp but the link that doxygen inserts points instead to the file llvm/lib/ShadowIR/Use.cpp. I'm guessing it should probably point to llvm/lib/IR/Use.cpp as that is where zap is defined.

My doxygen-fu is rusty but I imagine it is not able to correctly disambiguate the two different files, lib/ShadowIR/Use.cpp and lib/IR/Use.cpp as they share the same name. There might be other examples of this kind of link confusion but I haven't done a thorough check.

Contributor guide

Tech stack
ccpp
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C++ knowledgeDoxygen basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue is that Doxygen generates a link to llvm/lib/ShadowIR/Use.cpp instead of llvm/lib/IR/Use.cpp for the `zap` method. The root cause is likely Doxygen's inability to disambiguate files with the same basename. Research should focus on Doxygen configuration options (e.g., FULL PATH NAMES, SHORT NAMES) to ensure correct file paths are used. Additionally, check for other similar mislinks in the generated documentation.