mainpage.dox 4.14 KB
Newer Older
1
// Copyright (C) 2012-2014  Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

15
/**
16
 * @mainpage Kea Developer's Guide
17
 *
18
 * Welcome to Kea Developer's Guide. This documentation is addressed
19
 * at existing and prospecting developers and programmers and provides
20
 * information needed to both extend and maintain Kea.
21
 *
22
 * If you wish to write "hook" code - code that is loaded by Kea at
23
 * run-time and modifies its behavior you should read the section
24
 * @ref hooksdgDevelopersGuide.
25
 *
26 27 28 29
 * 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.
30 31
 *
 * If you are a user or system administrator, rather than software engineer,
32
 * you should read the
33
 * <a href="http://kea.isc.org/docs/bind10-guide.html">Kea
34
 * Administrator Reference Manual</a> instead.
35
 *
36
 * Regardless of your field of expertise, you are encouraged to visit the
37
 * <a href="http://kea.isc.org/">Kea webpage (http://kea.isc.org)</a>
38
 *
39 40 41
 * @section contrib Contributor's Guide
 * - @subpage contributorGuide
 *
42
 * @section hooksFramework Hooks Framework
43
 * - @subpage hooksdgDevelopersGuide
44 45
 * - @subpage dhcpv4Hooks
 * - @subpage dhcpv6Hooks
46
 * - @subpage hooksComponentDeveloperGuide
47
 * - @subpage hooksmgMaintenanceGuide
48
 * - @subpage libdhcp_user_chk
49
 *
50
 * @section dhcpMaintenanceGuide DHCP Maintenance Guide
51
 * - @subpage dhcp4
52
 *   - @subpage dhcpv4Session
53 54
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
55
 *   - @subpage dhcpv4OptionsParse
56
 *   - @subpage dhcpv4DDNSIntegration
57
 *   - @subpage dhcpv4Classifier
58
 *   - @subpage dhcpv4ConfigBackend
59
 *   - @subpage dhcpv4SignalBasedReconfiguration
60
 *   - @subpage dhcpv4Other
61
 * - @subpage dhcp6
62 63 64
 *   - @subpage dhcpv6Session
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
65
 *   - @subpage dhcpv6DDNSIntegration
66
 *   - @subpage dhcpv6OptionsParse
67
 *   - @subpage dhcpv6Classifier
68
 *   - @subpage dhcpv6ConfigBackend
69
 *   - @subpage dhcpv6SignalBasedReconfiguration
70
 *   - @subpage dhcpv6Other
71
 * - @subpage d2
72
 *   - @subpage d2CPL
Jeremy C. Reed's avatar
Jeremy C. Reed committed
73
 *   - @subpage d2ProcessDerivation
74 75 76 77 78 79 80
 *   - @subpage d2ConfigMgt
 *   - @subpage d2NCRReceipt
 *   - @subpage d2DDNSUpdateExecution
 *   - @subpage d2EventLoop
 *   - @subpage d2TransDetail
 *   - @subpage d2StateModel
 *   - @subpage d2TransExecExample
81
 * - @subpage libdhcp
82
 *   - @subpage libdhcpIntro
83
 *   - @subpage libdhcpRelay
84
 *   - @subpage libdhcpIfaceMgr
85
 *   - @subpage libdhcpPktFilter
86
 *   - @subpage libdhcpPktFilter6
87
 *   - @subpage libdhcpErrorLogging
88 89 90
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
91
 *   - @subpage hostmgr
92
 *   - @subpage optionsConfig
93
 *   - @subpage allocengine
94
 * - @subpage libdhcp_ddns
95
 * - @subpage dhcpDatabaseBackends
96 97 98 99
 * - @subpage configBackend
 *   - @subpage configBackendMotivation
 *   - @subpage configBackendJSONDesign
 *   - @subpage configBackendAdding
100
 * - @subpage perfdhcpInternals
101
 *
102
 * @section miscellaneousTopics Miscellaneous Topics
103
 * - @subpage logKeaLogging
104 105 106
 *   - @subpage logBasicIdeas
 *   - @subpage logDeveloperUse
 *   - @subpage logNotes
107
 * - @subpage LoggingApi
108 109 110 111
 * - @subpage SocketSessionUtility
 * - <a href="./doxygen-error.log">Documentation warnings and errors</a>
 *
 * @image html isc-logo.png
112
 */
113 114 115 116 117
/*
 * @todo: Move the logo to the right (and possibly up). Not sure what
 * is the best way to do it in Doxygen, without using CSS hacks.
 */