Lots of classes are missing high-level documentation (just grep for TODO to see that). Documentation should explain why a class should be used, what problem it aims to solve and how to use it in practice.
Description
Description
| Status | Assigned | Task | ||
|---|---|---|---|---|
| Open | None | T12130 KDeclarative API Review | ||
| Open | None | T12139 Cleanup API Documentation |
Comment Actions
I think right now we have the following tasks to do:
- Add API documentation where it's missing
- This can only be done by the main developers working on them I think.
- Fix broken API links in develop-kde-org
- Doable with help of https://invent.kde.org/documentation/develop-kde-org/-/blob/master/scripts/doxygen_integration.py which has instructions in the readme.
- Fix broken API links in frameworks like Kirigami
- Doable using https://invent.kde.org/frameworks/kapidox , which now has a friendlier tutorial.
- Improve the documentation to include what it does, why use it, how to use it
- This sort of task can work as a collection of junior jobs for novice developers attempting to learn the API. If new contributors can't use the API just by reading it, then there's likely something that needs to be fixed.
- Add images for visual components in e.g. KXmlGui and Kirigami
- Doable, again, with KApiDox.