D17301: add documentation to result class

[Stefan Brüns]

bruns added inline comments.

INLINE COMMENTS

> result.h:83
> +     */
>      void setDocument(const Baloo::Document& doc);
>  

The use case is missing here.
`Can be used to add extraction results to an existing Baloo::Document. Has to be called before passing the Result to KFileMetaData::Extractor::extract()`

> result.h:87
> +     * Returns a QVariantMap containing all metadata fetched from the extractors.
> +     * The metadata is saved as <property.name(),property.value()>
> +     */

Thats not correct, see implementation of `Result::add(...)`

`QString p = QString::number(propnum)`

But as m_map/map() is never used outside Result (only in Result::finish), it is best to remove the getter completely. D17312 <https://phabricator.kde.org/D17312>

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