pidgin: c6e09fb8: Fix some docs warnings. Thanks to darkra...

[maiku at pidgin.im]

-----------------------------------------------------------------
Revision: c6e09fb86a5c8b77bc7c407068ff7e80801416e0
Ancestor: cde037f8fe052890ef9e9eee6d447b7622bb8417
Author: maiku at pidgin.im
Date: 2009-08-30T03:52:19
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/c6e09fb86a5c8b77bc7c407068ff7e80801416e0

Modified files:
        libpurple/media-gst.h libpurple/media.h
        libpurple/mediamanager.h

ChangeLog: 

Fix some docs warnings. Thanks to darkrain for pointing them out.

-------------- next part --------------
============================================================
--- libpurple/media-gst.h	4652662e6b29a1c4fb88bc8453c839a4b4c3061d
+++ libpurple/media-gst.h	6d852ca007508509aa0d12982e16ab2f7d986462
@@ -42,7 +42,7 @@ G_BEGIN_DECLS
 #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 @@ GstElement *purple_media_manager_get_pip
  *
  * @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
  */
============================================================
--- libpurple/media.h	8c729897a09e3d7ac6c8d9a150bb350933611262
+++ libpurple/media.h	60dc6a425505471da2a0acef36df24329b0db7d4
@@ -59,11 +59,11 @@ G_BEGIN_DECLS
 #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 @@ GList *purple_media_get_active_remote_ca
  * @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.
  *
============================================================
--- libpurple/mediamanager.h	ce8143ff8690debfaab76bbf7a15923fcbf970a6
+++ libpurple/mediamanager.h	df11ffa73dc52beaac535443f4cf7577286fcff3
@@ -30,9 +30,9 @@
 #include <glib.h>
 #include <glib-object.h>
 
-/** @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 @@ PurpleMediaManager *purple_media_manager
  * @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.
  *