[tor-bugs] #32306 [Core Tor/Tor]: check-local target to enforce doxygen-correctness

Tor Bug Tracker & Wiki blackhole at torproject.org
Sat Oct 26 15:01:09 UTC 2019


#32306: check-local target to enforce doxygen-correctness
-------------------------+-------------------------------------------------
     Reporter:  nickm    |      Owner:  nickm
         Type:  defect   |     Status:  assigned
     Priority:  Medium   |  Milestone:  Tor: 0.4.3.x-final
    Component:  Core     |    Version:
  Tor/Tor                |   Keywords:  network-team-roadmap-november,
     Severity:  Normal   |  s31-docs
Actual Points:           |  Parent ID:  #29214
       Points:           |   Reviewer:
      Sponsor:           |
  Sponsor31-can          |
-------------------------+-------------------------------------------------
 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.
   * There should be no doxygen warnings (except for missing
 documentation).

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/32306>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the tor-bugs mailing list