[FFmpeg-devel] [PATCH] Apply minor cosmetics fixes to the av_audio_resample_init() doxy.

Janne Grunau janne-ffmpeg
Wed Feb 16 10:25:48 CET 2011


On Mon, Feb 14, 2011 at 02:02:15PM +0100, Diego Biurrun wrote:
> On Mon, Feb 14, 2011 at 10:59:14AM +0100, Stefano Sabatini wrote:
> > --- a/libavcodec/avcodec.h
> > +++ b/libavcodec/avcodec.h
> > @@ -3223,9 +3224,9 @@ attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, i
> >   * @param input_rate       input sample rate
> >   * @param sample_fmt_out   requested output sample format
> >   * @param sample_fmt_in    input sample format
> > - * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
> > + * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
> >   * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
> > - * @param linear           If 1 then the used FIR filter will be linearly interpolated
> > + * @param linear           if 1 then the used FIR filter will be linearly interpolated
> >                             between the 2 closest, if 0 the closest will be used
> 
> You should rather let this sentence end in a period IMO.

queued without period, not really a nice sentence and most of the @param
descriptions are not full sentences

Janne



More information about the ffmpeg-devel mailing list