mainpage.dox 4.36 KB
Newer Older
1
// Copyright (C) 2012-2016 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
 * Welcome to the Kea Developer's Guide. This documentation is addressed at
11
 * either existing or prospective Kea developers and contributors, and
12
 * provides information needed to extend and maintain Kea source code.
13

14
 * If you wish to write hook code - the 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
 * Kea maintenance information is divided into a number of sections.
 * Information on DHCP-specific topics can be found
 * in the @ref dhcpMaintenanceGuide.  General topics are discussed in
21
 * @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
 * @section contrib Contributor's Guide
35 36 37
 * - @subpage contributorGuide - This page describes the process of sending
 * a patch to ISC and what happens next. Please read it if you are considering
 * sending us any code.
38
 *
39 40 41 42 43 44
 * @section buildingKeaWithUnitTests Building Kea with Unit tests
 * - @subpage unitTests
 *   - @subpage unitTestsIntroduction
 *   - @subpage unitTestsEnvironmentVariables
 *   - @subpage unitTestsDatabaseConfig
 *
45
 * @section hooksFramework Hooks Framework
46
 * - @subpage hooksdgDevelopersGuide
47 48
 * - @subpage dhcpv4Hooks
 * - @subpage dhcpv6Hooks
49
 * - @subpage hooksComponentDeveloperGuide
50
 * - @subpage hooksmgMaintenanceGuide
51
 * - @subpage libdhcp_user_chk
52
 *
53
 * @section dhcpMaintenanceGuide DHCP Maintenance Guide
54
 * - @subpage dhcp4
55 56
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
57
 *   - @subpage dhcpv4OptionsParse
58
 *   - @subpage dhcpv4DDNSIntegration
59
 *   - @subpage dhcpv4Classifier
60
 *   - @subpage dhcpv4ConfigBackend
61
 *   - @subpage dhcpv4SignalBasedReconfiguration
62
 *   - @subpage dhcpv4Other
63
 *   - @subpage dhcpv4o6Dhcp4
64
 * - @subpage dhcp6
65 66
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
67
 *   - @subpage dhcpv6DDNSIntegration
68
 *   - @subpage dhcpv6OptionsParse
69
 *   - @subpage dhcpv6Classifier
70
 *   - @subpage dhcpv6ConfigBackend
71
 *   - @subpage dhcpv6SignalBasedReconfiguration
72
 *   - @subpage dhcpv6Other
73
 *   - @subpage dhcpv4o6Dhcp6
74 75 76
 * - @subpage libprocess
 *   - @subpage cpl
 *   - @subpage cplSignals
77
 * - @subpage d2
Jeremy C. Reed's avatar
Jeremy C. Reed committed
78
 *   - @subpage d2ProcessDerivation
79 80 81 82 83 84 85
 *   - @subpage d2ConfigMgt
 *   - @subpage d2NCRReceipt
 *   - @subpage d2DDNSUpdateExecution
 *   - @subpage d2EventLoop
 *   - @subpage d2TransDetail
 *   - @subpage d2StateModel
 *   - @subpage d2TransExecExample
86 87 88
 * - @subpage lfc
 *   - @subpage lfcProcessing
 *   - @subpage lfcFiles
89 90 91 92 93
 * - @subpage ctrlSocket
 *   - @subpage ctrlSocketOverview
 *   - @subpage ctrlSocketClient
 *   - @subpage ctrlSocketImpl
 *   - @subpage ctrlSocketConnections
94
 * - @subpage libdhcp
95
 *   - @subpage libdhcpIntro
96
 *   - @subpage libdhcpRelay
97
 *   - @subpage libdhcpIfaceMgr
98
 *   - @subpage libdhcpPktFilter
99
 *   - @subpage libdhcpPktFilter6
100
 *   - @subpage libdhcpErrorLogging
101 102 103
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
104
 *   - @subpage hostmgr
105
 *   - @subpage optionsConfig
106
 *   - @subpage allocengine
107 108
 *   - @subpage timerManager
 *   - @subpage leaseReclamationRoutine
109 110
 *   - @subpage subnetSelect
 *   - @subpage dhcp4o6Ipc
111
 * - @subpage libdhcp_ddns
112
 * - @subpage dhcpDatabaseBackends
113
 * - @subpage dhcpEval
114 115
 * - @subpage configBackend
 *   - @subpage configBackendJSONDesign
116
 * - @subpage perfdhcpInternals
117
 *
118
 * @section miscellaneousTopics Miscellaneous Topics
119
 * - @subpage logKeaLogging
120 121 122
 *   - @subpage logBasicIdeas
 *   - @subpage logDeveloperUse
 *   - @subpage logNotes
123
 * - @subpage LoggingApi
124 125 126
 * - @subpage SocketSessionUtility
 * - <a href="./doxygen-error.log">Documentation warnings and errors</a>
 *
127 128
 */