c
/
libiir
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move doxygen docs into subsection for partioning

This commit is contained in:
Laurence Withers 2014-07-07 11:07:05 +00:00
parent 8a763c4bf3
commit 2ceb582a30
5 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/docs/MainPage.dox
View File

@ -23,7 +23,7 @@ Otherwise, the library user must first create a set of coefficients using
\ref iir_coeff_new(). Any number of filters can then be instantiated using that \ref iir_coeff_new(). Any number of filters can then be instantiated using that
set of coefficients with \ref iir_filter_new(), or the coefficients can be set of coefficients with \ref iir_filter_new(), or the coefficients can be
chained on to the end of an existing filter instance with chained on to the end of an existing filter instance with
\ref iir_filter_chain(). See \ref common_filters for functions to generate \ref iir_filter_chain(). See \ref libiir_common_filters for functions to generate
coefficients. coefficients.
\section operation Filter operation \section operation Filter operation

8
src/libiir/200_iir.h
View File

@ -7,7 +7,13 @@
/*! \defgroup iir Basic IIR filtering /*! \defgroup libiir C library */
/*! \defgroup libiir_iir Basic IIR filtering
\ingroup libiir
The functions in this module present a basic interface for representing IIR The functions in this module present a basic interface for representing IIR
filters, creating instances of (possibly chained) IIR filters, and filtering an filters, creating instances of (possibly chained) IIR filters, and filtering an

4
src/libiir/300_common_filters.h
View File

@ -7,7 +7,9 @@
/*! \defgroup common_filters Common types of IIR filter /*! \defgroup libiir_common_filters Common types of IIR filter
\ingroup libiir
Functions to create coefficients for various common types of IIR filter. The Functions to create coefficients for various common types of IIR filter. The
coefficient structures which are returned may be used to instantiate IIR coefficient structures which are returned may be used to instantiate IIR

4
src/libiir/400_parser.h
View File

@ -7,7 +7,9 @@
/*! \defgroup parser Parser for user-specified IIR filters /*! \defgroup iir_parser Parser for user-specified IIR filters
\ingroup libiir
This is a high-level interface that can instantiate a set of IIR filters based This is a high-level interface that can instantiate a set of IIR filters based
on a user-specified, human-readable string. The intention of this interface is on a user-specified, human-readable string. The intention of this interface is

4
src/libiir/500_response.h
View File

@ -7,7 +7,9 @@
/*! \defgroup response Measuring IIR response /*! \defgroup iir_response Measuring IIR response
\ingroup libiir
These functions allow measuring the IIR response (i.e. frequency and phase of These functions allow measuring the IIR response (i.e. frequency and phase of
the transfer function) at a given frequency. The response is a complex number; the transfer function) at a given frequency. The response is a complex number;