[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
Re: [tor-bugs] #16873 [Metrics/metrics-lib]: add javadoc to metrics-lib
#16873: add javadoc to metrics-lib
---------------------------------+-----------------------------------
Reporter: iwakeh | Owner: karsten
Type: enhancement | Status: needs_information
Priority: Low | Milestone:
Component: Metrics/metrics-lib | Version:
Severity: Normal | Resolution:
Keywords: | Actual Points:
Parent ID: #18746 | Points:
Reviewer: | Sponsor:
---------------------------------+-----------------------------------
Comment (by karsten):
I'm still working on this ticket, but it's a huge effort to write
''useful'' documentation for all interfaces and classes. Here's where I
am, where a point is roughly 30 minutes of work:
||='''File (in `src/org/torproject/descriptor/`)''' =||= '''Remaining
effort in points'''=||
||BandwidthHistory.java ||
0||
||BridgeExtraInfoDescriptor.java ||
0||
||BridgeNetworkStatus.java ||
2||
||BridgePoolAssignment.java ||
1||
||BridgeServerDescriptor.java ||
0||
||Descriptor.java ||
2||
||DescriptorCollector.java ||
1||
||DescriptorDownloader.java ||
4||
||DescriptorFile.java ||
2||
||DescriptorParseException.java ||
1||
||DescriptorParser.java ||
2||
||DescriptorReader.java ||
4||
||DescriptorRequest.java ||
2||
||DescriptorSourceFactory.java ||
2||
||DirectoryKeyCertificate.java ||
2||
||DirectorySignature.java ||
2||
||DirSourceEntry.java ||
2||
||ExitList.java ||
1||
||ExitListEntry.java ||
1||
||ExtraInfoDescriptor.java ||
0||
||ImplementationNotAccessibleException.java ||
1||
||Microdescriptor.java ||
0||
||NetworkStatusEntry.java ||
4||
||package-info.java ||
0||
||RelayDirectory.java ||
2||
||RelayExtraInfoDescriptor.java ||
0||
||RelayNetworkStatus.java ||
4||
||RelayNetworkStatusConsensus.java ||
2||
||RelayNetworkStatusVote.java ||
4||
||RelayServerDescriptor.java ||
0||
||RouterStatusEntry.java ||
1||
||ServerDescriptor.java ||
0||
||TorperfResult.java ||
4||
||'''Total''' ||
'''53'''||
If I prioritize this ticket over other tickets I can spend 4 hours = 8
points per work day on writing documentation. That means I'll be done
around May 27.
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/16873#comment:15>
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