[tor-bugs] #18955 [Metrics/CollecTor]: javadoc coverage

[Tor Bug Tracker & Wiki]

#18955: javadoc coverage
-------------------------------+------------------------
 Reporter:  iwakeh             |          Owner:  iwakeh
     Type:  task               |         Status:  new
 Priority:  Medium             |      Milestone:
Component:  Metrics/CollecTor  |        Version:
 Severity:  Normal             |     Resolution:
 Keywords:  ctip               |  Actual Points:
Parent ID:                     |         Points:
 Reviewer:                     |        Sponsor:
-------------------------------+------------------------

Comment (by karsten):

 Thanks for starting this discussion.  Two suggestions:
  1. We make the easy changes now.  That includes turning comments into
 Javadoc, rephrasing Javadoc that doesn't start with a summary sentence
 (happy to conform to that rule if it's in the guide), and maybe others
 that require less than a minute per comment.
  1. We defer the non-easy changes and general decisions until we have
 finished the metrics-lib Javadoc ticket (#16873) and made bigger
 refactoring measures like removing dead code.  This could take a few
 weeks, and it doesn't make much sense to clutter the checkstyle output
 with warnings we cannot fix right now.  We should mention in the
 checkstyle document that this is a temporary measure.

 How does that sound?

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