D10662: indexerconfig: Describe some functions

[Adriaan de Groot]

adridg added inline comments.

INLINE COMMENTS

> indexerconfig.h:45
> +     * match any of the exclude filters. Only the name of the
> +     * dir itself it checked.
> +     *

This makes it unclear if the entire path is used, (e.g. `\p path`) or whether some special part of the path (the dir) is used for matching. It *might* be nice to have documentation on how exactly (e.g. most-specific wins) the matching works, unless that is documented elsewhere.

> indexerconfig.h:47
> +     *
> +     * \return \p true if the file or folder at \p path should
> +     * be indexed according to the configuration.

Is `\p true` really the right markup here? That's for parameters. You probably want `\c true` -- even though that will produce exactly the same output, the meaning is different.

> indexerconfig.h:53
> +    /**
> +     * The folders to search for files to analyze. Cached and cleaned up.
> +     */

What does "cached and cleaned up" mean here? (Same applies below)

> indexerconfig.h:59
> +     * The folders that should be excluded. Cached and cleaned up.
> +     * It is perfectly possible to include subfolders again.
> +     */

What does "perfectly possible" mean here? This might need one or more examples, or a link to how in- and ex-clusion works.

REPOSITORY
  R293 Baloo

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

To: michaelh, #baloo
Cc: adridg, #frameworks, michaelh
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20180221/d1a91cc8/attachment.html>