From f0c49ce075c3c950a0488c6cf32e63621cc3c574 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 19 Jun 2016 22:55:48 +0200 Subject: [PATCH] Add documentation of filter_get(). It's a public function that should be documented. --- filter_common.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/filter_common.c b/filter_common.c index 099d056e..6fb9bd96 100644 --- a/filter_common.c +++ b/filter_common.c @@ -25,6 +25,16 @@ /** The array of supported filters. */ static struct filter filters[NUM_SUPPORTED_FILTERS] = {FILTER_ARRAY}; +/** + * Obtain a reference to a filter structure. + * + * \param filter_num Between zero and NUM_SUPPORTED_FILTERS, inclusively. + * + * \return Pointer to the filter identified by the given filter number. + * + * It is a fatal error if the given number is out of range. In this case + * the function aborts. + */ const struct filter *filter_get(int filter_num) { assert(filter_num >= 0); -- 2.39.2