D17301: add documentation to result class

[Stefan Brüns]

bruns added inline comments.

INLINE COMMENTS

> result.h:58
> +    /**
> +     * Overriden function from KFileMetaData::ExtractionResult.
> +     */

Qt uses "Reimplemented from KFileMetaData::ExtractionResult::addtype()`, see e.g. http://doc.qt.io/qt-5/qfile.html#fileName

Overriden has a typo, "Overridden"

But I think you should remove the (docstring) comment, it should automatically pick up the description from the interface class.

> result.h:90
> +    /**
> +     * Contains the collection of words of the metadata
> +     */

Nitpick - missing full stop, also below.

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/20181203/af1b469a/attachment.html>