BIND 10 #2566: Convert logging README to Doxygen format

[BIND 10 Development]

#2566: Convert logging README to Doxygen format
-------------------------------------+-------------------------------------
            Reporter:  stephen       |                        Owner:  kean
                Type:  enhancement   |                       Status:
            Priority:  low           |  reviewing
           Component:                |                    Milestone:
  documentation                      |  Sprint-20131015
            Keywords:                |                   Resolution:
           Sensitive:  0             |                 CVSS Scoring:
         Sub-Project:  DNS           |              Defect Severity:  N/A
Estimated Difficulty:  3             |  Feature Depending on Ticket:
         Total Hours:  0             |          Add Hours to Ticket:  0
                                     |                    Internal?:  0
-------------------------------------+-------------------------------------
Changes (by stephen):

 * owner:  stephen => kean


Comment:

 > I have made a commit (e1b65fae14a725bd7d162517750445bf03b3f179) with a
 few small changes. Please review.
 Reviewed and OK.  Thank you.

 > On line 482 where you discuss the Python rules for Makefile.am, are you
 sure that doesn't require the same syncrhonisation trick used for C++
 messages? I don't think it does but it's worth checking.
 I don't think so, as the Python code goes through a different "make"
 process. The intermediate "s-messages" lines were added in a ticket to
 address parallel compilation problems; the Python Makefile.am's were not
 changed, so I don't believe that synchronization was a problem in these
 cases.

 > On line 578 there is a dangling paragraph in the middle of an ordered
 list that is not a list item. How will this render?
 The paragraph should have been inside the list element.  Corrected.

 > Starting on line 603 where the arguments for the C++ initialization are
 discussed, this seems like a good candidate for using a definition list
 (<dl>) rather than using manual formatting and <b> etc. I contend that a
 definition list will render better. Similarly the next bit (variant #2)
 where discussing the environment variables, and then the Python bit, when
 describing the parameters.
 You learn something new every day - I'd not come across this types of list
 before.  Changed.

 > Line 703 consider replacing the word "borne" with "kept". Its more
 "American friendly".
 Done.  Hope that no Americans read these comments though :-)

 > In the same paragraph consider not having the last sentence
 parenthesised, which avoids the not-so-kosher parentheses-within-
 parentheses thing.
 Removed parentheses around the last sentence (but kept the inner ones).

 > Line 710 in the subsection heading. Consier using "vs." rather than just
 "v".
 According to several online sources, both "v" and "vs" are acceptable
 abbreviations for "versus".  So just to be awkward, I've used "versus" :-)

 > On line 720 where you discuss the two work-around approaches, consider
 making that an ordered list so that the two work-arounds are numbered (and
 visually indented when rendered).
 Good point, done.

 I've also made some miscellaneous changes to the text.

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