mainpage.dox 1.73 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
/**
 *
 * @mainpage BIND10 Developer's Guide
 *
 * Welcome to BIND10 Developer's Guide. This documentation is addressed
 * at existing and prospecting developers and programmers, who would like
 * to gain insight into internal workings of BIND 10. It could also be useful
 * for existing and prospective contributors.
 *
 * If you are a user or system administrator, rather than software engineer,
11 12
 * you should read <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND10
 * Guide (Administrator Reference for BIND10)</a> instead.
13 14 15 16 17
 *
 * Regardless of your field of expertise, you are encouraged to visit
 * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
 *
 * @section DNS
18 19
 * - Authoritative DNS (todo)
 * - Recursive resolver (todo)
20 21 22
 * - @subpage DataScrubbing
 *
 * @section DHCP
23
 * - @subpage dhcp4
24
 *   - @subpage dhcpv4Session
25 26
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
27
 * - @subpage dhcp6
28 29 30
 *   - @subpage dhcpv6Session
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
31
 * - @subpage libdhcp
32 33
 *   - @subpage libdhcpIntro
 *   - @subpage libdhcpIfaceMgr
34 35 36 37
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
 *   - @subpage allocengine
38
 * - @subpage dhcpDatabaseBackends
39
 * - @subpage perfdhcpInternals
40 41 42 43 44 45 46 47 48 49 50 51
 *
 * @section misc Miscellaneous topics
 * - @subpage LoggingApi
 *   - @subpage LoggingApiOverview
 *   - @subpage LoggingApiLoggerNames
 *   - @subpage LoggingApiLoggingMessages
 * - @subpage SocketSessionUtility
 * - <a href="./doxygen-error.log">Documentation warnings and errors</a>
 *
 * @todo: Move this logo to the right (and possibly up). Not sure what
 * is the best way to do it in Doxygen, without using CSS hacks.
 * @image html isc-logo.png
52
 */