Expose macro to docs and fix link to it.

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstpad.c:
* gst/gstpad.h:
Expose macro to docs and fix link to it.

diff --git a/ChangeLog b/ChangeLog
index 9033765..977966e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-03-27  Stefan Kost  <ensonic@users.sf.net>
+
+       * docs/gst/gstreamer-sections.txt:
+       * gst/gstpad.c:
+       * gst/gstpad.h:
+         Expose macro to docs and fix link to it.
+
 2008-03-27  Michael Smith <msmith@fluendo.com>
 
        * libs/gst/dataprotocol/dataprotocol.c:

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index fe6f0d5..8da5201 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -1340,6 +1340,8 @@ gst_pad_stop_task
 
 gst_pad_set_active
 
+GST_PAD_CAPS
+
 GST_PAD_GET_STREAM_LOCK
 GST_PAD_STREAM_LOCK
 GST_PAD_STREAM_LOCK_FULL
@@ -1378,7 +1380,6 @@ GST_PAD_PARENT
 GST_PAD_ELEMENT_PRIVATE
 GST_PAD_PAD_TEMPLATE
 GST_PAD_DIRECTION
-GST_PAD_CAPS
 GST_PAD_PEER
 GST_PAD_IS_LINKED
 GST_PAD_IS_SRC

diff --git a/gst/gstpad.c b/gst/gstpad.c
index 5f66811..9458321 100644 (file)
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@@ -2038,7 +2038,7 @@ done:
  *
  * Gets the capabilities this pad can produce or consume.
  * Note that this method doesn't necessarily return the caps set by
- * gst_pad_set_caps() - use #GST_PAD_CAPS for that instead.
+ * gst_pad_set_caps() - use GST_PAD_CAPS() for that instead.
  * gst_pad_get_caps returns all possible caps a pad can operate with, using
  * the pad's get_caps function;
  * this returns the pad template caps if not explicitly set.

diff --git a/gst/gstpad.h b/gst/gstpad.h
index 2adbcc4..4c41d96 100644 (file)
--- a/gst/gstpad.h
+++ b/gst/gstpad.h
@@ -647,6 +647,12 @@ struct _GstPadClass {
 #define GST_PAD_LINKFUNC(pad)          (GST_PAD_CAST(pad)->linkfunc)
 #define GST_PAD_UNLINKFUNC(pad)                (GST_PAD_CAST(pad)->unlinkfunc)
 
+/**
+ * GST_PAD_CAPS:
+ * @pad: a #GstPad.
+ *
+ * The caps for this pad.
+ */
 #define GST_PAD_CAPS(pad)              (GST_PAD_CAST(pad)->caps)
 #define GST_PAD_GETCAPSFUNC(pad)       (GST_PAD_CAST(pad)->getcapsfunc)
 #define GST_PAD_SETCAPSFUNC(pad)       (GST_PAD_CAST(pad)->setcapsfunc)