Bug 407420 - Parameter name and description are too close to each other.
Summary: Parameter name and description are too close to each other.
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-05-11 09:37 UTC by Juan Carlos Torres
Modified: 2020-04-18 11:28 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:


Attachments
Attica::AccountBalance::operator=() (37.02 KB, image/jpeg)
2019-05-11 09:37 UTC, Juan Carlos Torres
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Juan Carlos Torres 2019-05-11 09:37:09 UTC
Created attachment 119978 [details]
Attica::AccountBalance::operator=()

SUMMARY

When the parameter name of functions exceeds a certain length (>= 5 characters), the text gets too near the parameter description. It creates the appearance of a run-on sentence and lacks proper whitespace to divide the two columns.

STEPS TO REPRODUCE
1. Visit the Attica::AccountBalance::operator=() apidocs: https://api.kde.org/frameworks/attica/html/classAttica_1_1AccountBalance.html#a71c29c3638accbd6216be60b08509b76
2. Visit the KApidox::DoxyfileWriter::write_entry() apidocs: https://api.kde.org/frameworks/kapidox/html/classkapidox_1_1doxyfilewriter_1_1DoxyfileWriter.html#abc5a3ebf591f4c05cc00c03ca6cb8c5a
3. Visit the KConfig::KConfigBase::group() apidocs: https://api.kde.org/frameworks/kapidox/html/classkapidox_1_1doxyfilewriter_1_1DoxyfileWriter.html#abc5a3ebf591f4c05cc00c03ca6cb8c5a

OBSERVED RESULT
1. Text reads: "otherthe AccountBalance to copy from" (See attached screenshot)
2. Text reads: "valuethe value part of the entry. Can be a string, a list, a tuple or a boolean"
3. Text reads: "groupthe group to open. Pass a null string on to the KConfig object to obtain a handle on the root group."

EXPECTED RESULT
1. Text should read: "other	the AccountBalance to copy from"
2. Text should read: "value	the value part of the entry. Can be a string, a list, a tuple or a boolean"
3. Text should read: "group	the group to open. Pass a null string on to the KConfig object to obtain a handle on the root group."


SOFTWARE/OS VERSIONS
Linux/KDE Plasma: KDE Neon Testing Edition
(available in About System)
KDE Plasma Version: 5.15.5
KDE Frameworks Version: 5.58.0
Qt Version: 5.12.0
Comment 1 Juan Carlos Torres 2020-04-18 11:28:20 UTC
Seems to now be fixed with the latest version of the Aether-based design.

https://phabricator.kde.org/D28712