D10662: indexerconfig: Describe some functions

[Luca Beltrame]

lbeltrame accepted this revision.
lbeltrame added a comment.
This revision is now accepted and ready to land.


  Looks OK to me with some changes (for readability).

INLINE COMMENTS

> fileindexerconfig.h:50
>      /**
> -     * The folders to search for files to analyze. Cached and cleaned up.
> +     * Folders to search for files to analyze and index.
> +     * \return list of paths.

I'd put "index and analyze". Seems nitpicky, but reflects what Baloo does (index first, extraction later).

> fileindexerconfig.h:57
> +     * Folders that are excluded from indexing.
> +     * (It is possible to include descendants of an excluded folder again
> +     * and they will be indexed.)

"Descendant folders of an excluded folder can be added and they will be indexed."

REPOSITORY
  R293 Baloo

BRANCH
  publicdescriptions (branched from master)

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

To: michaelh, #baloo, lbeltrame
Cc: lbeltrame, adridg, #frameworks, ashaposhnikov, michaelh, spoorun, nicolasfella, alexeymin
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20180222/8965aa7e/attachment.html>