From afb37d706f2cf63ebc9b5b3f92dc7a0163f2dc1b Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Thu, 3 Sep 2015 10:22:29 +0200 Subject: [PATCH] secret-agent/trivial: add code comment --- src/settings/nm-secret-agent.c | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/settings/nm-secret-agent.c b/src/settings/nm-secret-agent.c index d77f5e0e29..ca30d46211 100644 --- a/src/settings/nm-secret-agent.c +++ b/src/settings/nm-secret-agent.c @@ -446,6 +446,17 @@ do_cancel_secrets (NMSecretAgent *self, Request *r, gboolean disposing) } } +/** + * nm_secret_agent_cancel_secrets: + * @self: #NMSecretAgent instance + * @call_id: the call id to cancel + * + * It is an error to pass an invalid @call_id or a @call_id for an operation + * that already completed. NMSecretAgent will always invoke the callback, + * also for cancel() and dispose(). + * In case of nm_secret_agent_cancel_secrets() this will synchronously invoke the + * callback before nm_secret_agent_cancel_secrets() returns. + */ void nm_secret_agent_cancel_secrets (NMSecretAgent *self, NMSecretAgentCallId call_id) {