Update docs for gst_pad_create_stream_id_printf()
authorDavid Schleef <ds@schleef.org>
Tue, 26 Mar 2013 01:11:54 +0000 (18:11 -0700)
committerDavid Schleef <ds@schleef.org>
Tue, 26 Mar 2013 01:50:41 +0000 (18:50 -0700)
To indicate that format strings should be alpha sortable.

gst/gstutils.c

index daf1ba8..5df5df8 100644 (file)
@@ -3699,6 +3699,10 @@ gst_pad_create_stream_id_printf (GstPad * pad, GstElement * parent,
  * handler interface should ideally generate a unique, deterministic
  * stream-id manually instead.
  *
+ * Since stream IDs are sorted alphabetically, any numbers in the
+ * stream ID should be printed with a fixed number of characters,
+ * preceded by 0's, such as by using the format %%03u instead of %%u.
+ *
  * Returns: A stream-id for @pad. g_free() after usage.
  */
 gchar *