BIND 10 #1531: Write documentation for libdhcp++

[BIND 10 Development]

#1531: Write documentation for libdhcp++
-------------------------------------+-------------------------------------
                   Reporter:  tomek  |                 Owner:  tomek
                       Type:         |                Status:  reviewing
  enhancement                        |             Milestone:  Sprint-
                   Priority:         |  DHCP-20120514
  medium                             |            Resolution:
                  Component:         |             Sensitive:  0
  documentation                      |           Sub-Project:  DHCP
                   Keywords:         |  Estimated Difficulty:  0
            Defect Severity:  N/A    |           Total Hours:  0
Feature Depending on Ticket:         |
        Add Hours to Ticket:  0      |
                  Internal?:  0      |
-------------------------------------+-------------------------------------

Comment (by tomek):

 Replying to [comment:8 jreed]:
 > Here are my comments:
 >
 > 1. The make devel output of wc -l is wrong. As multiple lines counted
 for single warning.
 >
 > Maybe use:
 >
 > {{{
 >         echo `grep -i ": warning:" html/doxygen-error.log | wc -l`
 warnings detected.
 > }}}
 Done.

 > 2. no corresponding clean target
 Added.

 > 3. Maybe link on left list to BIND10 Developer's Guide should say Index
 or front page.
 I don't know how to make the page title and link to it different on the
 left list.
 >
 > 4. I am not sure what "Related Pages" is for.
 It is being generated automatically. I failed to find out any obvious way
 to disable its generation.
 >
 > 5. The PROJECT_NAME should be BIND10. The PROJECT_NUMBER could be set to
 the PACKAGE_VERSION (in Makefile).
 Done. There's a slightly tricky way of passing variable to doxygen (using
 pipe, as recommended on doxygen faq page). It works ok for one variable,
 but will look very ugly if there are more parameters to pass. If that will
 be the case, we should consider migrating to Doxyfile.in and generating it
 during configure phase.

 > 6. Add link to the operators guide.
 Done.

 > These are just minor. So please just merge this in now. Thank you for
 your work on this. (I may make some the minor adjustments later.)

 I will create a separate ticket for all outstanding comments you made here
 and over mail (adding python modules to documentation).

 Thanks for the review.

 Tomek

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