https://bugs.kde.org/show_bug.cgi?id=407420
Bug ID: 407420
Summary: Parameter name and description are too close to each
other.
Product: frameworks-kapidox
Version: 5.57.0
Platform: Other
OS: Linux
Status: REPORTED
Severity: normal
Priority: NOR
Component: general
Assignee: [email protected]
Reporter: [email protected]
Target Milestone: ---
Created attachment 119978
--> https://bugs.kde.org/attachment.cgi?id=119978&action=edit
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
--
You are receiving this mail because:
You are watching all bug changes.
