Commit 77c1644d authored by Stephen Morris's avatar Stephen Morris
Browse files

[2982] First draft of Hooks user guide

parent 67704c85
......@@ -661,35 +661,36 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = ../src/lib/exceptions \
INPUT = ../src/bin/auth \
../src/bin/d2 \
../src/bin/dhcp4 \
../src/bin/dhcp6 \
../src/bin/resolver \
../src/bin/sockcreator/ \
../src/lib/acl \
../src/lib/asiolink/ \
../src/lib/bench \
../src/lib/cache \
../src/lib/cc \
../src/lib/config \
../src/lib/cryptolink \
../src/lib/dns \
../src/lib/datasrc \
../src/lib/datasrc/memory \
../src/bin/auth \
../src/bin/resolver \
../src/lib/bench \
../src/lib/dhcp \
../src/lib/dhcpsrv \
../src/lib/dns \
../src/lib/exceptions \
../src/lib/hooks \
../src/lib/log \
../src/lib/log/compiler \
../src/lib/asiolink/ \
../src/lib/nsas \
../src/lib/testutils \
../src/lib/cache \
../src/lib/resolve \
../src/lib/server_common/ \
../src/bin/sockcreator/ \
../src/lib/statistics \
../src/lib/testutils \
../src/lib/util/ \
../src/lib/util/io/ \
../src/lib/util/threads/ \
../src/lib/resolve \
../src/lib/acl \
../src/lib/statistics \
../src/bin/dhcp6 \
../src/lib/dhcp \
../src/lib/dhcpsrv \
../src/bin/dhcp4 \
../src/bin/d2 \
../tests/tools/perfdhcp \
devel
......@@ -776,7 +777,7 @@ EXAMPLE_RECURSIVE = NO
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH = ../doc/images
IMAGE_PATH = ../doc/images ../src/lib/hooks/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
......
// 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.
/**
*
* @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.
* 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.
*
* 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
......@@ -14,12 +36,29 @@
* 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
* @section hookDevelopersGuide
* - @subpage hookIntroduction
* - @subpage hookLanguages
* - @subpage hookTerminology
* - @subpage hookTutorial
* - @subpage hookFrameworkFunctions
* - @subpage hookCallouts
* - @subpage hookExampleCallouts
* - @subpage hookBuild
* - @subpage hookConfiguration
* - @subpage hookAdvancedTopics
* - @subpage hookContextCreateDestroy
* - @subpage hookCalloutRegistration
* - @subpage hookMultipleLibraries
* - @subpage hookInterLibraryData
* - @subpage hookRegisterMultipleLibraries
*
* @section dnsMaintenanceGuide DNS Maintenance Guide
* - Authoritative DNS (todo)
* - Recursive resolver (todo)
* - @subpage DataScrubbing
*
* @section DHCP
* @section dhcpMaintenanceGuide DHCP Maintenance Guide
* - @subpage dhcp4
* - @subpage dhcpv4Session
* - @subpage dhcpv4ConfigParser
......@@ -39,7 +78,7 @@
* - @subpage dhcpDatabaseBackends
* - @subpage perfdhcpInternals
*
* @section misc Miscellaneous topics
* @section miscellaneousTopics Miscellaneous topics
* - @subpage LoggingApi
* - @subpage LoggingApiOverview
* - @subpage LoggingApiLoggerNames
......@@ -47,7 +86,10 @@
* - @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
*/
/*
* @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.
*/
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment