mainpage.dox 4.11 KB
Newer Older
1
// Copyright (C) 2012-2015 Internet Systems Consortium, Inc. ("ISC")
2
//
3 4 5
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6

7
/**
8
 * @mainpage Kea Developer's Guide
9
 *
10 11 12 13
 * Welcome to Kea Developer's Guide. This documentation is addressed at
 * either existing or prospective Kea developers and contributors, and
 * provides information needed to extend and maintain Kea.

14
 * If you wish to write "hook" code - code that is loaded by Kea at
15
 * run-time and modifies its behavior,  you should read the section
16
 * @ref hooksdgDevelopersGuide.
17
 *
18 19 20 21
 * Kea maintenance information is divided into a number of sections
 * depending on focus. Information on DHCP-specific topics can be found
 * in the @ref dhcpMaintenanceGuide.  General topics, are discussed in
 * @ref miscellaneousTopics.
22 23
 *
 * If you are a user or system administrator, rather than software engineer,
24
 * you should read the
25
 * <a href="http://kea.isc.org/docs/kea-guide.html">Kea
26
 * Administrator Reference Manual</a> instead. If you are using a beta or
27 28 29
 * development version of Kea, the
 * <a href="http://git.kea.isc.org/~tester/kea/guide/kea-guide.html">
 * development version of the manual</a> is recommended.
30
 *
31
 * Regardless of your field of expertise, you are encouraged to visit the
32
 * <a href="http://kea.isc.org/">Kea webpage (http://kea.isc.org)</a>
33
 *
34 35 36
 * @section contrib Contributor's Guide
 * - @subpage contributorGuide
 *
37
 * @section hooksFramework Hooks Framework
38
 * - @subpage hooksdgDevelopersGuide
39 40
 * - @subpage dhcpv4Hooks
 * - @subpage dhcpv6Hooks
41
 * - @subpage hooksComponentDeveloperGuide
42
 * - @subpage hooksmgMaintenanceGuide
43
 * - @subpage libdhcp_user_chk
44
 *
45
 * @section dhcpMaintenanceGuide DHCP Maintenance Guide
46
 * - @subpage dhcp4
47 48
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
49
 *   - @subpage dhcpv4OptionsParse
50
 *   - @subpage dhcpv4DDNSIntegration
51
 *   - @subpage dhcpv4Classifier
52
 *   - @subpage dhcpv4ConfigBackend
53
 *   - @subpage dhcpv4SignalBasedReconfiguration
54
 *   - @subpage dhcpv4Other
55
 *   - @subpage dhcpv4o6Dhcp4
56
 * - @subpage dhcp6
57 58
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
59
 *   - @subpage dhcpv6DDNSIntegration
60
 *   - @subpage dhcpv6OptionsParse
61
 *   - @subpage dhcpv6Classifier
62
 *   - @subpage dhcpv6ConfigBackend
63
 *   - @subpage dhcpv6SignalBasedReconfiguration
64
 *   - @subpage dhcpv6Other
65
 *   - @subpage dhcpv4o6Dhcp6
66
 * - @subpage d2
67
 *   - @subpage d2CPL
Jeremy C. Reed's avatar
Jeremy C. Reed committed
68
 *   - @subpage d2ProcessDerivation
69 70 71 72 73 74 75
 *   - @subpage d2ConfigMgt
 *   - @subpage d2NCRReceipt
 *   - @subpage d2DDNSUpdateExecution
 *   - @subpage d2EventLoop
 *   - @subpage d2TransDetail
 *   - @subpage d2StateModel
 *   - @subpage d2TransExecExample
76 77 78
 * - @subpage lfc
 *   - @subpage lfcProcessing
 *   - @subpage lfcFiles
79 80 81 82 83
 * - @subpage ctrlSocket
 *   - @subpage ctrlSocketOverview
 *   - @subpage ctrlSocketClient
 *   - @subpage ctrlSocketImpl
 *   - @subpage ctrlSocketConnections
84
 * - @subpage libdhcp
85
 *   - @subpage libdhcpIntro
86
 *   - @subpage libdhcpRelay
87
 *   - @subpage libdhcpIfaceMgr
88
 *   - @subpage libdhcpPktFilter
89
 *   - @subpage libdhcpPktFilter6
90
 *   - @subpage libdhcpErrorLogging
91 92 93
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
94
 *   - @subpage hostmgr
95
 *   - @subpage optionsConfig
96
 *   - @subpage allocengine
97 98
 *   - @subpage timerManager
 *   - @subpage leaseReclamationRoutine
99 100
 *   - @subpage subnetSelect
 *   - @subpage dhcp4o6Ipc
101
 * - @subpage libdhcp_ddns
102
 * - @subpage dhcpDatabaseBackends
103
 * - @subpage dhcpEval
104 105 106 107
 * - @subpage configBackend
 *   - @subpage configBackendMotivation
 *   - @subpage configBackendJSONDesign
 *   - @subpage configBackendAdding
108
 * - @subpage perfdhcpInternals
109
 *
Francis Dupont's avatar
Francis Dupont committed
110
 * @section qualityAssurance Quality Assurance
111 112
 *   - @subpage qaUnitTests
 *
113
 * @section miscellaneousTopics Miscellaneous Topics
114
 * - @subpage logKeaLogging
115 116 117
 *   - @subpage logBasicIdeas
 *   - @subpage logDeveloperUse
 *   - @subpage logNotes
118
 * - @subpage LoggingApi
119 120 121
 * - @subpage SocketSessionUtility
 * - <a href="./doxygen-error.log">Documentation warnings and errors</a>
 *
122 123
 */