Various improvements. Better examples, updated coding style for the examples, removed some obsolete things.
There's room for more improvements, but this is a first step
Details
Details
- Reviewers
broulik jucato cblack - Group Reviewers
Frameworks - Maniphest Tasks
- T12709: Improvements for KNotifications documentation/guidelines
Diff Detail
Diff Detail
- Branch
- arcpatch-D26918
- Lint
No Linters Available - Unit
No Unit Test Coverage - Build Status
Buildable 27171 Build 27189: arc lint + arc unit
Comment Actions
+1 on improving the documentation, it does read dated. Thanks!
| src/knotification.h | ||
|---|---|---|
| 36–37 | This entirely changes the semantics. Might still be correct but it could make sense to make sure that's the case? | |
| 36–37 | persistence is not about being important. It's because it stays relevant over time, which ironically the battery example kind of feels weird because over time the laptop will just run out of juice. | |
| 36–37 | It could make sense to specify the cmake syntax to do that? install(FILES appname.notifyrc DESTINATION ${KNOTIFYRC_INSTALL_DIR}) | |
| src/knotification.h | ||
|---|---|---|
| 36–37 | I feel like the whole paragraph should link to the HIG instead | |
| src/knotification.h | ||
|---|---|---|
| 36–37 | Don't we have that already below? | |
| src/knotification.h | ||
|---|---|---|
| 96 | Maybe we should keep this part that the icon name, especially that it has to be one that can be found by KIconLoader. | |
| src/knotification.h | ||
|---|---|---|
| 96 | Since Qt5 KIconLoader is an implementation detail. Even our apps and frameworks use QIcon::fromTheme, I haven't looked at what KNotifications does but pretty sure it's using QIcon. | |
| src/knotification.h | ||
|---|---|---|
| 96 | It actually sends out the icon name as a string and plasmashell then looks it up. | |
| src/knotification.h | ||
|---|---|---|
| 96 | With QIcon? | |
| Mainpage.dox | ||
|---|---|---|
| 10 | Doxygen should do that automatically | |
| Mainpage.dox | ||
|---|---|---|
| 14 | Use @c | |
| 16 | Ditto | |
| 20 | Bad documentation style: warning block should be entirely self-contained in what it's conveying. | |
| 26 | Use markdown syntax, not inline HTML. | |
| 34 | @code and @endcode or use markdown | |
| 47 | Ditto | |
| 62 | Ditto | |
| 111 | Use docs/Doxyfile.local for configuration overrides. Examples exclude is unnecessary because it's set as Doxygen's example path. | |