kmod/libkmod/docs/libkmod-docs.xml
Emil Velikov 1e4cd85c0b 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>
2024-10-23 23:19:11 -05:00

64 lines
2.3 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index">
<bookinfo>
<title>libkmod Reference Manual</title>
<releaseinfo>for libkmod version &version;</releaseinfo>
</bookinfo>
<chapter>
<title>libkmod</title>
<xi:include href="xml/libkmod.xml"/>
<xi:include href="xml/libkmod-list.xml"/>
<xi:include href="xml/libkmod-config.xml"/>
<xi:include href="xml/libkmod-module.xml"/>
<xi:include href="xml/libkmod-loaded.xml"/>
</chapter>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<chapter id="deprecated-api-index" role="deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"></xi:include>
</chapter>
<chapter id="api-index-v1" role="1">
<title>Index of new symbols in 1</title>
<xi:include href="xml/api-index-1.xml"></xi:include>
</chapter>
<chapter id="api-index-v2" role="2">
<title>Index of new symbols in 2</title>
<xi:include href="xml/api-index-2.xml"></xi:include>
</chapter>
<chapter id="api-index-v3" role="3">
<title>Index of new symbols in 3</title>
<xi:include href="xml/api-index-3.xml"></xi:include>
</chapter>
<chapter id="api-index-v4" role="4">
<title>Index of new symbols in 4</title>
<xi:include href="xml/api-index-4.xml"></xi:include>
</chapter>
<chapter id="api-index-v6" role="6">
<title>Index of new symbols in 6</title>
<xi:include href="xml/api-index-6.xml"></xi:include>
</chapter>
<chapter id="api-index-v22" role="22">
<title>Index of new symbols in 22</title>
<xi:include href="xml/api-index-22.xml"></xi:include>
</chapter>
<chapter id="api-index-v30" role="30">
<title>Index of new symbols in 30</title>
<xi:include href="xml/api-index-30.xml"></xi:include>
</chapter>
<chapter id="api-index-v33" role="33">
<title>Index of new symbols in 33</title>
<xi:include href="xml/api-index-33.xml"></xi:include>
</chapter>
</book>