Browse code

doc: extend "See Also" chapters in component manuals

In particular, make "See Also" chapter rendered in HTML output.

Stefano Sabatini authored on 2012/12/18 08:39:13
Showing 9 changed files
... ...
@@ -22,6 +22,17 @@ bitstream level modifications without performing decoding.
22 22
 
23 23
 @include bitstream_filters.texi
24 24
 
25
+@chapter See Also
26
+
27
+@ifhtml
28
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
29
+@url{libavcodec.html,libavcodec}
30
+@end ifhtml
31
+
32
+@ifnothtml
33
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
34
+@end ifnothtml
35
+
25 36
 @include authors.texi
26 37
 
27 38
 @ignore
... ...
@@ -29,10 +40,6 @@ bitstream level modifications without performing decoding.
29 29
 @setfilename ffmpeg-bitstream-filters
30 30
 @settitle FFmpeg bitstream filters
31 31
 
32
-@c man begin SEEALSO
33
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
34
-@c man end
35
-
36 32
 @end ignore
37 33
 
38 34
 @bye
... ...
@@ -1105,6 +1105,17 @@ Set sample format audio decoders should prefer. Default value is
1105 1105
 @include decoders.texi
1106 1106
 @include encoders.texi
1107 1107
 
1108
+@chapter See Also
1109
+
1110
+@ifhtml
1111
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
1112
+@url{libavcodec.html,libavcodec}
1113
+@end ifhtml
1114
+
1115
+@ifnothtml
1116
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
1117
+@end ifnothtml
1118
+
1108 1119
 @include authors.texi
1109 1120
 
1110 1121
 @ignore
... ...
@@ -1112,10 +1123,6 @@ Set sample format audio decoders should prefer. Default value is
1112 1112
 @setfilename ffmpeg-codecs
1113 1113
 @settitle FFmpeg codecs
1114 1114
 
1115
-@c man begin SEEALSO
1116
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
1117
-@c man end
1118
-
1119 1115
 @end ignore
1120 1116
 
1121 1117
 @bye
... ...
@@ -39,6 +39,17 @@ for programmatic use.
39 39
 @include indevs.texi
40 40
 @include outdevs.texi
41 41
 
42
+@chapter See Also
43
+
44
+@ifhtml
45
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
46
+@url{libavdevice.html,libavdevice}
47
+@end ifhtml
48
+
49
+@ifnothtml
50
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavdevice(3)
51
+@end ifnothtml
52
+
42 53
 @include authors.texi
43 54
 
44 55
 @ignore
... ...
@@ -46,10 +57,6 @@ for programmatic use.
46 46
 @setfilename ffmpeg-devices
47 47
 @settitle FFmpeg devices
48 48
 
49
-@c man begin SEEALSO
50
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3), libavdevice(3)
51
-@c man end
52
-
53 49
 @end ignore
54 50
 
55 51
 @bye
... ...
@@ -19,6 +19,17 @@ libavfilter library.
19 19
 
20 20
 @include filters.texi
21 21
 
22
+@chapter See Also
23
+
24
+@ifhtml
25
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
26
+@url{libavfilter.html,libavfilter}
27
+@end ifhtml
28
+
29
+@ifnothtml
30
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavfilter(3)
31
+@end ifnothtml
32
+
22 33
 @include authors.texi
23 34
 
24 35
 @ignore
... ...
@@ -26,10 +37,6 @@ libavfilter library.
26 26
 @setfilename ffmpeg-filters
27 27
 @settitle FFmpeg filters
28 28
 
29
-@c man begin SEEALSO
30
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavfilter(3)
31
-@c man end
32
-
33 29
 @end ignore
34 30
 
35 31
 @bye
... ...
@@ -144,6 +144,17 @@ of -1 enables when required by target format.
144 144
 @include demuxers.texi
145 145
 @include muxers.texi
146 146
 
147
+@chapter See Also
148
+
149
+@ifhtml
150
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
151
+@url{libavformat.html,libavformat}
152
+@end ifhtml
153
+
154
+@ifnothtml
155
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
156
+@end ifnothtml
157
+
147 158
 @include authors.texi
148 159
 
149 160
 @ignore
... ...
@@ -151,10 +162,6 @@ of -1 enables when required by target format.
151 151
 @setfilename ffmpeg-formats
152 152
 @settitle FFmpeg formats
153 153
 
154
-@c man begin SEEALSO
155
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
156
-@c man end
157
-
158 154
 @end ignore
159 155
 
160 156
 @bye
... ...
@@ -19,6 +19,17 @@ libavformat library.
19 19
 
20 20
 @include protocols.texi
21 21
 
22
+@chapter See Also
23
+
24
+@ifhtml
25
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
26
+@url{libavformat.html,libavformat}
27
+@end ifhtml
28
+
29
+@ifnothtml
30
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
31
+@end ifnothtml
32
+
22 33
 @include authors.texi
23 34
 
24 35
 @ignore
... ...
@@ -26,10 +37,6 @@ libavformat library.
26 26
 @setfilename ffmpeg-protocols
27 27
 @settitle FFmpeg protocols
28 28
 
29
-@c man begin SEEALSO
30
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
31
-@c man end
32
-
33 29
 @end ignore
34 30
 
35 31
 @bye
... ...
@@ -176,6 +176,17 @@ and 16, default value is 9.
176 176
 
177 177
 @c man end RESAMPLER OPTIONS
178 178
 
179
+@chapter See Also
180
+
181
+@ifhtml
182
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
183
+@url{libswresample.html}
184
+@end ifhtml
185
+
186
+@ifnothtml
187
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswresample(3)
188
+@end ifnothtml
189
+
179 190
 @include authors.texi
180 191
 
181 192
 @ignore
... ...
@@ -183,10 +194,6 @@ and 16, default value is 9.
183 183
 @setfilename ffmpeg-resampler
184 184
 @settitle FFmpeg Resampler
185 185
 
186
-@c man begin SEEALSO
187
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswresample(3)
188
-@c man end
189
-
190 186
 @end ignore
191 187
 
192 188
 @bye
... ...
@@ -118,6 +118,17 @@ are floating point number values.
118 118
 
119 119
 @c man end SCALER OPTIONS
120 120
 
121
+@chapter See Also
122
+
123
+@ifhtml
124
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
125
+@url{libswscale.html,libswscale}
126
+@end ifhtml
127
+
128
+@ifnothtml
129
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswscale(3)
130
+@end ifnothtml
131
+
121 132
 @include authors.texi
122 133
 
123 134
 @ignore
... ...
@@ -125,10 +136,6 @@ are floating point number values.
125 125
 @setfilename ffmpeg-scaler
126 126
 @settitle FFmpeg video scaling and pixel format converter
127 127
 
128
-@c man begin SEEALSO
129
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswscale(3)
130
-@c man end
131
-
132 128
 @end ignore
133 129
 
134 130
 @bye
... ...
@@ -20,6 +20,17 @@ by the libavutil library.
20 20
 @include syntax.texi
21 21
 @include eval.texi
22 22
 
23
+@chapter See Also
24
+
25
+@ifhtml
26
+@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
27
+@url{libavutil.html,libavutil}
28
+@end ifhtml
29
+
30
+@ifnothtml
31
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3)
32
+@end ifnothtml
33
+
23 34
 @include authors.texi
24 35
 
25 36
 @ignore
... ...
@@ -27,10 +38,6 @@ by the libavutil library.
27 27
 @setfilename ffmpeg-utils
28 28
 @settitle FFmpeg utilities
29 29
 
30
-@c man begin SEEALSO
31
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3)
32
-@c man end
33
-
34 30
 @end ignore
35 31
 
36 32
 @bye