From 1279e7ad3d46432efa349886995c8b9885c30852 Mon Sep 17 00:00:00 2001 From: Mike Drob Date: Fri, 26 Aug 2016 08:56:53 -0500 Subject: [PATCH] HTRACE-369. doclint fixes for htrace-zipkin We should still ignore the doclint errors that we see on generated code because that is likely to get clobbered in the future. Becuase there is no option to exclude by package, we must exclude by error group. We can fix the other groups though. --- htrace-zipkin/pom.xml | 2 +- .../main/java/org/apache/htrace/impl/ScribeTransport.java | 4 ++-- .../java/org/apache/htrace/impl/ZipkinSpanReceiver.java | 6 +++--- .../org/apache/htrace/zipkin/HTraceToZipkinConverter.java | 13 ++++++------- 4 files changed, 12 insertions(+), 13 deletions(-) diff --git a/htrace-zipkin/pom.xml b/htrace-zipkin/pom.xml index b7ce61e..925988e 100644 --- a/htrace-zipkin/pom.xml +++ b/htrace-zipkin/pom.xml @@ -219,7 +219,7 @@ language governing permissions and limitations under the License. --> doclint-disable [1.8,) - -Xdoclint:none + -Xdoclint:all,-Xdoclint:-missing diff --git a/htrace-zipkin/src/main/java/org/apache/htrace/impl/ScribeTransport.java b/htrace-zipkin/src/main/java/org/apache/htrace/impl/ScribeTransport.java index 0fc7920..17886c5 100644 --- a/htrace-zipkin/src/main/java/org/apache/htrace/impl/ScribeTransport.java +++ b/htrace-zipkin/src/main/java/org/apache/htrace/impl/ScribeTransport.java @@ -103,11 +103,11 @@ public class ScribeTransport implements Transport { * Here is a little ascii art which shows the above transformation: *
    *  +------------+   +------------+   +------------+              +-----------------+
-   *  | HTrace Span|-->|Zipkin Span |-->| (LogEntry) | ===========> | Zipkin Collector|
+   *  | HTrace Span|-->|Zipkin Span |-->| (LogEntry) | ===========> | Zipkin Collector|
    *  +------------+   +------------+   +------------+ (Scribe RPC) +-----------------+
    *  
* @param spans to be sent. The raw bytes are being sent. - * @throws IOException + * @throws IOException if there is a problem sending the span entries */ @Override public void send(List spans) throws IOException { diff --git a/htrace-zipkin/src/main/java/org/apache/htrace/impl/ZipkinSpanReceiver.java b/htrace-zipkin/src/main/java/org/apache/htrace/impl/ZipkinSpanReceiver.java index 2dfe5a6..da7027f 100644 --- a/htrace-zipkin/src/main/java/org/apache/htrace/impl/ZipkinSpanReceiver.java +++ b/htrace-zipkin/src/main/java/org/apache/htrace/impl/ZipkinSpanReceiver.java @@ -51,7 +51,7 @@ import java.util.concurrent.atomic.AtomicLong; /** * Zipkin is an open source tracing library. This span receiver acts as a bridge between HTrace and * Zipkin, that converts HTrace Span objects into Zipkin Span objects. - *

+ *

* HTrace spans are queued into a blocking queue. From there background worker threads will * batch the spans together and then send them through to a Zipkin collector. * @@ -338,10 +338,10 @@ public class ZipkinSpanReceiver extends SpanReceiver { /** * Close the receiver. - *

+ *

* This tries to shut * - * @throws IOException + * @throws IOException This implementation will not throw an {@link IOException}. */ @Override public void close() throws IOException { diff --git a/htrace-zipkin/src/main/java/org/apache/htrace/zipkin/HTraceToZipkinConverter.java b/htrace-zipkin/src/main/java/org/apache/htrace/zipkin/HTraceToZipkinConverter.java index dc4e9bc..44baea0 100644 --- a/htrace-zipkin/src/main/java/org/apache/htrace/zipkin/HTraceToZipkinConverter.java +++ b/htrace-zipkin/src/main/java/org/apache/htrace/zipkin/HTraceToZipkinConverter.java @@ -36,15 +36,15 @@ import java.util.Map; * This class is responsible for converting a HTrace.Span to a Zipkin.Span object. To use the Zipkin * infrastructure (collector, front end), we need to store the Span information in a zipkin specific * format. This class transforms a HTrace:Span object to a Zipkin:Span object. - *

+ *

* This is how both Span objects are related: - * - * + *
+ * * - * - * + * + * * - * + * * * * @@ -71,7 +71,6 @@ import java.util.Map; * * *
HTrace:SpanZipkin:SpanHTrace:SpanZipkin:Span
TraceIdTraceId
- *

*/ public class HTraceToZipkinConverter { private static final Log LOG = LogFactory.getLog(HTraceToZipkinConverter.class); -- 1.9.1