BIND 10 #1166: many doxygen fixes

[BIND 10 Development]

#1166: many doxygen fixes
-------------------------------------+-------------------------------------
            Reporter:  jreed         |                        Owner:
                Type:  defect        |                       Status:  new
            Priority:  major         |                    Milestone:  New
           Component:  Unclassified  |  Tasks
           Sensitive:  0             |                     Keywords:
         Sub-Project:  Core          |              Defect Severity:  N/A
Estimated Difficulty:  0             |  Feature Depending on Ticket:
         Total Hours:  0             |          Add Hours to Ticket:  0
                                     |                    Internal?:  0
-------------------------------------+-------------------------------------
 Please see my jreed-doxygen branch.

 Or currently:

 {{{

 git diff
 a0007d1c88df41e7796f89e24f7af5b40660fbf3^..6d842a64386a5c64a5136cadb4a1e646ee1901e5

 }}}

 It has several documentation fixes, but many are TODOs for now. I don't
 mean for this ticket to be to complete those but to confirm a few minor
 code fixes:

 {{{
 --- a/src/lib/cc/session.cc
 +++ b/src/lib/cc/session.cc
 @@ -254,7 +254,8 @@ SessionImpl::internalRead(const asio::error_code&
 error,
      }
  }

 -Session::Session(io_service& io_service) : impl_(new
 SessionImpl(io_service))
 +Session::Session(asio::io_service& io_service) :
 +    impl_(new SessionImpl(io_service))

 }}}

 {{{
 --- a/src/lib/dns/name.cc
 +++ b/src/lib/dns/name.cc
 @@ -700,7 +700,7 @@ Name::split(const unsigned int first, const unsigned
 int n)
 const {
  }

  Name
 -Name::split(const unsigned level) const {
 +Name::split(const unsigned int level) const {

 }}}

 and:

 {{{

 --- a/src/lib/log/message_dictionary.h
 +++ b/src/lib/log/message_dictionary.h
 @@ -79,7 +79,7 @@ public:
      ///
      /// \return true if the message was added to the dictionary, false if
 the
      /// message existed and it was not added.
 -    virtual bool add (const std::string& ident, const std::string& test);
 +    virtual bool add (const std::string& ident, const std::string& text);

 }}}

 (text versus test)

 This is important because I will soon to be turning on an autobuilder for
 testing doxygen docs generation.

-- 
Ticket URL: <https://bind10.isc.org/ticket/1166>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development