This change reformats the documentation so it's more easier to read it.
Details
- Reviewers
davidedmundson - Group Reviewers
KWin - Commits
- R108:be3ab3871eb3: [libkwineffects] Overhaul AnimationEffect's documentation
Generated Doxygen documentation, started Python's Simple HTTP server, navigated
to AnimationEffect's documention, haven't noticed any serious issues.
Diff Detail
- Repository
- R108 KWin
- Lint
Lint OK - Unit
No Unit Test Coverage - Build Status
Buildable 6406 Build 6424: arc lint + arc unit
libkwineffects/kwinanimationeffect.h | ||
---|---|---|
94 | How are you generating the doxygen docs? With typical KDE templates unless there's docs at the top of the class, it'll skip the entire thing, which makes any changes to make docs doxygen friendly a somewhat wasted effort. |
libkwineffects/kwinanimationeffect.h | ||
---|---|---|
94 | I used custom Doxyfile. Where can I find KDE's template? |
libkwineffects/kwinanimationeffect.h | ||
---|---|---|
94 | Alright, it seems like the one that comes with KApiDox. |
Huh, it looks like we follow neither https://community.kde.org/Policies/KDE4_Library_Documentation_Policy nor https://community.kde.org/Frameworks/Frameworks_Documentation_Policy in KWin and KWayland. E.g. we prefer
@param param Some description
over
@param param some description
KWin never followed those documents as KWin was neither a library in KDE 4 nor is it a framework. KWin's internal doxygen documentation predates these documents.