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

["Tor Bug Tracker & Wiki" <blackhole@xxxxxxxxxxxxxx>]

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

 Replying to [comment:24 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)

 Looks good, applied with minor edits and pushed to my task-16873 branch.

 > * listing of the property names in the factory class and an example
 (also in the attached diff)

 Also applied.

 > * 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.

 Good idea, I included source code examples for collector and reader, as I
 expect those to be used by 90% of users.  Parser is mostly an internal
 thing that happens to be publicly available, and downloader is not really
 used by anything and should be removed sooner than later.

 > * Somewhere there ought to be a link to the Tor spec. Maybe, in the
 overview or/and the classes?

 Sure, added to the overview.

 > * the link in BridgeExtraInfoDescriptor should be turned into a
 clickable one.

 Changed, as well as similar links in the other three Bridge* interfaces.

 Great feedback, let me know if you have more, and I'll incorporate that.
 Thanks!

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/16873#comment:25>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs