Skip to content

Commit

Permalink
doc: extend "See Also" chapters in component manuals
Browse files Browse the repository at this point in the history
In particular, make "See Also" chapter rendered in HTML output.
  • Loading branch information
saste committed Dec 19, 2012
1 parent 9d6517a commit 9b323a9
Show file tree
Hide file tree
Showing 9 changed files with 99 additions and 36 deletions.
15 changes: 11 additions & 4 deletions doc/ffmpeg-bitstream-filters.texi
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,24 @@ bitstream level modifications without performing decoding.

@include bitstream_filters.texi

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libavcodec.html,libavcodec}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-bitstream-filters
@settitle FFmpeg bitstream filters
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
@c man end
@end ignore

@bye
15 changes: 11 additions & 4 deletions doc/ffmpeg-codecs.texi
Original file line number Diff line number Diff line change
Expand Up @@ -1105,17 +1105,24 @@ Set sample format audio decoders should prefer. Default value is
@include decoders.texi
@include encoders.texi

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libavcodec.html,libavcodec}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-codecs
@settitle FFmpeg codecs
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
@c man end
@end ignore

@bye
15 changes: 11 additions & 4 deletions doc/ffmpeg-devices.texi
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,24 @@ for programmatic use.
@include indevs.texi
@include outdevs.texi

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libavdevice.html,libavdevice}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavdevice(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-devices
@settitle FFmpeg devices
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3), libavdevice(3)
@c man end
@end ignore

@bye
15 changes: 11 additions & 4 deletions doc/ffmpeg-filters.texi
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,24 @@ libavfilter library.

@include filters.texi

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libavfilter.html,libavfilter}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavfilter(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-filters
@settitle FFmpeg filters
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavfilter(3)
@c man end
@end ignore

@bye
15 changes: 11 additions & 4 deletions doc/ffmpeg-formats.texi
Original file line number Diff line number Diff line change
Expand Up @@ -144,17 +144,24 @@ of -1 enables when required by target format.
@include demuxers.texi
@include muxers.texi

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libavformat.html,libavformat}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-formats
@settitle FFmpeg formats
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
@c man end
@end ignore

@bye
15 changes: 11 additions & 4 deletions doc/ffmpeg-protocols.texi
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,24 @@ libavformat library.

@include protocols.texi

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libavformat.html,libavformat}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-protocols
@settitle FFmpeg protocols
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
@c man end
@end ignore

@bye
15 changes: 11 additions & 4 deletions doc/ffmpeg-resampler.texi
Original file line number Diff line number Diff line change
Expand Up @@ -176,17 +176,24 @@ and 16, default value is 9.

@c man end RESAMPLER OPTIONS

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libswresample.html}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswresample(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-resampler
@settitle FFmpeg Resampler
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswresample(3)
@c man end
@end ignore

@bye
15 changes: 11 additions & 4 deletions doc/ffmpeg-scaler.texi
Original file line number Diff line number Diff line change
Expand Up @@ -118,17 +118,24 @@ are floating point number values.

@c man end SCALER OPTIONS

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libswscale.html,libswscale}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswscale(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-scaler
@settitle FFmpeg video scaling and pixel format converter
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswscale(3)
@c man end
@end ignore

@bye
15 changes: 11 additions & 4 deletions doc/ffmpeg-utils.texi
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,24 @@ by the libavutil library.
@include syntax.texi
@include eval.texi

@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{libavutil.html,libavutil}
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3)
@end ifnothtml

@include authors.texi

@ignore
@setfilename ffmpeg-utils
@settitle FFmpeg utilities
@c man begin SEEALSO
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3)
@c man end
@end ignore

@bye

0 comments on commit 9b323a9

Please sign in to comment.