Opened 8 months ago

Closed 6 months ago

#32100 closed defect (fixed)

Resolve all doxygen warnings

Reported by: nickm Owned by: nickm
Priority: Medium Milestone: Tor: 0.4.3.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: network-team-roadmap-november, s31-docs
Cc: nickm, catalyst Actual Points: .2
Parent ID: #29214 Points: .5
Reviewer: dgoulet, ahf Sponsor: Sponsor31-can

Description

Right now doxygen produces some warnings when we run it; we should fix all of those.

Child Tickets

Change History (10)

comment:1 Changed 8 months ago by nickm

Actual Points: .1
Status: assignedneeds_review

For most of these, I can fix them by changes to the doxygen comments. See branch ticket32100. PR at https://github.com/torproject/tor/pull/1413

The other fixes would require changes to the Doxyfile. I'll do them as a separate branch, since there are other issues to handle there.

comment:2 Changed 8 months ago by ahf

Status: needs_reviewmerge_ready

Looks fine. Good catches. Can we detect the wrong tags somehow automatically?

comment:3 Changed 8 months ago by nickm

Status: merge_readyaccepted

Doxygen does; it warns about them.

Merged to master; back into accepted for remaining changes.

comment:4 Changed 8 months ago by nickm

Actual Points: .1.2

New branch in ticket32100, PR at https://github.com/torproject/tor/pull/1416 .

This one changes a little C, and some doxygen options. It fixes all of the doxygen warnings except the ones about missing documentation.

comment:5 Changed 8 months ago by nickm

Status: acceptedneeds_review

comment:6 Changed 7 months ago by gaba

Sponsor: Sponsor31-can

comment:7 Changed 7 months ago by dgoulet

Reviewer: dgoulet, ahf
Status: needs_reviewmerge_ready

PR 1416 lgtm;

comment:8 Changed 7 months ago by nickm

Status: merge_readyaccepted

merged!

Now the only doxygen warnings are ones about missing docs.

comment:9 Changed 7 months ago by catalyst

Cc: catalyst added

comment:10 Changed 6 months ago by nickm

Resolution: fixed
Status: acceptedclosed

This is done, except for the "missing docs" one, which are outside of scope (and now off-by-default).

Note: See TracTickets for help on using tickets.