Bug 467005 - KApiDox substitutes “@ref options” with a link to KConfig, which is not always appropriate.
Summary: KApiDox substitutes “@ref options” with a link to KConfig, which is not alway...
Status: REPORTED
Alias: None
Product: frameworks-kapidox
Classification: Frameworks and Libraries
Component: general (show other bugs)
Version: unspecified
Platform: Other Linux
: NOR normal
Target Milestone: ---
Assignee: kdelibs bugs
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-03-07 12:04 UTC by Lukas Sommer
Modified: 2023-03-07 12:04 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:

Attachments
Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description Lukas Sommer 2023-03-07 12:04:35 UTC 
SUMMARY
KApiDox substitutes “@ref options” with a link to KConfig, which is not always appropriate.


STEPS TO REPRODUCE
1. Consider the following Doxygen comment: https://invent.kde.org/libraries/perceptualcolor/-/blob/ef3906f6400861e841b711df70211126c075b93d/src/colordialog.cpp#L1739

OBSERVED RESULT
The resulting API documentation substitues “@ref options” with a link with the text “KConfig Entry Options”, which is not the correct context here:
https://api.kde.org/perceptualcolor/html/classPerceptualColor_1_1ColorDialog.html#aa82b2369fe5376262e494ef0b509656c

EXPECTED RESULT
 “@ref options” is processed like on local Doxygen instances: It generates in internal link.