From 01ced1e49ea1100c3c3edcb8972f705242d2f57d Mon Sep 17 00:00:00 2001 From: reimar Date: Sat, 1 Oct 2005 12:55:34 +0000 Subject: documentation-only patch: make doxygen compatible and create af_chain and af_filter doxygen modules. git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@16628 b3059339-0415-0410-9bf9-f77b7e298cf2 --- libaf/af.c | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) (limited to 'libaf/af.c') diff --git a/libaf/af.c b/libaf/af.c index e3f647d11c..9abf947f3d 100644 --- a/libaf/af.c +++ b/libaf/af.c @@ -628,11 +628,7 @@ inline int af_resize_local_buffer(af_instance_t* af, af_data_t* data) return AF_OK; } -/** - * \brief send control to all filters, starting with the last, until - * one responds with AF_OK - * \return The instance that accepted the command or NULL if none did. - */ +// documentation in af.h af_instance_t *af_control_any_rev (af_stream_t* s, int cmd, void* arg) { int res = AF_UNKNOWN; af_instance_t* filt = s->last; @@ -647,6 +643,8 @@ af_instance_t *af_control_any_rev (af_stream_t* s, int cmd, void* arg) { /** * \brief calculate greatest common divisior of a and b. + * \ingroup af_filter + * * Extended for negative and 0 values. If both are 0 the result is 1. * The sign of the result will be so that it has the same sign as b. */ @@ -669,6 +667,8 @@ int af_gcd(register int a, register int b) { /** * \brief cancel down a fraction f + * \param f fraction to cancel down + * \ingroup af_filter */ void af_frac_cancel(frac_t *f) { int gcd = af_gcd(f->n, f->d); @@ -678,7 +678,11 @@ void af_frac_cancel(frac_t *f) { /** * \brief multiply out by in and store result in out. - * the resulting fraction wil be cancelled down + * \param out [inout] fraction to multiply by in + * \param in [in] fraction to multiply out by + * \ingroup af_filter + * + * the resulting fraction will be cancelled down * if in and out were. */ void af_frac_mul(frac_t *out, const frac_t *in) { -- cgit v1.2.3