Fix all javadoc issues.

This commit is contained in:
wu-sheng 2018-02-26 15:47:19 +08:00
parent 1d6ca31b62
commit 400ad41a64
20 changed files with 44 additions and 44 deletions

View File

@ -10,5 +10,5 @@ before_install:
install:
- jdk_switcher use oraclejdk8
- mvn clean install --quiet jacoco:report coveralls:report
- mvn javadoc:javadoc
- mvn javadoc:javadoc --quiet

View File

@ -27,7 +27,7 @@ import org.apache.logging.log4j.core.pattern.LogEventPatternConverter;
/**
* {@link TraceIdConverter} is a log4j2 plugin, by annotation as {@link Plugin}.
* It convert the pattern key: traceId.
* Use '%traceId' in log4j2's config: <PatternLayout pattern="%d [%traceId] %-5p %c{1}:%L - %m%n"/>,
* Use '%traceId' in log4j2's config.
* '%traceId' will output as TID:xxxx
* <p>
* Created by wusheng on 2016/12/7.

View File

@ -29,8 +29,8 @@ import static net.bytebuddy.matcher.ElementMatchers.named;
import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
/**
* {@link AbstractNIOConnPoolInstrumentation} presents that skywalking intercept {@link
* org.apache.http.nio.protocol.AbstractNIOConnPool #requestCompleted}.
* {@link AbstractNIOConnPoolInstrumentation} presents that skywalking intercept
* org.apache.http.nio.protocol.AbstractNIOConnPool#requestCompleted
*
* @author liyuntao
*/

View File

@ -29,8 +29,8 @@ import static net.bytebuddy.matcher.ElementMatchers.named;
import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
/**
* {@link DefaultConnectingIOReactorInstrumentation} presents that skywalking intercepts {@link
* org.apache.http.impl.nio.reactor.DefaultConnectingIOReactor#processEvent}
* {@link DefaultConnectingIOReactorInstrumentation} presents that skywalking intercepts
* org.apache.http.impl.nio.reactor.DefaultConnectingIOReactor#processEvent
*
* @author liyuntao
*/

View File

@ -31,7 +31,7 @@ import static org.apache.skywalking.apm.agent.core.plugin.bytebuddy.ArgumentType
import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
/**
* {@link ExecuteInstrumentation} presents that skywalking intercepts {@link org.apache.http.impl.nio.client.CloseableHttpAsyncClient#execute}
* {@link ExecuteInstrumentation} presents that skywalking intercepts org.apache.http.impl.nio.client.CloseableHttpAsyncClient#execute
*
* @author liyuntao
*/

View File

@ -28,12 +28,11 @@ import static net.bytebuddy.matcher.ElementMatchers.named;
import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
/**
* {@link ProcessResponseInstrumentation} presents that skywalking intercept {@link
* org.apache.http.nio.protocol.HttpAsyncRequestExecutor#processResponse,#connected} .
* {@link ProcessResponseInstrumentation} presents that skywalking intercept
* org.apache.http.nio.protocol.HttpAsyncRequestExecutor#processResponse and #connected
*
* @author liyuntao
*/
public class ProcessResponseInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
private static final String ENHANCE_CLASS = "org.apache.http.nio.protocol.HttpAsyncRequestExecutor";

View File

@ -18,6 +18,7 @@
package org.apache.skywalking.apm.plugin.httpasyncclient.v4.define;
import java.io.IOException;
import net.bytebuddy.description.method.MethodDescription;
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;
@ -29,8 +30,8 @@ import static net.bytebuddy.matcher.ElementMatchers.named;
import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
/**
* {@link SessionRequestImplInstrumentation} presents that skywalking intercepts {@link
* org.apache.http.impl.nio.reactor.SessionRequestImpl#failed(final IOException exception)}
* {@link SessionRequestImplInstrumentation} presents that skywalking intercepts
* {@link org.apache.http.impl.nio.reactor.SessionRequestImpl#failed(IOException)} }
*
* @author liyuntao
*/

View File

@ -29,8 +29,7 @@ import static net.bytebuddy.matcher.ElementMatchers.named;
import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
/**
* {@link StateInstrumentation} presents that skywalking intercept {@link org.apache.http.nio.protocol.HttpAsyncRequestExecutor$State#setRequest
* #setResponse} .
* {@link StateInstrumentation} presents that skywalking intercept org.apache.http.nio.protocol.HttpAsyncRequestExecutor$State#setRequest
*
* @author liyuntao
*/

View File

@ -37,7 +37,7 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInt
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
/**
* @autor zhang xin
* @author zhang xin
*/
public class KafkaConsumerInterceptor implements InstanceMethodsAroundInterceptor {

View File

@ -38,9 +38,6 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInt
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
/**
* {@link MongoDBCollectionMethodInterceptor} intercepts constructor of {@link com.mongodb.DBCollection} or
* {@link com.mongodb.DBCollectionImpl} recording the ServerAddress and creating the exit span.
*
* @author liyuntao
*/
@ -54,8 +51,8 @@ public class MongoDBCollectionMethodInterceptor implements InstanceMethodsAround
Class<?>[] argumentsTypes, MethodInterceptResult result) throws Throwable {
String remotePeer = (String)objInst.getSkyWalkingDynamicField();
String opertaion = method.getName();
AbstractSpan span = ContextManager.createExitSpan(MONGO_DB_OP_PREFIX + opertaion, new ContextCarrier(), remotePeer);
String operation = method.getName();
AbstractSpan span = ContextManager.createExitSpan(MONGO_DB_OP_PREFIX + operation, new ContextCarrier(), remotePeer);
span.setComponent(ComponentsDefine.MONGODB);
Tags.DB_TYPE.set(span, DB_TYPE);
SpanLayer.asDB(span);

View File

@ -32,9 +32,6 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInt
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
/**
* {org.apache.skywalking.apm.plugin.servicecomb.ProducerOperationHandlerInterceptor} define how to enhance class {@link
* ProducerOperationHandler#handle(io.servicecomb.core.Invocation, io.servicecomb.swagger.invocation.AsyncResponse)}.
*
* @author lytscu
*/
public class ProducerOperationHandlerInterceptor implements InstanceMethodsAroundInterceptor {

View File

@ -33,9 +33,6 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInt
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
/**
* {@link TransportClientHandlerInterceptor} define how to enhance class {@link TransportClientHandler#handle(io.servicecomb.core.Invocation,
* io.servicecomb.swagger.invocation.AsyncResponse)}.
*
* @author lytscu
*/
public class TransportClientHandlerInterceptor implements InstanceMethodsAroundInterceptor {

View File

@ -29,9 +29,9 @@ import org.apache.skywalking.apm.agent.core.plugin.match.NameMatch;
import static net.bytebuddy.matcher.ElementMatchers.named;
/**
* {@link ProducerOperationHandlerInstrumentation} represents that skywalking intercept {@link
* ProducerOperationHandler#handle(io.servicecomb.core.Invocation, io.servicecomb.swagger.invocation.AsyncResponse)}by
* using {@link ProducerOperationHandlerInterceptor}
* {@link ProducerOperationHandlerInstrumentation} represents that skywalking intercept
* {@link io.servicecomb.core.handler.impl.ProducerOperationHandler#handle(io.servicecomb.core.Invocation, io.servicecomb.swagger.invocation.AsyncResponse)}by
* using ProducerOperationHandlerInterceptor
*
* @author lytscu
*/

View File

@ -30,8 +30,8 @@ import org.apache.skywalking.apm.agent.core.plugin.match.NameMatch;
import static net.bytebuddy.matcher.ElementMatchers.named;
/**
* {@link TransportClientHandlerInstrumentation} represents that skywalking intercept {@link TransportClientHandler}by
* using {@linkTransportClientHandlerInterceptor }
* {@link TransportClientHandlerInstrumentation} represents that skywalking intercept {@link TransportClientHandler} by
* using linkTransportClientHandlerInterceptor
*
* @author lytscu
*/

View File

@ -32,9 +32,6 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInt
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
/**
* {ProducerOperationHandlerInterceptor} define how to enhance class {@link
* ProducerOperationHandler#handle(org.apache.servicecomb.core.Invocation, org.apache.servicecomb.swagger.invocation.AsyncResponse)}.
*
* @author lytscu
*/
public class ProducerOperationHandlerInterceptor implements InstanceMethodsAroundInterceptor {

View File

@ -33,9 +33,6 @@ import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInt
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
/**
* {@link TransportClientHandlerInterceptor} define how to enhance class {@link TransportClientHandler#handle(org.apache.servicecomb.core.Invocation,
* org.apache.servicecomb.swagger.invocation.AsyncResponse)}.
*
* @author lytscu
*/
public class TransportClientHandlerInterceptor implements InstanceMethodsAroundInterceptor {

View File

@ -29,9 +29,9 @@ import org.apache.skywalking.apm.agent.core.plugin.match.NameMatch;
import static net.bytebuddy.matcher.ElementMatchers.named;
/**
* {@link ProducerOperationHandlerInstrumentation} represents that skywalking intercept {@link
* ProducerOperationHandler#handle(org.apache.servicecomb.core.Invocation, org.apache.servicecomb.swagger.invocation.AsyncResponse)}by
* using {@link ProducerOperationHandlerInterceptor}
* {@link ProducerOperationHandlerInstrumentation} represents that skywalking intercept
* {@link org.apache.servicecomb.core.handler.impl.ProducerOperationHandler#handle(org.apache.servicecomb.core.Invocation, org.apache.servicecomb.swagger.invocation.AsyncResponse)}
* by using ProducerOperationHandlerInterceptor
*
* @author lytscu
*/

View File

@ -20,7 +20,6 @@ package org.apache.skywalking.apm.plugin.servicecomb.v1.define;
import net.bytebuddy.description.method.MethodDescription;
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.servicecomb.core.handler.impl.TransportClientHandler;
import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint;
import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;
@ -30,8 +29,9 @@ import org.apache.skywalking.apm.agent.core.plugin.match.NameMatch;
import static net.bytebuddy.matcher.ElementMatchers.named;
/**
* {@link TransportClientHandlerInstrumentation} represents that skywalking intercept {@link TransportClientHandler}by
* using {@linkTransportClientHandlerInterceptor }
* {@link TransportClientHandlerInstrumentation} represents that skywalking intercept
* {@link org.apache.servicecomb.core.handler.impl.TransportClientHandler} by
* using linkTransportClientHandlerInterceptor
*
* @author lytscu
*/

View File

@ -49,7 +49,7 @@ import static org.apache.skywalking.apm.agent.core.plugin.bytebuddy.ArgumentType
*
* 4. The <code>SpanLogInterceptor</code>
* interceptor enhance the <code>log</code> method that the first argument type is {@link Long} and the second
* argument type is {@link Map<String,?>}
* argument type is {@link Map}
*
* 5. The <code>SpanSetOperationNameInterceptor</code>
* interceptor enhance the <code>setOperationName</code> method

16
docs/en/How-to-release.md Normal file
View File

@ -0,0 +1,16 @@
Apache SkyWalking release guide
--------------------
Ref:
* http://tiles.apache.org/framework/dev/release.html
* http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env
Important things list:
* Maven releases, and the nexus staging repository, and download artifacts upload
* All artifacts are published with .asc, .md5, *sha1 files
* The *.asc files are signed with a gpg key that's part of apache's ring of trust
* Sync'ing this to releases and tags in github
* Making the internal announcements
* Calling a vote
* Moving the staging repository to a public repository, making download artifacts public
* Making the final public announcement