kea/doc/devel/mainpage.dox

/**
 *
 * @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,
 * you should read <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND10
 * Guide (Administrator Reference for BIND10)</a> instead.
 *
 * 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
 * - Authoritative DNS (todo)
 * - Recursive resolver (todo)
 * - @subpage DataScrubbing
 *
 * @section DHCP
 * - @subpage dhcp4
 *   - @subpage dhcpv4Session
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
 * - @subpage dhcp6
 *   - @subpage dhcpv6Session
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
 * - @subpage libdhcp
 *   - @subpage libdhcpIntro
 *   - @subpage libdhcpIfaceMgr
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
 *   - @subpage allocengine
 * - @subpage dhcpDatabaseBackends
 * - @subpage perfdhcpInternals
 *
 * @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
 */
[1531] Several developer documentation updates: - Added make devel target in doc directory. - Doxygen warnings/errors are now part of the Developer's guide itself. - renamed mainpage.dox file - Added extra information to main page - Extended libdhcp++ descriptions - Added doc/.gitignore to ignore doc/html (potentially 1000s of files) 2012-03-19 14:54:18 +01:00			`/**`
			`*`
			`* @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,`
[1531] Changes after Jeremy's review. 2012-05-08 17:08:48 +02:00			`* you should read <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND10`
			`* Guide (Administrator Reference for BIND10)</a> instead.`
[1531] Several developer documentation updates: - Added make devel target in doc directory. - Doxygen warnings/errors are now part of the Developer's guide itself. - renamed mainpage.dox file - Added extra information to main page - Extended libdhcp++ descriptions - Added doc/.gitignore to ignore doc/html (potentially 1000s of files) 2012-03-19 14:54:18 +01:00			`*`
			`* 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`
[2269] Developer's guide updated. 2012-10-01 19:19:49 +02:00			`* - Authoritative DNS (todo)`
			`* - Recursive resolver (todo)`
[1531] Several developer documentation updates: - Added make devel target in doc directory. - Doxygen warnings/errors are now part of the Developer's guide itself. - renamed mainpage.dox file - Added extra information to main page - Extended libdhcp++ descriptions - Added doc/.gitignore to ignore doc/html (potentially 1000s of files) 2012-03-19 14:54:18 +01:00			`* - @subpage DataScrubbing`
			`*`
			`* @section DHCP`
[2270] Documentation for DHCPv4 config. parser written. 2012-10-12 14:55:59 +02:00			`* - @subpage dhcp4`
[1651] Tests for IfaceMgr callback implemented, devel doc updated 2012-06-01 14:46:05 +02:00			`* - @subpage dhcpv4Session`
[2546] Merge branch 'master' into trac2546 Conflicts: doc/devel/mainpage.dox src/bin/dhcp4/ctrl_dhcp4_srv.h src/bin/dhcp4/dhcp4_srv.h src/bin/dhcp6/dhcp6.dox Also modified the following files during the resolution of the merge issues: src/bin/dhcp4/config_parser.cc src/bin/dhcp4/ctrl_dhcp4_srv.cc src/bin/dhcp4/dhcp4.dox src/bin/dhcp6/config_parser.cc src/bin/dhcp6/tests/dhcp6_srv_unittest.cc src/lib/dhcp/option_custom.h src/lib/dhcp/pkt4.h src/lib/dhcpsrv/database_backends.dox 2012-12-13 11:38:21 +00:00			`* - @subpage dhcpv4ConfigParser`
			`* - @subpage dhcpv4ConfigInherit`
[2270] Documentation for DHCPv4 config. parser written. 2012-10-12 14:55:59 +02:00			`* - @subpage dhcp6`
[2546] Fixed some Doxygen warnings 2012-12-10 13:54:46 +00:00			`* - @subpage dhcpv6Session`
			`* - @subpage dhcpv6ConfigParser`
			`* - @subpage dhcpv6ConfigInherit`
[1531] Several developer documentation updates: - Added make devel target in doc directory. - Doxygen warnings/errors are now part of the Developer's guide itself. - renamed mainpage.dox file - Added extra information to main page - Extended libdhcp++ descriptions - Added doc/.gitignore to ignore doc/html (potentially 1000s of files) 2012-03-19 14:54:18 +01:00			`* - @subpage libdhcp`
[1651] Tests for IfaceMgr callback implemented, devel doc updated 2012-06-01 14:46:05 +02:00			`* - @subpage libdhcpIntro`
			`* - @subpage libdhcpIfaceMgr`
[2324] Developer's Guide section written 2012-10-25 13:46:02 +02:00			`* - @subpage libdhcpsrv`
			`* - @subpage leasemgr`
			`* - @subpage cfgmgr`
			`* - @subpage allocengine`
[2546] Merge branch 'master' into trac2546 Conflicts: doc/devel/mainpage.dox src/bin/dhcp4/ctrl_dhcp4_srv.h src/bin/dhcp4/dhcp4_srv.h src/bin/dhcp6/dhcp6.dox Also modified the following files during the resolution of the merge issues: src/bin/dhcp4/config_parser.cc src/bin/dhcp4/ctrl_dhcp4_srv.cc src/bin/dhcp4/dhcp4.dox src/bin/dhcp6/config_parser.cc src/bin/dhcp6/tests/dhcp6_srv_unittest.cc src/lib/dhcp/option_custom.h src/lib/dhcp/pkt4.h src/lib/dhcpsrv/database_backends.dox 2012-12-13 11:38:21 +00:00			`* - @subpage dhcpDatabaseBackends`
[2230] Add perfdhcp internals manual as Doxygen file 2012-09-13 11:02:23 +02:00			`* - @subpage perfdhcpInternals`
[1531] Several developer documentation updates: - Added make devel target in doc directory. - Doxygen warnings/errors are now part of the Developer's guide itself. - renamed mainpage.dox file - Added extra information to main page - Extended libdhcp++ descriptions - Added doc/.gitignore to ignore doc/html (potentially 1000s of files) 2012-03-19 14:54:18 +01:00			`*`
			`* @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`
[2230] Add perfdhcp internals manual as Doxygen file 2012-09-13 11:02:23 +02:00			`*/`