fts: fts_build_mail() - Update comment in header file

diff --git a/src/plugins/fts/fts-build-mail.h b/src/plugins/fts/fts-build-mail.h
index aed4413f470a9e561f265d35569ba986e6a35a05..d2cb0fd6bd9e6f6411b538b4d7a4ce18d051dd78 100644 (file)
--- a/src/plugins/fts/fts-build-mail.h
+++ b/src/plugins/fts/fts-build-mail.h
@@ -1,8 +1,11 @@
 #ifndef FTS_BUILD_MAIL_H
 #define FTS_BUILD_MAIL_H
 
-/* Build indexes for the given mail. Returns 0 on success, -1 on error.
-   The error is set to mail's storage. */
+/* Build indexes for the given mail.
+   Returns -1 on error, The error is set to mail's storage.
+   Returns  0 on ignored error (retry limit reached and mail not built,
+                                see comments in function implementation)
+   Returns  1 on success */
 int fts_build_mail(struct fts_backend_update_context *update_ctx,
                   struct mail *mail);