utils: Add a function to get a string representation of GstStateChange
[platform/upstream/gstreamer.git] / gst / gsttypefindfactory.c
index 26424d1..fe6b375 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:gsttypefindfactory
+ * @title: GstTypeFindFactory
  * @short_description: Information about registered typefind functions
  *
  * These functions allow querying informations about registered typefind
  * the section <link linkend="gstreamer-Writing-typefind-functions">
  * "Writing typefind functions"</link>.
  *
- * <example>
- *   <title>how to write a simple typefinder</title>
- *   <programlisting>
+ * The following example shows how to write a very simple typefinder that
+ * identifies the given data. You can get quite a bit more complicated than
+ * that though.
+ * |[<!-- language="C" -->
  *   typedef struct {
  *     guint8 *data;
  *     guint size;
  *     g_list_free (type_list);
  *     return find.caps;
  *   };
- *   </programlisting>
- * </example>
- *
- * The above example shows how to write a very simple typefinder that
- * identifies the given data. You can get quite a bit more complicated than
- * that though.
- *
- * Last reviewed on 2005-11-09 (0.9.4)
+ * ]|
  */
 
 #include "gst_private.h"
@@ -180,11 +175,11 @@ gst_type_find_factory_get_caps (GstTypeFindFactory * factory)
  *
  * Gets the extensions associated with a #GstTypeFindFactory. The returned
  * array should not be changed. If you need to change stuff in it, you should
- * copy it using g_strdupv().  This function may return NULL to indicate
+ * copy it using g_strdupv().  This function may return %NULL to indicate
  * a 0-length list.
  *
- * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): a
- *     NULL-terminated array of extensions associated with this factory
+ * Returns: (transfer none) (array zero-terminated=1) (element-type utf8) (nullable):
+ *     a %NULL-terminated array of extensions associated with this factory
  */
 const gchar *const *
 gst_type_find_factory_get_extensions (GstTypeFindFactory * factory)
@@ -231,7 +226,7 @@ gst_type_find_factory_call_function (GstTypeFindFactory * factory,
  * without typefind functions are a last-effort fallback mechanism to
  * e.g. assume a certain media type based on the file extension.
  *
- * Returns: TRUE if the factory has a typefind functions set, otherwise FALSE
+ * Returns: %TRUE if the factory has a typefind functions set, otherwise %FALSE
  */
 gboolean
 gst_type_find_factory_has_function (GstTypeFindFactory * factory)