From af31523db548b2a9baaf3fb99155f71fc256560e Mon Sep 17 00:00:00 2001 From: =?utf8?q?Marek=20Vavru=C5=A1a?= Date: Fri, 20 Mar 2015 00:49:19 +0100 Subject: [PATCH] doc: updated doc --- doc/Doxyfile | 29 +++++++++++++++-------------- doc/build.rst | 5 +++-- doc/lib.rst | 33 ++++++++++++++++++--------------- 3 files changed, 36 insertions(+), 31 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 70af9a77c..6bd9938f2 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1,15 +1,16 @@ -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 diff --git a/doc/build.rst b/doc/build.rst index ea4877df7..27f3fe295 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -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" diff --git a/doc/lib.rst b/doc/lib.rst index a0ccdca94..7b8687ace 100644 --- a/doc/lib.rst +++ b/doc/lib.rst @@ -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 -- 2.47.2