Add documentation of filter_get().
authorAndre Noll <maan@tuebingen.mpg.de>
Sun, 19 Jun 2016 20:55:48 +0000 (22:55 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 19 Jun 2016 20:55:48 +0000 (22:55 +0200)
It's a public function that should be documented.

filter_common.c

index 099d056..6fb9bd9 100644 (file)
 /** 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);