]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: updated doc
authorMarek Vavruša <marek.vavrusa@nic.cz>
Thu, 19 Mar 2015 23:49:19 +0000 (00:49 +0100)
committerMarek Vavruša <marek.vavrusa@nic.cz>
Thu, 19 Mar 2015 23:49:19 +0000 (00:49 +0100)
doc/Doxyfile
doc/build.rst
doc/lib.rst

index 70af9a77c5f097cc46d6bcadd9eef9afdcee8e4f..6bd9938f27da7e1e63062410c5ff58ce71152c9c 100644 (file)
@@ -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
index ea4877df79b10cb9bc0510be910aeb7e678b9a9c..27f3fe2953003650eb1004789ad1abf71e001ed2 100644 (file)
@@ -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"
 
index a0ccdca94ab44fad92eed544f0bccddd4d544d75..7b8687ace1c7247ae2e7057d88920368579aebda 100644 (file)
@@ -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