D17301: add documentation to result class

[Stefan Brüns]

bruns added inline comments.

INLINE COMMENTS

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

The TermGenerator's do not contain any data themselves, but

- keep/update the position state when adding data
- add the data to the referenced Baloo::Document when supplied with new data (`index*Text()`)

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/20181205/0f18a156/attachment.html>