consolidated IOV_MAX/UIO_MAXIOV handling per GLib + legacy behaviour for osx/ios
[platform/upstream/gstreamer.git] / gst / gstpluginfeature.c
index a436237..831236e 100644 (file)
  *
  * You should have received a copy of the GNU Library General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 
 /**
  * SECTION:gstpluginfeature
+ * @title: GstPluginfeature
  * @short_description: Base class for contents of a GstPlugin
  * @see_also: #GstPlugin
  *
@@ -81,7 +82,7 @@ gst_plugin_feature_finalize (GObject * object)
  * unaffected; use the return value instead.
  *
  * Normally this function is used like this:
- * |[
+ * |[<!-- language="C" -->
  * GstPluginFeature *loaded_feature;
  *
  * loaded_feature = gst_plugin_feature_load (feature);
@@ -90,7 +91,8 @@ gst_plugin_feature_finalize (GObject * object)
  * feature = loaded_feature;
  * ]|
  *
- * Returns: (transfer full): a reference to the loaded feature, or NULL on error
+ * Returns: (transfer full) (nullable): a reference to the loaded
+ * feature, or %NULL on error
  */
 GstPluginFeature *
 gst_plugin_feature_load (GstPluginFeature * feature)
@@ -185,8 +187,9 @@ gst_plugin_feature_get_rank (GstPluginFeature * feature)
  *
  * Get the plugin that provides this feature.
  *
- * Returns: (transfer full): the plugin that provides this feature, or %NULL.
- *     Unref with gst_object_unref() when no longer needed.
+ * Returns: (transfer full) (nullable): the plugin that provides this
+ *     feature, or %NULL.  Unref with gst_object_unref() when no
+ *     longer needed.
  */
 GstPlugin *
 gst_plugin_feature_get_plugin (GstPluginFeature * feature)
@@ -205,10 +208,11 @@ gst_plugin_feature_get_plugin (GstPluginFeature * feature)
  *
  * Get the name of the plugin that provides this feature.
  *
- * Returns: the name of the plugin that provides this feature, or %NULL if
- *     the feature is not associated with a plugin.
+ * Returns: (nullable): the name of the plugin that provides this
+ *     feature, or %NULL if the feature is not associated with a
+ *     plugin.
  *
- * Since: 1.2.0
+ * Since: 1.2
  */
 const gchar *
 gst_plugin_feature_get_plugin_name (GstPluginFeature * feature)
@@ -307,8 +311,8 @@ gst_plugin_feature_list_debug (GList * list)
  * Checks whether the given plugin feature is at least
  *  the required version
  *
- * Returns: #TRUE if the plugin feature has at least
- *  the required version, otherwise #FALSE.
+ * Returns: %TRUE if the plugin feature has at least
+ *  the required version, otherwise %FALSE.
  */
 gboolean
 gst_plugin_feature_check_version (GstPluginFeature * feature,
@@ -382,7 +386,7 @@ gst_plugin_feature_check_version (GstPluginFeature * feature,
  * Returns: negative value if the rank of p1 > the rank of p2 or the ranks are
  * equal but the name of p1 comes before the name of p2; zero if the rank
  * and names are equal; positive value if the rank of p1 < the rank of p2 or the
- * ranks are equal but the name of p2 comes after the name of p1
+ * ranks are equal but the name of p2 comes before the name of p1
  */
 gint
 gst_plugin_feature_rank_compare_func (gconstpointer p1, gconstpointer p2)
@@ -397,7 +401,7 @@ gst_plugin_feature_rank_compare_func (gconstpointer p1, gconstpointer p2)
   if (diff != 0)
     return diff;
 
-  diff = strcmp (GST_OBJECT_NAME (f2), GST_OBJECT_NAME (f1));
+  diff = strcmp (GST_OBJECT_NAME (f1), GST_OBJECT_NAME (f2));
 
   return diff;
 }