Browse Source

[5021] Doxygen documentation cleaned up

 - There's new section Kea Libraries
Tomek Mrugalski 8 years ago
parent
commit
72a053682c

+ 12 - 9
doc/devel/mainpage.dox

@@ -71,9 +71,6 @@
  *   - @subpage dhcpv6SignalBasedReconfiguration
  *   - @subpage dhcpv6Other
  *   - @subpage dhcpv4o6Dhcp6
- * - @subpage libprocess
- *   - @subpage cpl
- *   - @subpage cplSignals
  * - @subpage d2
  *   - @subpage d2ProcessDerivation
  *   - @subpage d2ConfigMgt
@@ -91,6 +88,13 @@
  *   - @subpage ctrlSocketClient
  *   - @subpage ctrlSocketImpl
  *   - @subpage ctrlSocketConnections
+ * - @subpage dhcpDatabaseBackends
+ * - @subpage configBackend
+ *   - @subpage configBackendJSONDesign
+ * - @subpage perfdhcpInternals
+ *
+ * @section libraries Kea libraries
+ * - @subpage libcc
  * - @subpage libdhcp
  *   - @subpage libdhcpIntro
  *   - @subpage libdhcpRelay
@@ -98,6 +102,7 @@
  *   - @subpage libdhcpPktFilter
  *   - @subpage libdhcpPktFilter6
  *   - @subpage libdhcpErrorLogging
+ * - @subpage libdhcp_ddns
  * - @subpage libdhcpsrv
  *   - @subpage leasemgr
  *   - @subpage cfgmgr
@@ -108,12 +113,10 @@
  *   - @subpage leaseReclamationRoutine
  *   - @subpage subnetSelect
  *   - @subpage dhcp4o6Ipc
- * - @subpage libdhcp_ddns
- * - @subpage dhcpDatabaseBackends
- * - @subpage dhcpEval
- * - @subpage configBackend
- *   - @subpage configBackendJSONDesign
- * - @subpage perfdhcpInternals
+ * - @subpage libeval
+ * - @subpage libprocess
+ *   - @subpage cpl
+ *   - @subpage cplSignals
  *
  * @section miscellaneousTopics Miscellaneous Topics
  * - @subpage logKeaLogging

+ 1 - 1
doc/guide/dhcp4-srv.xml

@@ -1582,7 +1582,7 @@ It is merely echoed by the server
           specified the server will assume that the option data is specified as
           a list of comma separated values to be assigned to individual fields
           of the DHCP option. This behavior has changed in Kea 1.2. Older
-          versions used additional logic to determined whether the csv-format
+          versions used additional logic to determine whether the csv-format
           should be true or false. That is no longer the case.
           </simpara>
         </listitem>

+ 1 - 1
doc/guide/dhcp6-srv.xml

@@ -1725,7 +1725,7 @@ should include options from the isc option space:
           specified the server will assume that the option data is specified as
           a list of comma separated values to be assigned to individual fields
           of the DHCP option. This behavior has changed in Kea 1.2. Older
-          versions used additional logic to determined whether the csv-format
+          versions used additional logic to determine whether the csv-format
           should be true or false. That is no longer the case.
           </simpara>
         </listitem>

+ 1 - 1
src/bin/dhcp4/dhcp4.dox

@@ -279,7 +279,7 @@ class definitions that are subnet specific.
 Client classification is done in isc::dhcp::Dhcpv4Srv::classifyPacket. First, the old
 "built-in" (see @ref dhcpv4ClassifierSimple) classification is called. Then the code
 iterates over all class definitions and for each class definition it calls
-isc::dhcp::evaluate, which is implemented in libeval (see @ref dhcpEval). If the
+isc::dhcp::evaluate, which is implemented in libeval (see @ref libeval). If the
 evaluation is successful, the class name is added to the packet (by calling
 isc::dhcp::pkt::addClass).
 

+ 1 - 1
src/bin/dhcp6/dhcp6.dox

@@ -544,7 +544,7 @@ Client classification is done in isc::dhcp::Dhcpv6Srv::classifyPacket. First, th
 "built-in" (see @ref dhcpv6ClassifierSimple) classification is called (see @ref
 isc::dhcp::Dhcpv6Srv::classifyByVendor). Then the code iterates over all class definitions
 and for each class definition it calls isc::dhcp::evaluate, which is implemented in libeval
-(see @ref dhcpEval). If the evaluation is successful, the class name is added to the packet
+(see @ref libeval). If the evaluation is successful, the class name is added to the packet
 (by calling isc::dhcp::pkt::addClass).
 
 If packet belongs to at least one class, this fact is logged. If there are any

+ 1 - 1
src/lib/cc/cc.dox

@@ -5,7 +5,7 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 /**
- @page libcc libcc - Kea configuration commands library
+ @page libcc libkea-cc - Kea Configuration Utilities Library
 
 @section ccSimpleParser Simple JSON Parser
 

+ 1 - 1
src/lib/dhcp/libdhcp++.dox

@@ -5,7 +5,7 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 /**
-@page libdhcp libdhcp++
+@page libdhcp libkea-dhcp++ - Low Level DHCP Library
 
 @section libdhcpIntro Libdhcp++ Library Introduction
 

+ 1 - 1
src/lib/dhcp_ddns/libdhcp_ddns.dox

@@ -5,7 +5,7 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 /**
-@page libdhcp_ddns libdhcp_ddns - DHCP_DDNS Request I/O Library
+@page libdhcp_ddns libkea-dhcp_ddns - DHCP_DDNS Request I/O Library
 
 @section libdhcp_ddnsIntro Introduction
 

+ 1 - 1
src/lib/dhcpsrv/libdhcpsrv.dox

@@ -5,7 +5,7 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 /**
- @page libdhcpsrv libdhcpsrv - Server DHCP library
+ @page libdhcpsrv libkea-dhcpsrv - Server DHCP Library
 
 This library contains code used for the DHCPv4 and DHCPv6 servers' operations,
 including the "Lease Manager" that manages information about leases and the

+ 1 - 1
src/lib/eval/eval.dox

@@ -5,7 +5,7 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 /**
-  @page dhcpEval libeval - Expression evaluation and client classification
+  @page libeval libkea-eval - Expression Evaluation and Client Classification Library
 
   @section dhcpEvalIntroduction Introduction