BIND 10 #2982: Hooks Framework - Hook Developer Documentation (was: Hooks Framework - Documentation)

[BIND 10 Development]

#2982: Hooks Framework - Hook Developer Documentation
-------------------------------------+-------------------------------------
            Reporter:  stephen       |                        Owner:
                Type:  enhancement   |                       Status:  new
            Priority:  medium        |                    Milestone:
           Component:                |  Sprint-DHCP-20130620
  documentation                      |                   Resolution:
            Keywords:                |                 CVSS Scoring:
           Sensitive:  0             |              Defect Severity:  N/A
         Sub-Project:  DHCP          |  Feature Depending on Ticket:
Estimated Difficulty:  0             |          Add Hours to Ticket:  0
         Total Hours:  0             |                    Internal?:  0
-------------------------------------+-------------------------------------

Old description:

> Produce documentation of the Hooks framework.  This comprises two parts:
>
> 1. User documentation.  A description of the framework, together with
> instructions (and examples) on how to build a user-loadable library.
> (This does '''not''' include a description of the hooks in each server -
> that is the subject of a separate ticket.)
>
> 2. Update the BIND 10 developers' Guide with a description of the hooks
> framework. (This essentially means converting the documentation in the
> [Bind10HooksFramework Hooks Framework design] to Doxygen format and
> including it in the source tree.

New description:

 Produce documentation of the Hooks framework.  This comprises two parts:

 A description of the framework, together with instructions (and examples)
 on how to build a user-loadable library. (This does '''not''' include a
 description of the hooks in each server - that is the subject of a
 separate ticket.)

--

Comment (by stephen):

 The maintenance documentation was split into a separate ticket, #2999

-- 
Ticket URL: <http://bind10.isc.org/ticket/2982#comment:1>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development