/soc/2013/ankitkv/gobjectification: 9b6661893d92: Add 'symbol_na...
Ankit Vani
a at nevitus.org
Tue Jan 28 19:01:20 EST 2014
Changeset: 9b6661893d92ee949b863b8498bcd239627a5860
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-29 05:29 +0530
Branch: soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/9b6661893d92
Description:
Add 'symbol_name:' to doc comments in libpurple/media/*.h
diffstat:
libpurple/media/backend-fs2.h | 8 +++-
libpurple/media/backend-iface.h | 65 ++++++++++++++++++----------
libpurple/media/candidate.h | 92 ++++++++++++++++++++++++----------------
libpurple/media/codec.h | 73 ++++++++++++++++++++------------
libpurple/media/enum-types.h | 54 ++++++++++++++++++++---
5 files changed, 198 insertions(+), 94 deletions(-)
diffs (truncated from 770 to 300 lines):
diff --git a/libpurple/media/backend-fs2.h b/libpurple/media/backend-fs2.h
--- a/libpurple/media/backend-fs2.h
+++ b/libpurple/media/backend-fs2.h
@@ -43,10 +43,16 @@ G_BEGIN_DECLS
#define PURPLE_MEDIA_BACKEND_FS2_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_BACKEND_FS2, PurpleMediaBackendFs2))
#define PURPLE_MEDIA_BACKEND_FS2_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_BACKEND_FS2, PurpleMediaBackendFs2))
-/** An opaque structure representing the Farsight 2 media backend. */
+/**
+ * PurpleMediaBackendFs2:
+ *
+ * An opaque structure representing the Farsight 2 media backend.
+ */
typedef struct _PurpleMediaBackendFs2 PurpleMediaBackendFs2;
/**
+ * purple_media_backend_fs2_get_type:
+ *
* Gets the type of the Farsight 2 media backend object.
*
* Returns: The Farsight 2 media backend's GType
diff --git a/libpurple/media/backend-iface.h b/libpurple/media/backend-iface.h
--- a/libpurple/media/backend-iface.h
+++ b/libpurple/media/backend-iface.h
@@ -39,9 +39,18 @@ G_BEGIN_DECLS
#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 @@ struct _PurpleMediaBackendIface
};
/**
+ * purple_media_backend_get_type:
+ *
* Gets the media backend's GType.
*
* Returns: The media backend's GType.
@@ -81,8 +92,7 @@ struct _PurpleMediaBackendIface
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 @@ GType purple_media_backend_get_type(void
* @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 @@ gboolean purple_media_backend_add_stream
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 @@ gboolean purple_media_backend_set_remote
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);
diff --git a/libpurple/media/candidate.h b/libpurple/media/candidate.h
--- a/libpurple/media/candidate.h
+++ b/libpurple/media/candidate.h
@@ -40,10 +40,17 @@ G_BEGIN_DECLS
#define PURPLE_MEDIA_CANDIDATE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate))
#define PURPLE_MEDIA_CANDIDATE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate))
-/** An opaque structure representing a network candidate (IP Address and port pair). */
+/**
+ * PurpleMediaCandidate:
+ *
+ * An opaque structure representing a network candidate (IP Address and port
+ * pair).
+ */
typedef struct _PurpleMediaCandidate PurpleMediaCandidate;
/**
+ * purple_media_candidate_get_type:
+ *
* Gets the type of the media candidate structure.
*
* Returns: The media canditate's GType
@@ -51,8 +58,7 @@ typedef struct _PurpleMediaCandidate Pur
GType purple_media_candidate_get_type(void);
/**
- * Creates a PurpleMediaCandidate instance.
- *
+ * purple_media_candidate_new:
* @foundation: The foundation of the candidate.
* @component_id: The component this candidate is for.
* @type: The type of candidate.
@@ -60,6 +66,8 @@ GType purple_media_candidate_get_type(vo
* @ip: The IP address of this component.
* @port: The network port.
*
+ * Creates a PurpleMediaCandidate instance.
+ *
* Returns: The newly created PurpleMediaCandidate instance.
*/
PurpleMediaCandidate *purple_media_candidate_new(
@@ -69,145 +77,157 @@ PurpleMediaCandidate *purple_media_candi
const gchar *ip, guint port);
/**
+ * purple_media_candidate_copy:
+ * @candidate: The candidate to copy.
+ *
* Copies a PurpleMediaCandidate.
*
- * @candidate: The candidate to copy.
- *
* Returns: The copy of the PurpleMediaCandidate.
*/
PurpleMediaCandidate *purple_media_candidate_copy(
PurpleMediaCandidate *candidate);
/**
+ * purple_media_candidate_list_copy:
+ * @candidates: The list of candidates to be copied.
+ *
* Copies a GList of PurpleMediaCandidate and its contents.
*
- * @candidates: The list of candidates to be copied.
- *
* Returns: The copy of the GList.
*/
GList *purple_media_candidate_list_copy(GList *candidates);
/**
+ * purple_media_candidate_list_free:
+ * @candidates: The list of candidates to be freed.
+ *
* Frees a GList of PurpleMediaCandidate and its contents.
- *
- * @candidates: The list of candidates to be freed.
*/
void purple_media_candidate_list_free(GList *candidates);
/**
+ * purple_media_candidate_get_foundation:
+ * @candidate: The candidate to get the foundation from.
+ *
* Gets the foundation (identifier) from the candidate.
*
- * @candidate: The candidate to get the foundation from.
- *
* Returns: The foundation.
*/
gchar *purple_media_candidate_get_foundation(PurpleMediaCandidate *candidate);
/**
+ * purple_media_candidate_get_component_id:
+ * @candidate: The candidate to get the compnent id from.
+ *
* Gets the component id (rtp or rtcp)
*
- * @candidate: The candidate to get the compnent id from.
- *
* Returns: The component id.
More information about the Commits
mailing list