pidgin.next.minor: 05dd5981: Document the remaining functions.

[maiku at pidgin.im]

-----------------------------------------------------------------
Revision: 05dd5981b1d45b6c50889647999586b510a4e3a0
Ancestor: c37447bac634b00d5043b862e30afae3eae882de
Author: maiku at pidgin.im
Date: 2009-11-13T21:46:01
Branch: im.pidgin.pidgin.next.minor
URL: http://d.pidgin.im/viewmtn/revision/info/05dd5981b1d45b6c50889647999586b510a4e3a0

Modified files:
        libpurple/media/codec.h

ChangeLog: 

Document the remaining functions.

-------------- next part --------------
============================================================
--- libpurple/media/codec.h	92ffbe395b3e4434224440acb50df2d039fc2c65
+++ libpurple/media/codec.h	7749597290ec9ea5db31d0b7c606a677f34c449d
@@ -70,10 +70,61 @@ PurpleMediaCodec *purple_media_codec_new
 PurpleMediaCodec *purple_media_codec_new(int id, const char *encoding_name,
 		PurpleMediaSessionType media_type, guint clock_rate);
 
+/**
+ * Gets the codec id.
+ *
+ * @param The codec to get the id from.
+ *
+ * @return The codec id.
+ *
+ * @since 2.6.0
+ */
 guint purple_media_codec_get_id(PurpleMediaCodec *codec);
+
+/**
+ * Gets the encoding name.
+ *
+ * @param The codec to get the encoding name from.
+ *
+ * @return The encoding name.
+ *
+ * @since 2.6.0
+ */
 gchar *purple_media_codec_get_encoding_name(PurpleMediaCodec *codec);
+
+/**
+ * Gets the clock rate.
+ *
+ * @param The codec to get the clock rate from.
+ *
+ * @return The clock rate.
+ *
+ * @since 2.6.0
+ */
 guint purple_media_codec_get_clock_rate(PurpleMediaCodec *codec);
+
+/**
+ * Gets the number of channels.
+ *
+ * @param The codec to get the number of channels from.
+ *
+ * @return The number of channels.
+ *
+ * @since 2.6.0
+ */
 guint purple_media_codec_get_channels(PurpleMediaCodec *codec);
+
+/**
+ * Gets a list of the optional parameters.
+ *
+ * The list consists of PurpleKeyValuePair's. 
+ *
+ * @param The codec to get the optional parameters from.
+ *
+ * @return The list of optional parameters.
+ *
+ * @since 2.6.0
+ */
 GList *purple_media_codec_get_optional_parameters(PurpleMediaCodec *codec);
 
 /**