Browse Source

[3391] Removed references to DNS docs in from doxygen.

Marcin Siodelski 11 years ago
parent
commit
d11eba5a5e
3 changed files with 13 additions and 43 deletions
  1. 2 12
      doc/Doxyfile
  2. 0 14
      doc/devel/01-dns.dox
  3. 11 17
      doc/devel/mainpage.dox

+ 2 - 12
doc/Doxyfile

@@ -26,7 +26,7 @@ DOXYFILE_ENCODING      = UTF-8
 # identify the project. Note that if you do not use Doxywizard you need
 # to put quotes around the project name if it contains spaces.
 
-PROJECT_NAME           = BIND10
+PROJECT_NAME           = Kea
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
@@ -661,22 +661,15 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ../src/bin/auth \
-                         ../src/bin/d2 \
+INPUT                  = ../src/bin/d2 \
                          ../src/bin/dhcp4 \
                          ../src/bin/dhcp6 \
-                         ../src/bin/resolver \
                          ../src/bin/sockcreator \
                          ../src/hooks/dhcp/user_chk \
-                         ../src/lib/acl \
                          ../src/lib/asiolink \
-                         ../src/lib/bench \
-                         ../src/lib/cache \
                          ../src/lib/cc \
                          ../src/lib/config \
                          ../src/lib/cryptolink \
-                         ../src/lib/datasrc \
-                         ../src/lib/datasrc/memory \
                          ../src/lib/dhcp \
                          ../src/lib/dhcp_ddns \
                          ../src/lib/dhcpsrv \
@@ -685,10 +678,7 @@ INPUT                  = ../src/bin/auth \
                          ../src/lib/hooks \
                          ../src/lib/log \
                          ../src/lib/log/compiler \
-                         ../src/lib/nsas \
                          ../src/lib/resolve \
-                         ../src/lib/server_common \
-                         ../src/lib/statistics \
                          ../src/lib/testutils \
                          ../src/lib/util \
                          ../src/lib/util/io \

+ 0 - 14
doc/devel/01-dns.dox

@@ -1,14 +0,0 @@
-/**
- *
- * @page dns BIND10 DNS
- *
- * @section dns-auth b10-auth
- *
- * @todo: Describe b10-auth here.
- *
- * @section b10-cfgmgr b10-cfgmgr Overview
- *
- * @todo: Describe b10-cfgmgr here.
- *
- *
- */

+ 11 - 17
doc/devel/mainpage.dox

@@ -1,4 +1,4 @@
-// Copyright (C) 2012-2013  Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2012-2014  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
@@ -13,29 +13,28 @@
 // PERFORMANCE OF THIS SOFTWARE.
 
 /**
- * @mainpage BIND10 Developer's Guide
+ * @mainpage Kea Developer's Guide
  *
- * Welcome to BIND10 Developer's Guide. This documentation is addressed
+ * Welcome to Kea Developer's Guide. This documentation is addressed
  * 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
+ * If you wish to write "hook" code - code that is loaded by Kea at
  * run-time and modifies its behavior you should read the section
  * @ref hooksdgDevelopersGuide.
  *
- * BIND 10 maintenance 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.
+ * Kea maintenance information is divided into a number of sections
+ * depending on focus. Information on DHCP-specific topics can be found
+ * in the @ref dhcpMaintenanceGuide.  General topics, are discussed in
+ * @ref miscellaneousTopics.
  *
  * If you are a user or system administrator, rather than software engineer,
  * you should read the
- * <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND10
- * Guide (Administrator Reference for BIND10)</a> instead.
+ * <a href="http://kea.isc.org/docs/bind10-guide.html">Kea
+ * Guide (Administrator Reference for Kea)</a> instead.
  *
  * Regardless of your field of expertise, you are encouraged to visit the
- * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
+ * <a href="http://kea.isc.org/">Kea webpage (http://kea.isc.org)</a>
  *
  * @section contrib Contributor's Guide
  * - @subpage contributorGuide
@@ -48,11 +47,6 @@
  * - @subpage hooksmgMaintenanceGuide
  * - @subpage libdhcp_user_chk
  *
- * @section dnsMaintenanceGuide DNS Maintenance Guide
- * - Authoritative DNS (todo)
- * - Recursive resolver (todo)
- * - @subpage DataScrubbing
- *
  * @section dhcpMaintenanceGuide DHCP Maintenance Guide
  * - @subpage dhcp4
  *   - @subpage dhcpv4Session