gst/: Some minor docs fixes: fix typo, mention that GST_FLOW_RESEND is unused and...

Original commit message from CVS:
* gst/gstpad.h: (GST_PAD_LINK_SUCCESSFUL):
* gst/gstpluginfeature.h: (GstPluginFeatureClass):
Some minor docs fixes: fix typo, mention that GST_FLOW_RESEND is
unused and unimplemented; finally, it is plugin features, not
plugins, that have ranks.

diff --git a/ChangeLog b/ChangeLog
index c41d292..60ac137 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2008-02-05  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * gst/gstpad.h: (GST_PAD_LINK_SUCCESSFUL):
+       * gst/gstpluginfeature.h: (GstPluginFeatureClass):
+         Some minor docs fixes: fix typo, mention that GST_FLOW_RESEND is
+         unused and unimplemented; finally, it is plugin features, not
+         plugins, that have ranks.
+         
 2008-02-05  Stefan Kost  <ensonic@users.sf.net>
 
        * gst/gstpluginfeature.h:

diff --git a/gst/gstpad.h b/gst/gstpad.h
index 3e6d942..2adbcc4 100644 (file)
--- a/gst/gstpad.h
+++ b/gst/gstpad.h
@@ -95,7 +95,7 @@ typedef enum {
  *                               this to define custom success codes.
  *                               Since 0.10.7.
  * @GST_FLOW_RESEND:            Resend buffer, possibly with new caps (not
- *                                 send yet).
+ *                                 sent yet) (unused/unimplemented).
  * @GST_FLOW_OK:                Data passing was ok.
  * @GST_FLOW_NOT_LINKED:        Pad is not linked.
  * @GST_FLOW_WRONG_STATE:       Pad is in wrong state.

diff --git a/gst/gstpluginfeature.h b/gst/gstpluginfeature.h
index 2e49d54..f16b3c6 100644 (file)
--- a/gst/gstpluginfeature.h
+++ b/gst/gstpluginfeature.h
@@ -56,12 +56,12 @@ typedef struct _GstPluginFeatureClass GstPluginFeatureClass;
  * @GST_RANK_PRIMARY: will be chosen first
  *
  * Element priority ranks. Defines the order in which the autoplugger (or
- * similar rank-picking mechanisms) will choose this element over an alternative
- * one with the same function.
+ * similar rank-picking mechanisms, such as e.g. gst_element_make_from_uri())
+ * will choose this element over an alternative one with the same function.
  *
- * These constants serve as a rough guidiance for defining the rank of a
- * #GstPlugin using gst_plugin_feature_set_rank() - any value including those
- * bigger than @GST_RANK_PRIMARY are valid.
+ * These constants serve as a rough guidance for defining the rank of a
+ * #GstPluginFeature. Any value is valid, including values bigger than
+ * @GST_RANK_PRIMARY.
  */
 typedef enum {
   GST_RANK_NONE                 = 0,