[FFmpeg-devel] [PATCH] doc: extend "See Also" chapters in component manuals

Stefano Sabatini stefasab at gmail.com
Tue Dec 18 01:08:36 CET 2012


In particular, make "See Also" chapter rendered in HTML output.
---
 doc/ffmpeg-bitstream-filters.texi |   15 +++++++++++----
 doc/ffmpeg-codecs.texi            |   15 +++++++++++----
 doc/ffmpeg-filters.texi           |   15 +++++++++++----
 doc/ffmpeg-formats.texi           |   15 +++++++++++----
 doc/ffmpeg-protocols.texi         |   15 +++++++++++----
 doc/ffmpeg-resampler.texi         |   15 +++++++++++----
 doc/ffmpeg-scaler.texi            |   13 +++++++++----
 doc/ffmpeg-utils.texi             |   15 +++++++++++----
 8 files changed, 86 insertions(+), 32 deletions(-)

diff --git a/doc/ffmpeg-bitstream-filters.texi b/doc/ffmpeg-bitstream-filters.texi
index 295eacb..21133f0 100644
--- a/doc/ffmpeg-bitstream-filters.texi
+++ b/doc/ffmpeg-bitstream-filters.texi
@@ -22,6 +22,17 @@ bitstream level modifications without performing decoding.
 
 @include bitstream_filters.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{libavcodec.html,libavcodec}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -29,10 +40,6 @@ bitstream level modifications without performing decoding.
 @setfilename ffmpeg-bitstream-filters
 @settitle FFmpeg bistream filters
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffmpeg-codecs.texi b/doc/ffmpeg-codecs.texi
index 80b1839..b6d123a 100644
--- a/doc/ffmpeg-codecs.texi
+++ b/doc/ffmpeg-codecs.texi
@@ -1105,6 +1105,17 @@ Set sample format audio decoders should prefer. Default value is
 @include decoders.texi
 @include encoders.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{libavcodec.html,libavcodec}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -1112,10 +1123,6 @@ Set sample format audio decoders should prefer. Default value is
 @setfilename ffmpeg-codecs
 @settitle FFmpeg codecs
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffmpeg-filters.texi b/doc/ffmpeg-filters.texi
index 69ec652..bb920ce 100644
--- a/doc/ffmpeg-filters.texi
+++ b/doc/ffmpeg-filters.texi
@@ -19,6 +19,17 @@ libavfilter library.
 
 @include filters.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{libavfilter.html,libavfilter}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavfilter(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -26,10 +37,6 @@ libavfilter library.
 @setfilename ffmpeg-filters
 @settitle FFmpeg filters
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavfilter(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffmpeg-formats.texi b/doc/ffmpeg-formats.texi
index f3020e2..14b9ed8 100644
--- a/doc/ffmpeg-formats.texi
+++ b/doc/ffmpeg-formats.texi
@@ -144,6 +144,17 @@ of -1 enables when required by target format.
 @include demuxers.texi
 @include muxers.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{libavformat.html,libavformat}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -151,10 +162,6 @@ of -1 enables when required by target format.
 @setfilename ffmpeg-formats
 @settitle FFmpeg formats
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffmpeg-protocols.texi b/doc/ffmpeg-protocols.texi
index 232b3f2..d992e75 100644
--- a/doc/ffmpeg-protocols.texi
+++ b/doc/ffmpeg-protocols.texi
@@ -19,6 +19,17 @@ libavformat library.
 
 @include protocols.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{libavformat.html,libavformat}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -26,10 +37,6 @@ libavformat library.
 @setfilename ffmpeg-protocols
 @settitle FFmpeg protocols
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffmpeg-resampler.texi b/doc/ffmpeg-resampler.texi
index d2a8f67..15fc0ed 100644
--- a/doc/ffmpeg-resampler.texi
+++ b/doc/ffmpeg-resampler.texi
@@ -176,6 +176,17 @@ and 16, default value is 9.
 
 @c man end RESAMPLER OPTIONS
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{libswresample.html}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswresample(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -183,10 +194,6 @@ and 16, default value is 9.
 @setfilename ffmpeg-resampler
 @settitle FFmpeg Resampler
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswresample(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffmpeg-scaler.texi b/doc/ffmpeg-scaler.texi
index cf0db96..f46adb7 100644
--- a/doc/ffmpeg-scaler.texi
+++ b/doc/ffmpeg-scaler.texi
@@ -120,15 +120,20 @@ are floating point number values.
 
 @include authors.texi
 
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{libswscale.html,libswscale}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswscale(3)
+ at end ifnothtml
+
 @ignore
 
 @setfilename ffmpeg-scaler
 @settitle FFmpeg video scaling and pixel format converter
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswscale(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffmpeg-utils.texi b/doc/ffmpeg-utils.texi
index 8734ae5..c5822a8 100644
--- a/doc/ffmpeg-utils.texi
+++ b/doc/ffmpeg-utils.texi
@@ -20,6 +20,17 @@ by the libavutil library.
 @include syntax.texi
 @include eval.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{libavutil.html,libavutil}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -27,10 +38,6 @@ by the libavutil library.
 @setfilename ffmpeg-utils
 @settitle FFmpeg utilities
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3)
- at c man end
-
 @end ignore
 
 @bye
-- 
1.7.9.5



More information about the ffmpeg-devel mailing list