Bug 406588 - Class apidocs don't show class name in page header
Summary: Class apidocs don't show class name in page header
Status: RESOLVED FIXED
Alias: None
Product: frameworks-kapidox
Classification: Frameworks and Libraries
Component: general (show other bugs)
Version: 5.57.0
Platform: Other Linux
: NOR normal
Target Milestone: ---
Assignee: kdelibs bugs
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-04-16 05:52 UTC by Juan Carlos Torres
Modified: 2019-12-27 13:59 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Juan Carlos Torres 2019-04-16 05:52:29 UTC
SUMMARY

API reference pages for classes and structs don't display their respective class/struct names (KAr, KConfigSkeleton, etc) at the very top of the page. Instead, it only shows the framework they belong to.


STEPS TO REPRODUCE
1. Visit any class API reference like https://api.kde.org/frameworks/karchive/html/classKAr.html (KAr) or https://api.kde.org/frameworks/kconfig/html/classKConfigSkeleton.html (KConfigSkeleton)
2. Look at the page header at the top

OBSERVED RESULT

KAr displays "KArchive", the framework name, not the class name. KConfigSkeleton displays "KConfig".

EXPECTED RESULT

KAr should display "KAr" and KConfigSkeleton should be "KConfigSkeleton".

SOFTWARE/OS VERSIONS
Linux/KDE Plasma: KDE Neon Testing
(available in About System)
KDE Plasma Version: 5.15.4
KDE Frameworks Version: 5.57.0
Qt Version: 5.12.0
Comment 1 David Redondo 2019-12-27 13:59:59 UTC
Git commit 816abe85ad6a34b091d1d11934656d4efdfa2604 by David Redondo.
Committed on 27/12/2019 at 13:59.
Pushed by davidre into branch 'master'.

Display fully qualified class/namespace name as page header

Summary:
It's the most important information to see quickly  what the page is about.
Using the fully qualified name contains the knowledge which namespace contains a
class/another namespace required which is helpful if one wants to use it in their
own code.

Test Plan:
Class:
{F7833042}
Namespace:
{F7833050}
Class inside namespace:
{F7833040}
Nested namespace:
{F7833034}
Class inside nested namespace:
{F7833031}

Reviewers: ochurlaud

Subscribers: ngraham, aacid, jucato, kde-frameworks-devel, kde-doc-english

Tags: #frameworks, #documentation

Differential Revision: https://phabricator.kde.org/D26197

M  +8    -1    src/kapidox/data/templates/library.html
M  +5    -0    src/kapidox/generator.py

https://commits.kde.org/kapidox/816abe85ad6a34b091d1d11934656d4efdfa2604