]> git.ipfire.org Git - thirdparty/kmod.git/commit
docs: annotate the deprecated API
authorEmil Velikov <emil.l.velikov@gmail.com>
Mon, 21 Oct 2024 13:08:59 +0000 (14:08 +0100)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Thu, 24 Oct 2024 04:19:11 +0000 (23:19 -0500)
commit1e4cd85c0ba62f0a3baaa17145378aee514f0c4d
tree58670281dd6aecc64d69a195164d5d8a3c30b926
parentaf272169961f4176b946c18c5fcc496aa6d59ce2
docs: annotate the deprecated API

The kmod_module_get_filtered_blacklist() was deprecated since kmod v6 in
favour of kmod_module_apply_filter().

Add the decoration so gtk-doc includes it in the generated html and also
add a designated index.

It seem that gtk-doc insists on having deprecation guards, so not it
prints an extra warning like:

  warning: XXX is deprecated in the inline comments, but no deprecation
  guards were found around the declaration. (See the --deprecated-guards
  option for gtkdoc-scan.)

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/200
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
libkmod/docs/libkmod-docs.xml
libkmod/libkmod.h