From 1b9ab32f79fe18b25a378808192cc2f8f5f6c718 Mon Sep 17 00:00:00 2001
From: Tomek Mrugalski <tomasz@isc.org>
Date: Fri, 27 Jan 2012 14:36:29 +0100
Subject: [PATCH] [1531] Initial pages for Developer's Guide

---
 doc/devel/00-mainpage.dox | 28 ++++++++++++++++++++++++++++
 doc/devel/01-dns.dox      | 14 ++++++++++++++
 doc/devel/02-dhcp.dox     | 32 ++++++++++++++++++++++++++++++++
 3 files changed, 74 insertions(+)
 create mode 100644 doc/devel/00-mainpage.dox
 create mode 100644 doc/devel/01-dns.dox
 create mode 100644 doc/devel/02-dhcp.dox

diff --git a/doc/devel/00-mainpage.dox b/doc/devel/00-mainpage.dox
new file mode 100644
index 0000000000..1ebda2baa7
--- /dev/null
+++ b/doc/devel/00-mainpage.dox
@@ -0,0 +1,28 @@
+/**
+ *
+ * @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.
+ *
+ * If you are a user or system administrator, rather than software engineer,
+ * you should read BIND10 Guide instead.
+ *
+ * @section DNS
+ * - @subpage DataScrubbing
+ * @section DHCP
+
+ * - @subpage dhcpv4
+ * - @subpage dhcpv6
+ * - @subpage libdhcp
+ *
+ * @section Miscellaneous topics
+ * - @subpage LoggingApi
+ *   - @subpage LoggingApiOverview
+ *   - @subpage LoggingApiLoggerNames
+ *   - @subpage LoggingApiLoggingMessages
+ * - @subpage SocketSessionUtility
+ *
+ * <a href="./doxygen-error.log">Documentation warnings and errors</a>
+ */
\ No newline at end of file
diff --git a/doc/devel/01-dns.dox b/doc/devel/01-dns.dox
new file mode 100644
index 0000000000..e72dbbde2e
--- /dev/null
+++ b/doc/devel/01-dns.dox
@@ -0,0 +1,14 @@
+/**
+ *
+ * @page dns BIND10 DNS
+ *
+ * @section dns-auth b10-auth
+ *
+ * @todo: Describe b10-auth here.
+ *
+ * @section b10-cfgmgr b10-cfgmgr Overview
+ *
+ * @todo: Descibe b10-cfgmgr here.
+ *
+ *
+ */
diff --git a/doc/devel/02-dhcp.dox b/doc/devel/02-dhcp.dox
new file mode 100644
index 0000000000..d0a2a6b7f6
--- /dev/null
+++ b/doc/devel/02-dhcp.dox
@@ -0,0 +1,32 @@
+/**
+ * @page dhcpv4 DHCPv4 Component
+ *
+ * BIND10 offers DHCPv4 server implementation. It is implemented as b10-dhcp4 component.
+ * It's primary code is located in isc::dhcp::Dhcpv4Srv class. It uses \ref libdhcp extensively,
+ * especially isc::dhcp::Pkt4, isc::dhcp::Option and isc::dhcp::IfaceMgr classes.
+ *
+ * @todo Describe DHCPv4 component properly.
+ * 
+ * @page dhcpv6 DHCPv6 Component
+ *
+ * @todo DHCPv6 component will be described here.
+ * 
+ * @page libdhcp libdhcp++ library
+ *
+ * @section libdhcpIntro Libdhcp++ Introduction
+ *
+ * libdhcp++ is an all-purpose DHCP-manipulation library, written in C++. It offers packet 
+ * parsing and assembly, DHCPv4 and DHCPv6 options parsing and assembly, interface detection
+ * (currently on Linux systems only) and socket operations. Following classes are implemented:
+ *
+ * - isc::dhcp::Pkt4 - represents DHCPv4 packet.
+ * - isc::dhcp::Pkt6 - represents DHCPv6 packet.
+ *
+ * @section lidhcpIfaceMgr Interface Manager
+ *
+ * Interface Manager (or IfaceMgr) is an abstraction layer about low-level network operations.
+ * In particlar, it provides information about existing network interfaces See isc::dhcp::IfaceMgr::Iface 
+ * class and isc::dhcp::IfaceMgr::detectIfaces() and isc::dhcp::IfaceMgr::getIface().
+ * Another useful methods are dedicated to transmission (isc::dhcp::IfaceMgr::send(), 2 overloads) 
+ * and reception (isc::dhcp::IfaceMgr::receive4() and isc::dhcp::IfaceMgr::receive6()).
+ */
\ No newline at end of file