GstDevice: Document GstDevice and related classes

[platform/upstream/gstreamer.git] / gst / gstdevice.c

diff --git a/gst/gstdevice.c b/gst/gstdevice.c
index 36faf65..e67ec2c 100644 (file)
--- a/gst/gstdevice.c
+++ b/gst/gstdevice.c
@@ -19,6 +19,21 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:gstdevice
+ * @short_description: Object representing a device
+ * @see_also: #GstDeviceMonitor
+ *
+ * #GstDevice are objects representing a device, they contain
+ * relevant metadata about the device, such as its class and the #GstCaps
+ * representing the media types it can produce or handle.
+ *
+ * #GstDevice are created by #GstDeviceMonitor objects which can be
+ * aggregated by #GstGlobalDeviceMonitor objects.
+ *
+ * Since: 1.4
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -163,6 +178,9 @@ gst_device_set_property (GObject * object, guint prop_id,
  * @name: (allow-none): name of new element, or %NULL to automatically
  * create a unique name.
  *
+ * Creates the element with all of the required paramaters set to use
+ * this device.
+ *
  * Returns: (transfer full): a new #GstElement configured to use this device
  *
  * Since: 1.4