mainpage.dox 3.29 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 24 25 26 27 28 29 30
 * 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
 * @ref hookDevelopersGuide.
 *
 * BIND 10 maintanenace information is divided into a number of sections
 * 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 <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND10
 * Guide (Administrator Reference for BIND10)</a> instead.
35 36 37
 *
 * Regardless of your field of expertise, you are encouraged to visit
 * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
38 39
 * @section hooksFramework Hooks Framework
 * - @subpage hooksComponentDeveloperGuide
40 41
 * - @subpage dhcpv4Hooks
 * - @subpage dhcpv6Hooks
42
 *
43
 * @section dnsMaintenanceGuide DNS Maintenance Guide
44 45
 * - Authoritative DNS (todo)
 * - Recursive resolver (todo)
46 47
 * - @subpage DataScrubbing
 *
48
 * @section dhcpMaintenanceGuide DHCP Maintenance Guide
49
 * - @subpage dhcp4
50
 *   - @subpage dhcpv4Session
51 52
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
53
 *   - @subpage dhcpv4Other
54
 * - @subpage dhcp6
55 56 57
 *   - @subpage dhcpv6Session
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
58
 *   - @subpage dhcpv6Other
59
 * - @subpage libdhcp
60
 *   - @subpage libdhcpIntro
61
 *   - @subpage libdhcpRelay
62
 *   - @subpage libdhcpIfaceMgr
63 64 65 66
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
 *   - @subpage allocengine
67
 * - @subpage dhcpDatabaseBackends
68
 * - @subpage perfdhcpInternals
69
 * - @subpage libdhcp_ddns
70
 *
71
 * @section miscellaneousTopics Miscellaneous topics
72 73 74 75 76 77 78 79
 * - @subpage LoggingApi
 *   - @subpage LoggingApiOverview
 *   - @subpage LoggingApiLoggerNames
 *   - @subpage LoggingApiLoggingMessages
 * - @subpage SocketSessionUtility
 * - <a href="./doxygen-error.log">Documentation warnings and errors</a>
 *
 * @image html isc-logo.png
80
 */
81 82 83 84 85
/*
 * @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.
 */