[tor-bugs] #16873 [Metrics/metrics-lib]: add javadoc to metrics-lib

Tor Bug Tracker & Wiki blackhole at torproject.org
Fri May 20 18:10:51 UTC 2016


#16873: add javadoc to metrics-lib
---------------------------------+------------------------------
 Reporter:  iwakeh               |          Owner:  karsten
     Type:  enhancement          |         Status:  needs_review
 Priority:  Low                  |      Milestone:
Component:  Metrics/metrics-lib  |        Version:
 Severity:  Normal               |     Resolution:
 Keywords:                       |  Actual Points:
Parent ID:  #18746               |         Points:
 Reviewer:                       |        Sponsor:
---------------------------------+------------------------------

Comment (by iwakeh):

 fast again :-)
 DescripTor API and the real copyright logo look good!

 A few things I noticed immediately:

 * the references to constants in !DescriptorSourceFactory are lacking the
 `#`, e.g., `{@link #COLLECTOR_DEFAULT}`.
 * package-info is now fine except `org.torproject.descriptor.impl` should
 not be referenced as link, b/c it's excluded from javadoc, but this only
 avoids a warning when running javadoc
 * same with {{{ExitList.java:83: warning - Tag @link: missing '#':
 "getEntries()"}}}

 still need to read the text ;-)

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


More information about the tor-bugs mailing list