oggdec_filter.ggo: Add more documentation.
authorAndre Noll <maan@systemlinux.org>
Sun, 30 Nov 2008 14:24:58 +0000 (15:24 +0100)
committerAndre Noll <maan@systemlinux.org>
Sun, 30 Nov 2008 14:24:58 +0000 (15:24 +0100)
oggdec_filter.ggo

index 70f7345..f088b93 100644 (file)
@@ -1,2 +1,21 @@
-option "bufsize" b "size of output buffer" int typestr="kilobyte" default="128" optional
-option "initial_buffer" i "size of initial input buffer" int typestr="kilobyte" default="16" optional
+option "bufsize" b
+#~~~~~~~~~~~~~~~~~
+"size of output buffer"
+int typestr="kilobyte"
+default="128"
+optional
+details="
+       Increase this if you encounter output buffer overrun errors. Smaller
+       values make the oggdec filter use less memory.
+"
+
+option "initial_buffer" i
+#~~~~~~~~~~~~~~~~~~~~~~~~
+"size of initial input buffer"
+int typestr="kilobyte"
+default="16"
+optional
+details="
+       The oggdec filter waits until at least that many bytes are available
+       in the input buffer.
+"