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

[Tor Bug Tracker & Wiki]

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

 * status:  accepted => needs_review


Comment:

 Actually, I think it's better to use suppression annotations.

 {{{
 #!java

   @SuppressWarnings("checkstyle:javadocmethod")
   public static void main(Configuration config) throws
 ConfigurationException {
 }}}

 First added to CollecTor
 [https://gitweb.torproject.org/user/iwakeh/collector.git/commit/?h=task-19615
 -guide-compliance&id=26c3449b1835b6807ed09ebcda6809f6e9b30f4f here] as
 part of guide compliance #19615.

 This way it is visible in the code where exemptions were made.

 Is this ok?

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