Commit af31523d authored by Marek Vavruša's avatar Marek Vavruša

doc: updated doc

parent 8c1d3dbd
PROJECT_NAME = Knot DNS Resolver library
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = ../lib
QUIET = YES
PROJECT_NAME = Knot DNS Resolver library
GENERATE_HTML = NO
GENERATE_XML = YES
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = ../lib
FILE_PATTERNS = *.h
QUIET = YES
JAVADOC_AUTOBRIEF = YES
AUTOLINK_SUPPORT = YES
GENERATE_HTML = NO
GENERATE_XML = YES
XML_OUTPUT = doxyxml
PREDEFINED = _GNU_SOURCE=1
EXCLUDE_PATTERNS = *.c
OPTIMIZE_OUTPUT_FOR_C = YES
AUTOLINK_SUPPORT = YES
XML_OUTPUT = doxyxml
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
OPTIMIZE_OUTPUT_FOR_C = YES
......@@ -22,8 +22,7 @@ Platform considerations
Requirements
------------
The following is a list of software required to build Knot DNS Resolver, alternatively you can use
the `Docker images`.
The following is a list of software required to build Knot DNS Resolver from sources.
.. csv-table:: Mandatory requirements.
:header: "Requirement", "Required by", "Notes"
......@@ -33,6 +32,8 @@ the `Docker images`.
"C compiler", "*all*", "*(build only)* [#]_"
"libknot_ 2.0+", "*all*", "Knot DNS library."
There are optional package that enable specific functionality in Knot DNS Resolver.
.. csv-table:: Optional requirements.
:header: "Requirement", "Required by", "Notes"
......
......@@ -10,35 +10,38 @@ you an idea about the API and the library layout.
Name resolution
~~~~~~~~~~~~~~~
.. doxygengroup:: resolution
:project: libkresolve
Resolution plan
~~~~~~~~~~~~~~~
.. doxygengroup:: rplan
:project: libkresolve
Cache
~~~~~
.. doxygengroup:: cache
:project: libkresolve
Nameservers
~~~~~~~~~~~
.. doxygengroup:: nameservers
:project: libkresolve
Modules
~~~~~~~
.. doxygengroup:: modules
:project: libkresolve
Utilities
~~~~~~~~~
API reference
-------------
.. doxygengroup:: resolution
:project: libkresolve
.. doxygengroup:: rplan
:project: libkresolve
.. doxygengroup:: cache
:project: libkresolve
.. doxygengroup:: nameservers
:project: libkresolve
.. doxygengroup:: modules
:project: libkresolve
.. doxygengroup:: utils
:project: libkresolve
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment