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

Stefano Sabatini stefasab at gmail.com
Tue Dec 18 01:39:32 CET 2012


In particular, make "See Also" chapter rendered in HTML output.
---
 doc/libavcodec.texi    |   19 ++++++++++++++-----
 doc/libavdevice.texi   |   19 ++++++++++++++-----
 doc/libavfilter.texi   |   19 +++++++++++++++----
 doc/libavformat.texi   |   18 ++++++++++++++----
 doc/libavutil.texi     |   16 ++++++++++++----
 doc/libswresample.texi |   18 ++++++++++++++----
 doc/libswscale.texi    |   18 ++++++++++++++----
 7 files changed, 97 insertions(+), 30 deletions(-)

diff --git a/doc/libavcodec.texi b/doc/libavcodec.texi
index 27cea2c..2b11201 100644
--- a/doc/libavcodec.texi
+++ b/doc/libavcodec.texi
@@ -22,6 +22,20 @@ implementing robust and fast codecs as well as for experimentation.
 
 @c man end DESCRIPTION
 
+ 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{ffmpeg-codecs.html,ffmpeg-codecs}, @url{ffmpeg-bitstream-filters.html,bitstream-filters},
+ at url{libavutil.html,libavutil}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-codecs(1), ffmpeg-bistream-filters(1),
+libavutil(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -29,11 +43,6 @@ implementing robust and fast codecs as well as for experimentation.
 @setfilename libavcodec
 @settitle media streams decoding and encoding library
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-codecs(1),
-ffmpeg-bistream-filters(1), libavutil(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/libavdevice.texi b/doc/libavdevice.texi
index b749e9c..d5f790b 100644
--- a/doc/libavdevice.texi
+++ b/doc/libavdevice.texi
@@ -19,6 +19,20 @@ VfW, DShow, and ALSA.
 
 @c man end DESCRIPTION
 
+ 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{ffmpeg-devices.html,ffmpeg-devices},
+ at url{libavutil.html,libavutil}, @url{libavcodec.html,libavcodec}, @url{libavformat.html,libavformat}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-devices(1),
+libavutil(3), libavcodec(3), libavformat(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -26,11 +40,6 @@ VfW, DShow, and ALSA.
 @setfilename libavdevice
 @settitle multimedia device handling library
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3),
-libavcodec(3), libavformat(3), ffmpeg-devices(1)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/libavfilter.texi b/doc/libavfilter.texi
index 24bd9a6..4f82944 100644
--- a/doc/libavfilter.texi
+++ b/doc/libavfilter.texi
@@ -17,6 +17,21 @@ framework containing several filters, sources and sinks.
 
 @c man end DESCRIPTION
 
+ 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{ffmpeg-filters.html,ffmpeg-filters},
+ at url{libavutil.html,libavutil}, @url{libswscale.html,libswscale}, @url{libswresample.html,libswresample},
+ at url{libavcodec.html,libavcodec}, @url{libavformat.html,libavformat}, @url{libavdevice.html,libavdevice}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-filters(1),
+libavutil(3), libswscale(3), libswresample(3), libavcodec(3), libavformat(3), libavdevice(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -24,10 +39,6 @@ framework containing several filters, sources and sinks.
 @setfilename libavfilter
 @settitle multimedia filtering library
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-filters(1)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/libavformat.texi b/doc/libavformat.texi
index 349a925..85e49cb 100644
--- a/doc/libavformat.texi
+++ b/doc/libavformat.texi
@@ -22,6 +22,20 @@ resource.
 
 @c man end DESCRIPTION
 
+ 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{ffmpeg-formats.html,ffmpeg-formats}, @url{ffmpeg-protocols.html,ffmpeg-protocols},
+ at url{libavutil.html,libavutil}, @url{libavcodec.html,libavcodec}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-formats(1), ffmpeg-protocols(1),
+libavutil(3), libavcodec(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -29,10 +43,6 @@ resource.
 @setfilename libavformat
 @settitle multimedia muxing and demuxing library
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3), libavcodec(3), ffmpeg-formats(1), ffmpeg-protocols(1)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/libavutil.texi b/doc/libavutil.texi
index b37ce27..50b0d0e 100644
--- a/doc/libavutil.texi
+++ b/doc/libavutil.texi
@@ -20,6 +20,18 @@ enumerations for pixel and sample formats).
 
 @c man end DESCRIPTION
 
+ 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{ffmpeg-utils.html,ffmpeg-utils}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-utils(1)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -27,10 +39,6 @@ enumerations for pixel and sample formats).
 @setfilename libavutil
 @settitle multimedia-biased utility library
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-utils(1)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/libswresample.texi b/doc/libswresample.texi
index 08fa6b5..1a5b01f 100644
--- a/doc/libswresample.texi
+++ b/doc/libswresample.texi
@@ -44,6 +44,20 @@ enabled through dedicated options.
 
 @c man end DESCRIPTION
 
+ 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{ffmpeg-resampler.html,ffmpeg-resampler},
+ at url{libavutil.html,libavutil}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-resampler(1),
+libavutil(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -51,10 +65,6 @@ enabled through dedicated options.
 @setfilename libswresample
 @settitle audio resampling library
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-resampler(1), libavutil(3)
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/libswscale.texi b/doc/libswscale.texi
index 9c76943..818e988 100644
--- a/doc/libswscale.texi
+++ b/doc/libswscale.texi
@@ -37,6 +37,20 @@ colorspaces differ.
 
 @c man end DESCRIPTION
 
+ 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{ffmpeg-scaler.html,ffmpeg-scaler},
+ at url{libavutil.html,libavutil}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-scaler(1),
+libavutil(3)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -44,10 +58,6 @@ colorspaces differ.
 @setfilename libswscale
 @settitle video scaling and pixel format conversion library
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-scaler(1), libavutil(3)
- at c man end
-
 @end ignore
 
 @bye
-- 
1.7.9.5



More information about the ffmpeg-devel mailing list