[tor-bugs] #16873 [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_information
 Priority:  Low          |      Milestone:
Component:  metrics-lib  |        Version:
 Severity:  Normal       |     Resolution:
 Keywords:               |  Actual Points:
Parent ID:  #18746       |         Points:
 Reviewer:               |        Sponsor:
-------------------------+-----------------------------------

Comment (by karsten):

 Okay, I agree that it makes sense to add package-level documentation for
 the implementation package for such general remarks.  But do you know how
 to include that `package-info.java` in the generated Javadocs while
 excluding all other classes from that package?  If there's no easy way,
 maybe we can make these general remarks in `DescriptorSourceFactory` where
 we might want to document how to use alternative implementations by
 setting system properties.

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