From 2ceb582a30f82ea0ffb1d592b7929ec60db51ac9 Mon Sep 17 00:00:00 2001 From: Laurence Withers Date: Mon, 7 Jul 2014 11:07:05 +0000 Subject: [PATCH] Move doxygen docs into subsection for partioning --- src/docs/MainPage.dox | 2 +- src/libiir/200_iir.h | 8 +++++++- src/libiir/300_common_filters.h | 4 +++- src/libiir/400_parser.h | 4 +++- src/libiir/500_response.h | 4 +++- 5 files changed, 17 insertions(+), 5 deletions(-) diff --git a/src/docs/MainPage.dox b/src/docs/MainPage.dox index f915aae..8695025 100644 --- a/src/docs/MainPage.dox +++ b/src/docs/MainPage.dox @@ -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 set of coefficients with \ref iir_filter_new(), or the coefficients can be 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. \section operation Filter operation diff --git a/src/libiir/200_iir.h b/src/libiir/200_iir.h index 0d1d713..7a0b428 100644 --- a/src/libiir/200_iir.h +++ b/src/libiir/200_iir.h @@ -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 filters, creating instances of (possibly chained) IIR filters, and filtering an diff --git a/src/libiir/300_common_filters.h b/src/libiir/300_common_filters.h index 897827b..c3d21b9 100644 --- a/src/libiir/300_common_filters.h +++ b/src/libiir/300_common_filters.h @@ -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 coefficient structures which are returned may be used to instantiate IIR diff --git a/src/libiir/400_parser.h b/src/libiir/400_parser.h index 0c0c099..9f1bb09 100644 --- a/src/libiir/400_parser.h +++ b/src/libiir/400_parser.h @@ -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 on a user-specified, human-readable string. The intention of this interface is diff --git a/src/libiir/500_response.h b/src/libiir/500_response.h index 5c4e62a..492f22c 100644 --- a/src/libiir/500_response.h +++ b/src/libiir/500_response.h @@ -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 the transfer function) at a given frequency. The response is a complex number;