D17301: add documentation to result class

[Yuri Chornoivan]

yurchor added inline comments.

INLINE COMMENTS

> result.h:56
> +     *
> +     * \p property This specifies a property name. It should be one of the
> +     *             properties from the list of properties from KFileMetaData.

This should be `\param`

https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdp

https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdparam

> result.h:59
> +     *
> +     * \p value The value of the property
> +     */

Same here.

> result.h:67
> +     *
> +     * \p text The text that will be appended to the document
> +     */

Same here.

> result.h:80
> +     * will be saved.
> +     * \p doc The Baloo::Document
> +     */

Same here.

REPOSITORY
  R293 Baloo

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

To: astippich, #baloo, bruns
Cc: yurchor, kde-frameworks-devel, ashaposhnikov, michaelh, astippich, spoorun, ngraham, bruns, abrahams
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20181202/82d41989/attachment.html>