mainpage.dox 3.77 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Copyright (C) 2012-2013  Internet Systems Consortium, Inc. ("ISC")
//
// 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 17 18
/**
 * @mainpage BIND10 Developer's Guide
 *
 * Welcome to BIND10 Developer's Guide. This documentation is addressed
19 20 21 22 23
 * at existing and prospecting developers and programmers and provides
 * information needed to both extend and maintain BIND 10.
 *
 * If you wish to write "hook" code - code that is loaded by BIND 10 at
 * run-time and modifies its behavior you should read the section
24
 * @ref hooksdgDevelopersGuide.
25
 *
Jeremy C. Reed's avatar
Jeremy C. Reed committed
26
 * BIND 10 maintenance information is divided into a number of sections
27 28 29 30
 * depending on focus.  DNS-specific issues are covered in the
 * @ref dnsMaintenanceGuide while information on DHCP-specific topics can
 * be found in the @ref dhcpMaintenanceGuide.  General BIND 10 topics, not
 * specific to any protocol, are discussed in @ref miscellaneousTopics.
31 32
 *
 * If you are a user or system administrator, rather than software engineer,
33 34
 * you should read the
 * <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND10
35
 * Guide (Administrator Reference for BIND10)</a> instead.
36
 *
37
 * Regardless of your field of expertise, you are encouraged to visit the
38
 * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
39
 *
40 41 42
 * @section contrib Contributor's Guide
 * - @subpage contributorGuide
 *
43
 * @section hooksFramework Hooks Framework
44
 * - @subpage hooksdgDevelopersGuide
45 46
 * - @subpage dhcpv4Hooks
 * - @subpage dhcpv6Hooks
47
 * - @subpage hooksComponentDeveloperGuide
48
 * - @subpage hooksmgMaintenanceGuide
49
 * - @subpage libdhcp_user_chk
50
 *
51
 * @section dnsMaintenanceGuide DNS Maintenance Guide
52 53
 * - Authoritative DNS (todo)
 * - Recursive resolver (todo)
54 55
 * - @subpage DataScrubbing
 *
56
 * @section dhcpMaintenanceGuide DHCP Maintenance Guide
57
 * - @subpage dhcp4
58
 *   - @subpage dhcpv4Session
59 60
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
61
 *   - @subpage dhcpv4OptionsParse
62
 *   - @subpage dhcpv4DDNSIntegration
63
 *   - @subpage dhcpv4Classifier
64
 *   - @subpage dhcpv4Other
65
 * - @subpage dhcp6
66 67 68
 *   - @subpage dhcpv6Session
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
69
 *   - @subpage dhcpv6DDNSIntegration
70
 *   - @subpage dhcpv6OptionsParse
71
 *   - @subpage dhcpv6Classifier
72
 *   - @subpage dhcpv6Other
73
 * - @subpage libdhcp
74
 *   - @subpage libdhcpIntro
75
 *   - @subpage libdhcpRelay
76
 *   - @subpage libdhcpIfaceMgr
77
 *   - @subpage libdhcpPktFilter
78
 *   - @subpage libdhcpPktFilter6
79
 *   - @subpage libdhcpErrorLogging
80 81 82 83
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
 *   - @subpage allocengine
84
 * - @subpage dhcpDatabaseBackends
85
 * - @subpage perfdhcpInternals
86
 * - @subpage libdhcp_ddns
87
 *
88
 * @section miscellaneousTopics Miscellaneous Topics
89 90 91 92
 * - @subpage logBind10Logging
 *   - @subpage logBasicIdeas
 *   - @subpage logDeveloperUse
 *   - @subpage logNotes
93 94 95 96
 * - @subpage SocketSessionUtility
 * - <a href="./doxygen-error.log">Documentation warnings and errors</a>
 *
 * @image html isc-logo.png
97
 */
98 99 100 101 102
/*
 * @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.
 */