From: Javier Jardón <javier.jardon@codethink.co.uk>
Date: Tue, 14 Jun 2011 14:35:16 +0000 (+0100)
Subject: moonshot-dbus-server: Document the get_identity IPC interface
X-Git-Tag: debian/0.0.2+20110913-1~12^2~11
X-Git-Url: http://www.project-moonshot.org/gitweb/?a=commitdiff_plain;h=42b57282145e0192e0cecf71be5eac7050c1feee;p=moonshot-ui.git

moonshot-dbus-server: Document the get_identity IPC interface
---

diff --git a/src/moonshot-dbus-server.vala b/src/moonshot-dbus-server.vala
index 6485f61..ace5ba2 100644
--- a/src/moonshot-dbus-server.vala
+++ b/src/moonshot-dbus-server.vala
@@ -8,6 +8,22 @@ public class MoonshotServer : Object {
         this.main_window = (MainWindow) window;
     }
 
+    /**
+     * This is the function used by the GSS mechanism to get the NAI,
+     * password and certificate of the ID card for the specificated service.
+     *
+     * The function will block until the user choose the ID card.
+     *
+     * @param nai NAI of the ID Card (optional)
+     * @param password Password of the ID Card (optional)
+     * @param service Service application request an ID Card for
+     * @param nai_out NAI stored in the ID Card
+     * @param password_out Password stored in the ID Card
+     * @param certificate Certificate stored in th ID Card
+     *
+     * @return true if the user choose a correct ID card for that service,
+     *         false otherwise.
+     */
     public async bool get_identity (string nai,
                                     string password,
                                     string service,