[tor-bugs] #32307 [Core Tor/Tor]: Most every C file needs a doxygen @file declaration

[Tor Bug Tracker & Wiki]

#32307: Most every C file needs a doxygen @file declaration
-------------------------------------------------+-------------------------
 Reporter:  nickm                                |          Owner:  nickm
     Type:  defect                               |         Status:
                                                 |  needs_review
 Priority:  Medium                               |      Milestone:  Tor:
                                                 |  0.4.3.x-final
Component:  Core Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  network-team-roadmap-november,       |  Actual Points:  .1
  s31-docs                                       |
Parent ID:  #32306                               |         Points:  .1
 Reviewer:                                       |        Sponsor:
                                                 |  Sponsor31-can
-------------------------------------------------+-------------------------
Changes (by nickm):

 * status:  assigned => needs_review
 * actualpoints:   => .1


Comment:

 This is a comments-only set of changes, affecting doxygen output.  There
 were about 130 files that doxygen was ignoring!

 See branch `ticket32308` with PR in
 https://github.com/torproject/tor/pull/1476 .

 I'm not sure whether this meets the threshold for what I might merge
 without review; it does seem a little larger than is intended by
 "editorial fixes" on our merge policy.

 Some of the per-file documentation I added here could stand to be more
 verbose.  If it's okay with the reviewer, I'd like to have a separate
 tickets about that.  Without this minimal per-file documentation, all of
 the member documentation in each file remains ignored by Doxygen.

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