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

Tor Bug Tracker & Wiki blackhole at torproject.org
Fri Aug 21 08:34:21 UTC 2015


#16873: add javadoc to metrics-lib
-------------------------+-------------------------
 Reporter:  iwakeh       |          Owner:  karsten
     Type:  enhancement  |         Status:  new
 Priority:  minor        |      Milestone:
Component:  metrics-lib  |        Version:
 Keywords:               |  Actual Points:
Parent ID:               |         Points:
-------------------------+-------------------------
 Steps for providing javadoc for metrics-lib:

 * Change method comments to javadoc style, i.e. from {{{/* ... */}}} to
 {{{/** ... */}}}

 * Add a javadoc ant-task that renders the documentation into a seperate
 folder {{{docs}}}.

 * Make sure the contents of the comments is still up-to-date.

 These steps should be provided in three patches.
 Test classes should __not__ be included yet.

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


More information about the tor-bugs mailing list