Mercurial > pidgin3 / file diff

--- a/libpurple/media/backend-iface.h	Wed Jan 29 05:28:33 2014 +0530
+++ b/libpurple/media/backend-iface.h	Wed Jan 29 05:29:11 2014 +0530
@@ -39,9 +39,18 @@
 #define PURPLE_MEDIA_BACKEND(obj)		(G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_BACKEND, PurpleMediaBackend))
 #define PURPLE_MEDIA_BACKEND_GET_INTERFACE(inst)(G_TYPE_INSTANCE_GET_INTERFACE((inst), PURPLE_TYPE_MEDIA_BACKEND, PurpleMediaBackendIface))
 
-/** A placeholder to represent any media backend */
+/**
+ * PurpleMediaBackend:
+ *
+ * A placeholder to represent any media backend
+ */
 typedef struct _PurpleMediaBackend PurpleMediaBackend;
-/** A structure to derive media backends from. */
+
+/**
+ * PurpleMediaBackendIface:
+ *
+ * A structure to derive media backends from.
+ */
 typedef struct _PurpleMediaBackendIface PurpleMediaBackendIface;
 
 struct _PurpleMediaBackendIface
@@ -74,6 +83,8 @@
 };
 
 /**
+ * purple_media_backend_get_type:
+ *
  * Gets the media backend's GType.
  *
  * Returns: The media backend's GType.
@@ -81,8 +92,7 @@
 GType purple_media_backend_get_type(void);
 
 /**
- * Creates and adds a stream to the media backend.
- *
+ * purple_media_backend_add_stream:
  * @self: The backend to add the stream to.
  * @sess_id: The session id of the stream to add.
  * @who: The remote participant of the stream to add.
@@ -92,6 +102,8 @@
  * @num_params: The number of parameters in the param parameter.
  * @params: The additional parameters to pass when creating the stream.
  *
+ * Creates and adds a stream to the media backend.
+ *
  * Returns: True if the stream was successfully created, othewise False.
  */
 gboolean purple_media_backend_add_stream(PurpleMediaBackend *self,
@@ -101,65 +113,70 @@
 		guint num_params, GParameter *params);
 
 /**
- * Add remote candidates to a stream.
- *
+ * purple_media_backend_add_remote_candidates:
  * @self: The backend the stream is in.
  * @sess_id: The session id associated with the stream.
  * @participant: The participant associated with the stream.
  * @remote_candidates: The list of remote candidates to add.
+ *
+ * Add remote candidates to a stream.
  */
 void purple_media_backend_add_remote_candidates(PurpleMediaBackend *self,
 		const gchar *sess_id, const gchar *participant,
 		GList *remote_candidates);
 
 /**
+ * purple_media_backend_codecs_ready:
+ * @self: The media backend the session is in.
+ * @sess_id: The session id of the session to check.
+ *
  * Get whether or not a session's codecs are ready.
  *
  * A codec is ready if all of the attributes and additional
  * parameters have been collected.
  *
- * @self: The media backend the session is in.
- * @sess_id: The session id of the session to check.
- *
  * Returns: True if the codecs are ready, otherwise False.
  */
 gboolean purple_media_backend_codecs_ready(PurpleMediaBackend *self,
 		const gchar *sess_id);
 
 /**
+ * purple_media_backend_get_codecs:
+ * @self: The media backend the session is in.
+ * @sess_id: The session id of the session to use.
+ *
  * Gets the codec intersection list for a session.
  *
  * The intersection list consists of all codecs that are compatible
  * between the local and remote software.
  *
- * @self: The media backend the session is in.
- * @sess_id: The session id of the session to use.
- *
  * Returns: The codec intersection list.
  */
 GList *purple_media_backend_get_codecs(PurpleMediaBackend *self,
 		const gchar *sess_id);
 
 /**
- * Gets the list of local candidates for a stream.
- *
+ * purple_media_backend_get_local_candidates:
  * @self: The media backend the stream is in.
  * @sess_id: The session id associated with the stream.
  * @particilant: The participant associated with the stream.
  *
+ * Gets the list of local candidates for a stream.
+ *
  * Returns: The list of local candidates.
  */
 GList *purple_media_backend_get_local_candidates(PurpleMediaBackend *self,
 		const gchar *sess_id, const gchar *participant);
 
 /**
- * Sets the remote codecs on a stream.
- *
+ * purple_media_backend_set_remote_codecs:
  * @self: The media backend the stream is in.
  * @sess_id: The session id the stream is associated with.
  * @participant: The participant the stream is associated with.
  * @codecs: The list of remote codecs to set.
  *
+ * Sets the remote codecs on a stream.
+ *
  * Returns: True if the remote codecs were set successfully, otherwise False.
  */
 gboolean purple_media_backend_set_remote_codecs(PurpleMediaBackend *self,
@@ -167,34 +184,36 @@
 		GList *codecs);
 
 /**
- * Sets which codec format to send media content in for a session.
- *
+ * purple_media_backend_set_send_codec:
  * @self: The media backend the session is in.
  * @sess_id: The session id of the session to set the codec for.
  * @codec: The codec to set.
  *
+ * Sets which codec format to send media content in for a session.
+ *
  * Returns: True if set successfully, otherwise False.
  */
 gboolean purple_media_backend_set_send_codec(PurpleMediaBackend *self,
 		const gchar *sess_id, PurpleMediaCodec *codec);
 
 /**
- * Sets various optional parameters of the media backend.
- *
+ * purple_media_backend_set_params:
  * @self: The media backend to set the parameters on.
  * @num_params: The number of parameters to pass to backend
  * @params: Array of @c GParameter to pass to backend
+ *
+ * Sets various optional parameters of the media backend.
  */
 void purple_media_backend_set_params(PurpleMediaBackend *self,
 		guint num_params, GParameter *params);
 
 /**
+ * purple_media_backend_get_available_params:
+ * @self: The media backend
+ *
  * Gets the list of optional parameters supported by the media backend.
- *
  * The list should NOT be freed.
  *
- * @self: The media backend
- *
  * Returns: NULL-terminated array of names of supported parameters.
  */
 const gchar **purple_media_backend_get_available_params(PurpleMediaBackend *self);