diff options
author | savaki <matt.ho@gmail.com> | 2018-07-19 19:36:03 -0700 |
---|---|---|
committer | savaki <matt.ho@gmail.com> | 2018-07-21 07:44:40 -0700 |
commit | c03fa25aabc23ac60aea53d49b0994bc7414d8c7 (patch) | |
tree | 6fe5fad598594216b8e34eb0fa249471996e16bb /contrib | |
parent | 9dad959be5155ac83391642d5e39bc9b1eaa8083 (diff) | |
download | opencensus-java-c03fa25aabc23ac60aea53d49b0994bc7414d8c7.tar.gz |
added `@since` to exported classes and methods
Diffstat (limited to 'contrib')
3 files changed, 20 insertions, 1 deletions
diff --git a/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/CensusSpringAspect.java b/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/CensusSpringAspect.java index c97ea83c..b1059e86 100644 --- a/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/CensusSpringAspect.java +++ b/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/CensusSpringAspect.java @@ -25,12 +25,20 @@ import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.beans.factory.annotation.Configurable; -/** CensusSpringAspect handles logic for the `@Traced` annotation. */ +/** + * CensusSpringAspect handles logic for the `@Traced` annotation. + * + * @since 0.16.0 + */ @Aspect @Configurable public final class CensusSpringAspect { private final Tracer tracer; + /** + * @param tracer the tracer responsible for building new spans + * @since 0.16.0 + */ public CensusSpringAspect(Tracer tracer) { this.tracer = tracer; } @@ -42,6 +50,7 @@ public final class CensusSpringAspect { * @param call the join point to execute * @return the result of the invocation * @throws Throwable if the underlying target throws an exception + * @since 0.16.0 */ @Around("@annotation(io.opencensus.contrib.spring.aop.Traced)") public Object trace(ProceedingJoinPoint call) throws Throwable { diff --git a/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/CensusSpringSqlAspect.java b/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/CensusSpringSqlAspect.java index f31a420b..958d55f6 100644 --- a/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/CensusSpringSqlAspect.java +++ b/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/CensusSpringSqlAspect.java @@ -27,12 +27,18 @@ import org.springframework.beans.factory.annotation.Configurable; /** * CensusSpringSqlAspect captures span from all SQL invocations that utilize * java.sql.Statement.execute* + * + * @since 0.16.0 */ @Aspect @Configurable public final class CensusSpringSqlAspect { private final Tracer tracer; + /** + * @param tracer the tracer responsible for building new spans + * @since 0.16.0 + */ public CensusSpringSqlAspect(Tracer tracer) { this.tracer = tracer; } @@ -40,6 +46,8 @@ public final class CensusSpringSqlAspect { /** * trace handles invocations of java.sql.Statement.execute*. A new span will be created whose name * is (execute|executeQuery|executeQuery)-(hash of sql). + * + * @since 0.16.0 */ @Around("execute() || testing()") public Object trace(ProceedingJoinPoint call) throws Throwable { diff --git a/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/Traced.java b/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/Traced.java index 41dc58dd..af350fd9 100644 --- a/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/Traced.java +++ b/contrib/spring/src/main/java/io/opencensus/contrib/spring/aop/Traced.java @@ -26,6 +26,8 @@ import java.lang.annotation.Target; * * <p>By default, the name of the method will be used for the span name. However, the span name can * be explicitly set via the name interface. + * + * @since 0.16.0 */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) |