Author: dzzinstant
Date: Fri Jun  6 00:05:47 2014
New Revision: 16

URL: http://svn.gna.org/viewcvs/pidgin-zrtp?rev=16&view=rev
Log:
Function documentation for encrypt.h

Modified:
    trunk/src/pidgin-plugin/simplezrtp/encrypt.c
    trunk/src/pidgin-plugin/simplezrtp/encrypt.h

Modified: trunk/src/pidgin-plugin/simplezrtp/encrypt.c
URL: 
http://svn.gna.org/viewcvs/pidgin-zrtp/trunk/src/pidgin-plugin/simplezrtp/encrypt.c?rev=16&r1=15&r2=16&view=diff
==============================================================================
--- trunk/src/pidgin-plugin/simplezrtp/encrypt.c        (original)
+++ trunk/src/pidgin-plugin/simplezrtp/encrypt.c        Fri Jun  6 00:05:47 2014
@@ -312,7 +312,7 @@
 }
 /* */
 
-PurpleEncrypt *
+static PurpleEncrypt *
 purple_encrypt_new(PurpleMedia *media)
 {
        PurpleEncrypt *self = g_object_new(PURPLE_TYPE_ENCRYPT,

Modified: trunk/src/pidgin-plugin/simplezrtp/encrypt.h
URL: 
http://svn.gna.org/viewcvs/pidgin-zrtp/trunk/src/pidgin-plugin/simplezrtp/encrypt.h?rev=16&r1=15&r2=16&view=diff
==============================================================================
--- trunk/src/pidgin-plugin/simplezrtp/encrypt.h        (original)
+++ trunk/src/pidgin-plugin/simplezrtp/encrypt.h        Fri Jun  6 00:05:47 2014
@@ -45,9 +45,9 @@
 #define PURPLE_ENCRYPT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), 
PURPLE_TYPE_ENCRYPT, PurpleEncrypt))
 
 /**
- * Gets the type of the media encrypt object.
- *
- * @return The media encrypt's GType
+ * purple_encrypt_get_type:
+ *
+ * Returns: The GType for media encrypt objects
  */
 GType purple_encrypt_get_type(void);
 
@@ -58,22 +58,58 @@
 typedef struct _PurpleEncryptUiOps PurpleEncryptUiOps;
 struct _PurpleEncryptUiOps
 {
+       /**
+        * media_new:
+        * @self: The object that called the function.
+        *
+        * Update the encrypt UI when a new conference is established.
+        */
        void (*media_new) (PurpleEncrypt *self);
+       
+       /**
+        * media_new:
+        * @self: The object that called the function.
+        *
+        * Update the encrypt UI when the current conference is terminated.
+        */
        void (*media_end) (PurpleEncrypt *self);
 
+       /**
+        * call_new:
+        * @self: The object that called the function.
+        * @participant: Other party of the call.
+        *
+        * Update the encrypt UI when a new call is established.
+        */
        void (*call_new) (PurpleEncrypt *self, const gchar *participant);
+
+       /**
+        * call_end:
+        * @self: The object that called the function.
+        * @participant: Other party of the call.
+        *
+        * Update the encrypt UI when a current call is terminated.
+        */
        void (*call_end) (PurpleEncrypt *self, const gchar *participant);
 
        /**
-        * Displays an authentication message (e.g. an SAS) on the screen
-        *
-        * @param self The object that called the function
-        * @param info A short text containing the authentication string
+        * set_auth_msg:
+        * @self: The object that called the function.
+        * @info: A short text containing the authentication string.
+        *
+        * Displays an authentication message (e.g. an SAS) on the display.
         */
        void (*set_auth_msg)(PurpleEncrypt *self, const gchar *participant,
                        const gchar *msg, const gchar *info);
 
-       /** Show the current state of the connection to be encrypted */
+       /**
+        * update_auth_state:
+        * @self: The object that called the function.
+        * @participant: Other party of the call.
+        * @state: Set of flags indicating this call's status.
+        *
+        * Update the display state to the call status given.
+        */
        void (*update_auth_state)(PurpleEncrypt *self, const gchar *participant,
                        PurpleEncryptState state);
 
@@ -82,36 +118,103 @@
                        gpointer data);
 };
 
+/**
+ * purple_encrypt_setup:
+ * @plugin: The simplezrtp plugin.
+ *
+ * Prepares the use of PurpleEncrypt objects when the plugin
+ * is started.
+ */
 void purple_encrypt_setup(PurplePlugin *);
+
+/**
+ * purple_encrypt_teardown:
+ * @plugin: The simplezrtp plugin
+ *
+ * Cleans up when the plugin is deactivated.
+ */
 void purple_encrypt_teardown(PurplePlugin *);
 
+/**
+ * purple_encrypt_get_ui_ops:
+ *
+ * Returns: Interface implementation for display control functions.
+ */
 PurpleEncryptUiOps* purple_encrypt_get_ui_ops(void);
+
+/**
+ * purple_encrypt_set_ui_ops:
+ * @ui_ops: Interface implementation functions to use for display control.
+ */
 void purple_encrypt_set_ui_ops(PurpleEncryptUiOps *ui_ops);
 /**/
 
-/*
+/**
  * Callbacks from UI
+ **/
+
+/**
+ * purple_encrypt_get_ui_data:
+ * @self: This encrypt object.
+ *
+ * Returns: Pointer to the associated object for display control of encryption.
  */
 gpointer purple_encrypt_get_ui_data(PurpleEncrypt *self);
+
+/**
+ * purple_encrypt_set_ui_data:
+ * @self: This encrypt object.
+ * @ui_data: Pointer to the display control object.
+ *
+ * Stores the associated object for display control of encryption.
+ */
 void purple_encrypt_set_ui_data(PurpleEncrypt *self, gpointer ui_data);
 
+/**
+ * purple_encrypt_verified_cb:
+ * @self: This encrypt object.
+ * @participant: Other party of the call.
+ * @yesno: Authentication flag has been set (if FALSE: reset) in the UI.
+ */
 void purple_encrypt_verified_cb(PurpleEncrypt *self, const gchar *participant, 
                gboolean yesno);
 
-/*
- * Events from encrypt backend
- */
+/**
+ * Callbacks from encrypt backend
+ **/
 void purple_encrypt_error(PurpleEncrypt *self, const gchar *errormsg);
 
-/*
- * Callbacks from encrypt backend
- */
-PurpleEncrypt* purple_encrypt_new(PurpleMedia *media);
+/**
+ * Local storage of PurpleEncrypt objects
+ **/
+
+/**
+ * purple_encrypt_find:
+ * @media: A PurpleMedia object.
+ *
+ * Returns: The PurpleEncrypt object associated with the media object,
+ *          if it already exists.
+ */
 PurpleEncrypt* purple_encrypt_find(PurpleMedia *media);
+
+/**
+ * purple_encrypt_get:
+ * @media: A PurpleMedia object.
+ *
+ * Returns: The PurpleEncrypt object associated with the media object.
+ */
 PurpleEncrypt* purple_encrypt_get(PurpleMedia *media);
 
-/*
+/**
  * Call handling
+ **/
+
+/**
+ * purple_encrypt_find_call:
+ * @self: This encrypt object.
+ * @participant: Name of the remote party of the call.
+ *
+ * Returns: The call struct managing encryption to this participant.
  */
 PurpleEncryptCall * purple_encrypt_find_call(PurpleEncrypt *self,
                const gchar *participant);


_______________________________________________
Pidgin-zrtp-commits mailing list
Pidgin-zrtp-commits@gna.org
https://mail.gna.org/listinfo/pidgin-zrtp-commits

Reply via email to