D17301: add documentation to result class

[Stefan Brüns]

bruns added a comment.


  I think methods reimplemented from and documented in KFileMetaData::ExtractionResult should **not** be documented here.

INLINE COMMENTS

> result.h:38
> + * \brief The result class is where all the data extracted by
> + * the KFileMetaData extractors is saved to a Baloo::Document.
> + * It implements the KFileMetaData::ExtractionResult interface.

Remove the last part of the sentence - `... is saved to.`. Everything else is an implementation detail.

> result.h:40
> + * It implements the KFileMetaData::ExtractionResult interface.
> + * The resulting Baloo::Document can then be pushed into the
> + * database.

`The results can be retrieved as a Baloo::Document using \c document() and
stored in the database.`

> result.h:51
> +    /**
> +     * Overloaded function from KFileMetaData::ExtractionResult.
> +     * Adds a key value pair which should be indexed.

This is no overload, but an override/reimplementation.

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

I think a `\sa KFileMetaData::Property` is sufficient here. Also, its not a property //name//, that would be something like a QString.

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/0625910a/attachment-0001.html>