[FFmpeg-cvslog] vf_drawtext: use @itemize environment for showing examples in docs

Stefano Sabatini git at videolan.org
Thu Sep 22 00:48:58 CEST 2011


ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Tue Sep 20 12:48:25 2011 +0200| [751df79d29b0eec90402d5488280d545286adb7d] | committer: Stefano Sabatini

vf_drawtext: use @itemize environment for showing examples in docs

Beautify.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=751df79d29b0eec90402d5488280d545286adb7d
---

 doc/filters.texi |   24 +++++++++++++++---------
 1 files changed, 15 insertions(+), 9 deletions(-)

diff --git a/doc/filters.texi b/doc/filters.texi
index fc33acc..36ba75c 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -809,28 +809,34 @@ The size in number of spaces to use for rendering the tab.
 Default value is 4.
 @end table
 
-For example the command:
- at example
-drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
- at end example
+Some examples follow.
 
-will draw "Test Text" with font FreeSerif, using the default values
-for the optional parameters.
+ at itemize
+
+ at item
+Draw "Test Text" with font FreeSerif, using the default values for the
+optional parameters.
 
-The command:
 @example
-drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
-          x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
+drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
 @end example
 
+ at item
 will draw 'Test Text' with font FreeSerif of size 24 at position x=100
 and y=50 (counting from the top-left corner of the screen), text is
 yellow with a red box around it. Both the text and the box have an
 opacity of 20%.
 
+ at example
+drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
+          x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
+ at end example
+
 Note that the double quotes are not necessary if spaces are not used
 within the parameter list.
 
+ at end itemize
+
 For more information about libfreetype, check:
 @url{http://www.freetype.org/}.
 



More information about the ffmpeg-cvslog mailing list