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

[Tor Bug Tracker & Wiki]

#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 Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  network-team-roadmap-november,       |  Actual Points:
  s31-docs                                       |
Parent ID:  #29214                               |         Points:
 Reviewer:                                       |        Sponsor:
                                                 |  Sponsor31-can
-------------------------------------------------+-------------------------
Description changed by nickm:

Old description:

> 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).

New description:

 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).

--

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