[tor-bugs] #18345 [Tor]: Fix all doxygen "X is not documented" warnings

["Tor Bug Tracker & Wiki" <blackhole@xxxxxxxxxxxxxx>]

#18345: Fix all doxygen "X is not documented" warnings
------------------------+--------------------------------
     Reporter:  teor    |      Owner:
         Type:  defect  |     Status:  new
     Priority:  Low     |  Milestone:  Tor: 0.2.9.x-final
    Component:  Tor     |    Version:
     Severity:  Normal  |   Keywords:  easy doc
Actual Points:          |  Parent ID:
       Points:          |    Sponsor:
------------------------+--------------------------------
 Quoting arma:

   It occurred to me while looking at the doxygen comment for
   router_is_already_dir_fetching_ds() that if we had something go through
   and complain about all cases where there's a function argument that is
   not mentioned by `<b>parameter</b>` (with the markup) in the doxygen
   comment... we would end up with a lot of complaints.

 We could fix this by placing `<b></b>` around documented parameters, and
 by documented undocumented parameters.

 There might even be a way to semi-automatically do this using a script,
 and then clean up any mismatches.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/18345>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs