Opened 7 months ago

Last modified 15 hours ago

#32306 assigned defect

check-local target to enforce doxygen-correctness

Reported by: nickm Owned by: nickm
Priority: Medium Milestone: Tor: 0.4.4.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: s31-docs 044-can
Cc: nickm, catalyst Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description (last modified by nickm)

We should have a check-local target that makes sure we haven't regressed anything in Doxygen. I'm going to compile a list of what that means here, and then make the target later in November.

Current properties are:

  • Every C and H file (outside of ext, trunnel, and test) should have a @file or \file declaration.
  • @file or \file declarations should match the actual name of the file.
  • There should be no doxygen warnings (except for missing documentation).

Child Tickets

Change History (9)

comment:1 Changed 7 months ago by nickm

Description: modified (diff)

comment:2 Changed 7 months ago by catalyst

Cc: catalyst added

comment:3 Changed 7 months ago by nickm

There should be no doxygen warnings (except for missing documentation).

This part is now handled with --enable-fatal-warnings; see #32385.

comment:4 Changed 6 months ago by nickm

Parent ID: #29214

comment:5 Changed 5 months ago by ahf

Keywords: 043-can added

comment:6 Changed 5 months ago by gaba

Sponsor: Sponsor31-can

Sponsor closed. Remove from roadmap.

comment:7 Changed 5 months ago by gaba

Keywords: network-team-roadmap-november removed

comment:8 Changed 2 weeks ago by nickm

Milestone: Tor: 0.4.3.x-finalTor: 0.4.4.x-final

0.4.3 was released: Move non merge-ready 0.4.3 tickets to 044.

comment:9 Changed 15 hours ago by nickm

Keywords: 044-can added; 043-can removed
Note: See TracTickets for help on using tickets.