Most every C file needs a doxygen @file declaration
Doxygen does not generate any documentation for files that do not say @file or \file. We have dozens of those right now.
Activity
changed milestone to %Tor: 0.4.3.x-final in legacy/trac
Trac:
Parent Ticket: legacy/trac#29214 (moved)added actualpoints::.1 in Legacy / Trac component::core tor/tor in Legacy / Trac milestone::Tor: 0.4.3.x-final in Legacy / Trac network-team-roadmap-november in Legacy / Trac owner::nickm in Legacy / Trac parent::29214 in Legacy / Trac points::.1 in Legacy / Trac priority::medium in Legacy / Trac resolution::fixed in Legacy / Trac reviewer::dgoulet in Legacy / Trac s31-docs in Legacy / Trac severity::normal in Legacy / Trac sponsor::31-can in Legacy / Trac status::closed in Legacy / Trac type::defect in Legacy / Trac labels
See legacy/trac#32306 (moved) for a ticket about writing rules to enforce this.
-
This is a comments-only set of changes, affecting doxygen output. There were about 130 files that doxygen was ignoring!
See branch
ticket32308with 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.
Trac:
Status: assigned to needs_review
Actualpoints: N/A to .1 -
Trac:
Parent: legacy/trac#32306 (moved) to legacy/trac#29214 (moved) mentioned in issue legacy/trac#29214 (moved)
moved from legacy/trac#32307 (moved)
added Bug label and removed 1 deleted label
added Documentation label and removed 1 deleted label
