gst/: Some minor docs fixes: fix typo, mention that GST_FLOW_RESEND is unused and unimplemented; finally, it is plugi...

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.
This commit is contained in:
Tim-Philipp Müller 2008-02-05 21:22:47 +00:00
parent 3b88553fe6
commit 168e31f2e0
3 changed files with 14 additions and 6 deletions

View file

@ -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:

View file

@ -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.

View file

@ -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,