Opened 8 years ago

Closed 8 years ago

#1166 closed defect (complete)

many doxygen fixes

Reported by: jreed Owned by: jreed
Priority: medium Milestone: Sprint-20111108
Component: Unclassified Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: Core Feature Depending on Ticket:
Estimated Difficulty: 2 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description

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.

Subtickets

Change History (10)

comment:1 Changed 8 years ago by shane

  • Milestone changed from New Tasks to Sprint-20110816

comment:2 Changed 8 years ago by stephen

  • Owner set to stephen
  • Status changed from new to assigned

comment:3 Changed 8 years ago by stephen

  • Owner changed from stephen to jreed
  • Status changed from assigned to reviewing

Reviewed jreed-doxygen commit 6d842a64386a5c64a5136cadb4a1e646ee1901e5. 30 files had changed since it was branched from master at 6c44ca2eaa94224d60ceac2602ee9c6846fabf18. All code changes above are OK.

Some modifications made to fix doxygen-related TODOs - these now need a review.

comment:4 Changed 8 years ago by stephen

  • Estimated Difficulty changed from 0 to 2

comment:5 Changed 8 years ago by jelte

  • Milestone changed from Sprint-20110927 to Sprint-20111011

comment:6 Changed 8 years ago by jelte

  • Milestone changed from Sprint-20111011 to Sprint-20111025

comment:7 Changed 8 years ago by shane

Has this been merged? Can we close the ticket? Or...?

comment:8 Changed 8 years ago by jelte

  • Milestone changed from Sprint-20111025 to Sprint-20111108

comment:9 Changed 8 years ago by jreed

fb7f61b8d2e05fa89b908770b1d009f8cda03334 needs to be reviewed.

comment:10 Changed 8 years ago by jreed

  • Resolution set to complete
  • Status changed from reviewing to closed

I merged to master.

I reviewed the doxygen improvements from stephen.

The one non-doxygen fix I didn't put into master but made a new ticket for it #1366.

Closing this.

Many doxygen fixes still to do, but will do item by item instead of bundling up many at a time. I will also get a doxygen builder going to report issues with it.

Note: See TracTickets for help on using tickets.