# HG changeset patch # User maiku@pidgin.im # Date 1251604339 0 # Node ID 713987ae32156880d7fd2fab4350ebd4c3d18fee # Parent 614a40c68b88847096286efe4255db24768703fb Fix some docs warnings. Thanks to darkrain for pointing them out. diff -r 614a40c68b88 -r 713987ae3215 libpurple/media-gst.h --- a/libpurple/media-gst.h Sun Aug 30 03:08:27 2009 +0000 +++ b/libpurple/media-gst.h Sun Aug 30 03:52:19 2009 +0000 @@ -42,7 +42,7 @@ #define PURPLE_IS_MEDIA_ELEMENT_INFO_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_ELEMENT_INFO)) #define PURPLE_MEDIA_ELEMENT_INFO_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_ELEMENT_INFO, PurpleMediaElementInfo)) -/** @copydoc _PurpleMediaElementInfo */ +/** An opaque structure representing an audio/video source/sink. */ typedef struct _PurpleMediaElementInfo PurpleMediaElementInfo; typedef struct _PurpleMediaElementInfoClass PurpleMediaElementInfoClass; typedef GstElement *(*PurpleMediaElementCreateCallback)(PurpleMedia *media, @@ -138,6 +138,9 @@ * * @param manager The media manager to use to obtain the source/sink. * @param type The type of source/sink to get. + * @param media The media call this element is requested for. + * @param session_id The id of the session this element is requested for or NULL. + * @param participant The remote user this element is requested for or NULL. * * @since 2.6.0 */ diff -r 614a40c68b88 -r 713987ae3215 libpurple/media.h --- a/libpurple/media.h Sun Aug 30 03:08:27 2009 +0000 +++ b/libpurple/media.h Sun Aug 30 03:52:19 2009 +0000 @@ -59,11 +59,11 @@ #define PURPLE_MEDIA_TYPE_STATE (purple_media_state_changed_get_type()) #define PURPLE_MEDIA_TYPE_INFO_TYPE (purple_media_info_type_get_type()) -/** @copydoc _PurpleMedia */ +/** An opaque structure representing a media call. */ typedef struct _PurpleMedia PurpleMedia; -/** @copydoc _PurpleMediaCandidate */ +/** An opaque structure representing a network candidate (IP Address and port pair). */ typedef struct _PurpleMediaCandidate PurpleMediaCandidate; -/** @copydoc _PurpleMediaCodec */ +/** An opaque structure representing an audio or video codec. */ typedef struct _PurpleMediaCodec PurpleMediaCodec; /** Media caps */ @@ -559,6 +559,7 @@ * @param media The media object to find the session in. * @param sess_id The session id of the session find the stream in. * @param participant The name of the remote user to set the candidates from. + * @param codecs The list of remote codecs to set. * * @return @c TRUE The codecs were set successfully, or @c FALSE otherwise. * diff -r 614a40c68b88 -r 713987ae3215 libpurple/mediamanager.h --- a/libpurple/mediamanager.h Sun Aug 30 03:08:27 2009 +0000 +++ b/libpurple/mediamanager.h Sun Aug 30 03:52:19 2009 +0000 @@ -30,9 +30,9 @@ #include #include -/** @copydoc _PurpleMediaManager */ +/** An opaque structure representing a group of (usually all) media calls. */ typedef struct _PurpleMediaManager PurpleMediaManager; -/** @copydoc _PurpleMediaManagerClass */ +/** The GObject class structure of the PurpleMediaManager object. */ typedef struct _PurpleMediaManagerClass PurpleMediaManagerClass; #include "account.h" @@ -81,6 +81,7 @@ * @param account The account to create the session on. * @param conference_type The conference type to feed into Farsight2. * @param remote_user The remote user to initiate the session with. + * @param initiator TRUE if the local user is the initiator of this media call, FALSE otherwise. * * @return A newly created media session. *