lib-imap-client: Add comment to imapc_client_get_capabilities()

diff --git a/src/lib-imap-client/imapc-client.h b/src/lib-imap-client/imapc-client.h
index 0302297534d5198c0c3adc5928403e7c72d58e87..2fcd6455eb192093949e60ae662c707bc9b5de75 100644 (file)
--- a/src/lib-imap-client/imapc-client.h
+++ b/src/lib-imap-client/imapc-client.h
@@ -198,6 +198,8 @@ imapc_client_mailbox_get_msgmap(struct imapc_client_mailbox *box);
 void imapc_client_mailbox_idle(struct imapc_client_mailbox *box);
 bool imapc_client_mailbox_is_opened(struct imapc_client_mailbox *box);
 
+/* Get the server capabilities. If it fails, the error is seen and handled by
+   the login callback. */
 int imapc_client_get_capabilities(struct imapc_client *client,
                                  enum imapc_capability *capabilities_r);