[
https://issues.apache.org/jira/browse/HTRACE-366?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15262880#comment-15262880
]
Colin Patrick McCabe commented on HTRACE-366:
---------------------------------------------
Yeah, it would be great to have more docs! And the 4.2 release will have
javadocs that build cleanly under jdk8, too, which is nice.
> Add JavaDoc to missing classes.
> -------------------------------
>
> Key: HTRACE-366
> URL: https://issues.apache.org/jira/browse/HTRACE-366
> Project: HTrace
> Issue Type: Bug
> Components: core, docs
> Affects Versions: 4.1
> Reporter: Mike Drob
>
> Now that we have JavaDoc published on our site, we can easily see that some
> of public classes/methods are missing docs. We should write some.
> For class level docs, I don't see them on MilliSpan.MilliSpanDeserializer,
> Span.SpanSerializer, TimelineAnnotation, TraceExecutorService, Tracer.Builder
> For method level docs, there are many many more. Adding JavaDoc build
> enforcement could be done in a follow-on issue.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
