Browse Source

[master] Merge branch 'trac2982'

Conflicts:
	doc/Doxyfile
	doc/devel/mainpage.dox
Stephen Morris 12 years ago
parent
commit
26a805c7e4

+ 22 - 22
doc/Doxyfile

@@ -661,37 +661,37 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 # 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/cc \
                          ../src/lib/config \
                          ../src/lib/config \
                          ../src/lib/cryptolink \
                          ../src/lib/cryptolink \
-                         ../src/lib/dns \
                          ../src/lib/datasrc \
                          ../src/lib/datasrc \
                          ../src/lib/datasrc/memory \
                          ../src/lib/datasrc/memory \
-                         ../src/bin/auth \
+                         ../src/lib/dhcp \
-                         ../src/bin/resolver \
+                         ../src/lib/dhcp_ddns \
-                         ../src/lib/bench \
+                         ../src/lib/dhcpsrv \
+                         ../src/lib/dns \
+                         ../src/lib/exceptions \
+                         ../src/lib/hooks \
                          ../src/lib/log \
                          ../src/lib/log \
                          ../src/lib/log/compiler \
                          ../src/lib/log/compiler \
-                         ../src/lib/asiolink/ \
                          ../src/lib/nsas \
                          ../src/lib/nsas \
-                         ../src/lib/testutils \
-                         ../src/lib/cache \
-                         ../src/lib/server_common/ \
-                         ../src/bin/sockcreator/ \
-                         ../src/lib/hooks/ \
-                         ../src/lib/util/ \
-                         ../src/lib/util/io/ \
-                         ../src/lib/util/threads/ \
                          ../src/lib/resolve \
                          ../src/lib/resolve \
-                         ../src/lib/acl \
+                         ../src/lib/server_common \
                          ../src/lib/statistics \
                          ../src/lib/statistics \
-                         ../src/bin/dhcp6 \
+                         ../src/lib/testutils \
-                         ../src/lib/dhcp \
+                         ../src/lib/util \
-                         ../src/lib/dhcpsrv \
+                         ../src/lib/util/io \
-                         ../src/bin/dhcp4 \
+                         ../src/lib/util/threads \
-                         ../src/lib/dhcp_ddns \
-                         ../src/bin/d2 \
                          ../tests/tools/perfdhcp \
                          ../tests/tools/perfdhcp \
                          devel
                          devel
 
 
@@ -778,7 +778,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # directories that contain image that are included in the documentation (see
 # the \image command).
 # 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
 # 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
 # invoke to filter for each input file. Doxygen will invoke the filter program

+ 2 - 1
doc/devel/mainpage.dox

@@ -36,9 +36,10 @@
  * Regardless of your field of expertise, you are encouraged to visit
  * Regardless of your field of expertise, you are encouraged to visit
  * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
  * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
  * @section hooksFramework Hooks Framework
  * @section hooksFramework Hooks Framework
- * - @subpage hooksComponentDeveloperGuide
+ * - @subpage hooksdgDevelopersGuide
  * - @subpage dhcpv4Hooks
  * - @subpage dhcpv4Hooks
  * - @subpage dhcpv6Hooks
  * - @subpage dhcpv6Hooks
+ * - @subpage hooksComponentDeveloperGuide
  *
  *
  * @section dnsMaintenanceGuide DNS Maintenance Guide
  * @section dnsMaintenanceGuide DNS Maintenance Guide
  * - Authoritative DNS (todo)
  * - Authoritative DNS (todo)

+ 1 - 1
src/bin/dhcp4/dhcp4_hooks.dox

@@ -19,7 +19,7 @@
  BIND10 features an API (the "Hooks" API) that allows user-written code to
  BIND10 features an API (the "Hooks" API) that allows user-written code to
  be integrated into BIND 10 and called at specific points in its processing.
  be integrated into BIND 10 and called at specific points in its processing.
  An overview of the API and a tutorial for writing such code can be found in
  An overview of the API and a tutorial for writing such code can be found in
- the @ref hooksDevelopersGuide.  Information for BIND 10 maintainers can be
+ the @ref hooksdgDevelopersGuide.  Information for BIND 10 maintainers can be
  found in the @ref hooksComponentDeveloperGuide.
  found in the @ref hooksComponentDeveloperGuide.
 
 
  This manual is more specialised and is aimed at developers of hook
  This manual is more specialised and is aimed at developers of hook

+ 1 - 1
src/bin/dhcp6/dhcp6_hooks.dox

@@ -19,7 +19,7 @@
  BIND10 features an API (the "Hooks" API) that allows user-written code to
  BIND10 features an API (the "Hooks" API) that allows user-written code to
  be integrated into BIND 10 and called at specific points in its processing.
  be integrated into BIND 10 and called at specific points in its processing.
  An overview of the API and a tutorial for writing such code can be found in
  An overview of the API and a tutorial for writing such code can be found in
- the @ref hooksDevelopersGuide.  Information for BIND 10 maintainers can be
+ the @ref hooksdgDevelopersGuide.  Information for BIND 10 maintainers can be
  found in the @ref hooksComponentDeveloperGuide.
  found in the @ref hooksComponentDeveloperGuide.
 
 
  This manual is more specialised and is aimed at developers of hook
  This manual is more specialised and is aimed at developers of hook

File diff suppressed because it is too large
+ 1031 - 0
src/lib/hooks/hook_user.dox


BIN
src/lib/hooks/images/DataScopeArgument.dia


BIN
src/lib/hooks/images/DataScopeArgument.png


BIN
src/lib/hooks/images/DataScopeContext.dia


BIN
src/lib/hooks/images/DataScopeContext.png