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

Escape IIR in Doxygen strings for upcoming C++ library

Browse source
This commit is contained in:
Laurence Withers 2014-07-07 13:05:55 +00:00
commit ccc5bc6738
8 changed files with 71 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/docs/MainPage.dox
View file

@ -1,16 +1,16 @@
/* libiir/src/docs/MainPage.dox
*
* Copyright: ©2010, Laurence Withers.
* Copyright: ©2010–2014, Laurence Withers.
* Author: Laurence Withers <l@lwithers.me.uk>
* License: GPLv3
*/
/*! \mainpage
This library allows the implementation of arbitrary IIR filters in C. It has
This library allows the implementation of arbitrary %IIR filters in C. It has
functions for generating and manipulating filters in terms of coefficients, for
chaining arbitrary filters together, and for generating coefficients for some
common types of filter. See \ref iir_structure for a definition of the IIR
common types of filter. See \ref iir_structure for a definition of the %IIR
filter equation.
\section creation Filter creation
@ -47,6 +47,11 @@ installed) which will generate a Bode plot for a given filter chain. Note the
phase response can be a little rough due to the simplistic time-domain analysis
of the output signal's phase.
\section cpp C++
Two C++ wrapper objects, \ref IIR::Coeff and \ref IIR::Filter, are supplied which provide
a true object-oriented interface on top of the C implementation.
*/
/* options for text editors

4
src/docs/iir_structure.dox
View file

@ -1,6 +1,6 @@
/* libiir/src/docs/iir_structure.dox
*
* Copyright: ©2010–2011, Laurence Withers.
* Copyright: ©2010–2014, Laurence Withers.
* Author: Laurence Withers <l@lwithers.me.uk>
* License: GPLv3
*/
@ -14,7 +14,7 @@ For the purposes of this library, the following notation is used:
\li <code>c[n]</code>: array of \c x(t) coefficients
\li <code>d[n]</code>: array of \c y(t) coefficients
This leads to a general IIR filter equation:
This leads to a general %IIR filter equation:
<code>y(t) = x(t).c[0] + x(t-1).c[1] + … + x(t-N).c[N] - y(t-1).d[0] - y(t-2).d[1] - … - y(t-1-M).d[M]</code>

8
src/docs/string_desc.dox
View file

@ -1,17 +1,17 @@
/* libiir/src/docs/string_desc.dox
*
* Copyright: ©2010, Laurence Withers.
* Copyright: ©2010–2014, Laurence Withers.
* Author: Laurence Withers <l@lwithers.me.uk>
* License: GPLv3
*/
/*! \page string_desc Describing IIR filters as strings
This library allows the user to describe an IIR filter chain as a string, which
This library allows the user to describe an %IIR filter chain as a string, which
is useful to allow configurable filtering using e.g. a configuration file. This
page describes the format of such strings.
The string is first split into individual IIR filters. Each filter is written as
The string is first split into individual %IIR filters. Each filter is written as
\c type(params) and separated by whitespace. The string must contain at least
one filter but may contain an arbitrary number.
@ -23,7 +23,7 @@ one filter but may contain an arbitrary number.
\subsection string_desc_coeff Raw coefficients
An IIR filter may be specified as raw coefficients, in which case the \c type
An %IIR filter may be specified as raw coefficients, in which case the \c type
is \c raw and the \c params consists of a string:
<code>c[0],c[1],…,c[n]/d[0],d[1]…d[n]</code>