Bug 510106 - New QDoc based docs lack documentation for functions in namespaces
Summary: New QDoc based docs lack documentation for functions in namespaces
Status: CONFIRMED
Alias: None
Product: api.kde.org
Classification: Websites
Component: general (other bugs)
Version First Reported In: unspecified
Platform: Other All
: NOR normal
Target Milestone: ---
Assignee: Documentation Editorial Team
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2025-09-30 19:00 UTC by Lukas Sommer
Modified: 2025-10-27 11:34 UTC (History)
5 users (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Lukas Sommer 2025-09-30 19:00:21 UTC
SUMMARY
New QDoc based docs lack documentation for functions in namespaces.

(I suppose QDoc is live now?)

STEPS TO REPRODUCE
1. Go to https://api.kde.org/klocalization.html
2. In the "Functions" list, click on "setupSpinBoxFormatString"

OBSERVED RESULT

Nothing happens. The link is dead.

EXPECTED RESULT

The documentation of "setupSpinBoxFormatString" is shown.

ADDITIONAL INFORMATION

Seems to occur when functions are in a namespace, not in a class.

The mentioned example showed the documentation correctly in the past when using Doxygen.
Comment 1 Akseli Lahtinen 2025-10-01 08:56:00 UTC
Can confirm this happens for me as well.
Comment 2 David Boddie 2025-10-27 11:34:09 UTC
It looks like all of these functions are children of namespaces. One difference appears to be how the namespace is documented in each case.

setupLocalizedContext() is declared in one place where the KLocalization namespace is documented as being part of the KI18nQml module:
https://invent.kde.org/frameworks/ki18n/-/blob/master/src/i18n-qml/klocalizedqmlcontext.h?ref_type=heads

The other functions are declared as part of the KLocalization namespace that is documented as being part of the KI18n module:
https://invent.kde.org/frameworks/ki18n/-/blob/master/src/i18n/klocalization.h?ref_type=heads

It may be that this detail isn't the cause of this, but it's something to check.