https://bugs.kde.org/show_bug.cgi?id=465578
Bug ID: 465578
Summary: Improve KWin scripting API documentation
Classification: Plasma
Product: kwin
Version: unspecified
Platform: Other
OS: All
Status: REPORTED
Severity: normal
Priority: NOR
Component: scripting
Assignee: [email protected]
Reporter: [email protected]
Target Milestone: ---
It is (partially) hard to figure out what the KWin scripting API does. The
documentation on https://develop.kde.org/docs/extend/plasma/kwin/api/ should be
improved.
Examples:
- Describe terminology: workspace, toplevel, client; desktop vs screen etc. I
know that some of this is obvious for KDE folks or described on
https://develop.kde.org/docs/extend/plasma/kwin/ but it would still make sense
to have it here.
- Document enum values.
- Add missing documentation for properties and functions.
- Add more examples.
Document from a user perspective: If I understand correctly, the Toplevel and
AbstractClient are used/available only via client. Therefore, they should be
unified as documentation for "client" (the user should not care about the
internal class hierarchy).
Also, the generator script should be moved from the user repository
(https://invent.kde.org/nicolasfella/kwin-scripting-api-generator) to an
organization repository (maybe KWin repository).
--
You are receiving this mail because:
You are watching all bug changes.
