D26918: Improve KNotification API docs

[Carson Black]

cblack requested changes to this revision.
cblack added inline comments.
This revision now requires changes to proceed.

INLINE COMMENTS

> Mainpage.dox:13
> +In order to perform a notification, you need to create a description file, which contains
> +default parameters of the notification. It needs to be installed to <em>knotifications5/appname.notifyrc</em>
> +in a QStandardPaths::GenericDataLocation directory.

Use @c

> Mainpage.dox:15
> +in a QStandardPaths::GenericDataLocation directory.
> +On Android, this path is <em>qrc:/knotifications5/</em>.
> +

Ditto

> Mainpage.dox:19
> +component name to the KNotification object.
> + at warning Notifications won't be visible otherwise.
> +

Bad documentation style: warning block should be entirely self-contained in what it's conveying.

> Mainpage.dox:25
> + This file contains  mainly 3 parts
> +  <ol>
> +  <li>\ref global "Global information"</li>

Use markdown syntax, not inline HTML.

> Mainpage.dox:33
> +The global part looks like that
> +<pre>
> +    [Global]

`@code` and `@endcode` or use markdown

> Mainpage.dox:46
> +This part consists of hints for the configuration widget
> + <pre>
> +    [Context/group]

Ditto

> Mainpage.dox:61
> +The definition of the events forms the most important part of the config file
> +<pre>
> +    [Event/newmail]

Ditto

> Mainpage.dox:110
> +// DOXYGEN_SET_EXCLUDE_PATTERNS += *_p.h */private/* */examples/*
> +// DOXYGEN_SET_PROJECT_NAME = KNotifications
> +// vim:ts=4:sw=4:expandtab:filetype=doxygen

Use `docs/Doxyfile.local` for configuration overrides. Examples exclude is unnecessary because it's set as Doxygen's example path.

REPOSITORY
  R289 KNotifications

REVISION DETAIL
  https://phabricator.kde.org/D26918

To: nicolasfella, #frameworks, broulik, jucato, cblack
Cc: cblack, class, apol, kde-frameworks-devel, LeGast00n, michaelh, ngraham, bruns
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20200413/a69ca05e/attachment.html>