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

[Tor Bug Tracker & Wiki]

#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):

 Good documentation! Quite a lot to read!

 I put myself in the mindset of someone who reads the javadoc for the first
 time and wants to use descriptor quickly for accessing the available data.

 Here some suggestions derived from that way of reading:
 * the overview page is missing (I added a diff, not a format patch just a
 suggestion, most of the text moved from the package description)
 * listing of the property names in the factory class and an example (also
 in the attached diff)
 * It might be very useful to add source code examples for using the
 descriptor api to the downloader, collector, parser, and reader classes.
 Maybe, just copied from Onionoo sources.
 * Somewhere there ought to be a link to the Tor spec. Maybe, in the
 overview or/and the classes?
 * the link in BridgeExtraInfoDescriptor should be turned into a clickable
 one.

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