llvm/llvm-project

Doxygen links to wrong implementation file

Open

#139.512 geöffnet am 12. Mai 2025

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C++ (10.782 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (26.378 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1T 2h) (1.000 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Überprüfen Sie die Doxygen Konfiguration auf mehrdeutige Dateinamen, um die korrekte Dateireferenz sicherzustellen.
Tech Stack
cpp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitC++
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80