Opened 7 years ago

Closed 7 years ago

#2017 closed defect (fixed)

Doxygen warnings should be removed

Reported by: tomek Owned by: tomek
Priority: medium Milestone: DHCP-Sprint-20120611
Component: documentation Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: DNS Feature Depending on Ticket:
Estimated Difficulty: 0 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description

The file with doxygen warnings (doc/html/doxygen-error.log) is over 80 lines long. This ticket attempts to fix some of them.

Subtickets

Change History (7)

comment:1 Changed 7 years ago by tomek

  • Milestone changed from New Tasks to DHCP-Sprint-20120611

comment:2 Changed 7 years ago by tomek

  • Status changed from new to accepted

comment:3 Changed 7 years ago by tomek

  • Owner changed from tomek to UnAssigned
  • Status changed from accepted to reviewing

To generate Developer's guide:

$ cd doc
$ make devel

Then open doc/html/index.html and click on "Document warnings and errors" (or open doc/html/doxygen-error.log directly).

Number of outstanding warnings decreased from 83 to 17.

Changes are ready for review. (Most are trivial, so review shouldn't take more than 10 minutes).

comment:4 Changed 7 years ago by jinmei

Thanks for taking on the cleanup.

I've made some trivial cleanups, mainly folding long lines.

Otherwise the branch looks okay (although I actually didn't run
doxygen myself). Please feel free to merge.

Some observations, mainly for next steps:

  • if we always need to fully qualify parameter types like std::string even if it's in the context of 'using namespace std', I'm afraid we'll easily make this of (doxygen) error again. So if there's a less error-prone way to avoid the issue, that would be better.
  • maybe we should avoid using '<' or '>' in doxygen in general.

comment:5 Changed 7 years ago by jinmei

  • Owner changed from UnAssigned to muks

comment:6 Changed 7 years ago by tomek

  • Owner changed from muks to tomek

comment:7 Changed 7 years ago by tomek

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

Changes merged to master. Closing ticket.

Note: See TracTickets for help on using tickets.