Change visibility and/or suppress JavaDoc for items that users do not/should not use themselves (#1075)

This commit is contained in:
Tim Quinn
2019-10-02 13:37:31 -05:00
committed by GitHub
parent 720ca1ddb9
commit fef197b77c
11 changed files with 30 additions and 14 deletions

View File

@@ -73,7 +73,12 @@
<destDir>classes</destDir>
<doclint>none</doclint>
<doctitle>Helidon ${project.version} API Documentation</doctitle>
<excludePackageNames>*.internal:*.internal.*:*.config.testing.*</excludePackageNames>
<!--
io.helidon.common.metrics support compat. between MP metrics 1.1 and 2.0. The contents
are not for use by developers using Helidon and will be removed if/when we stop supporting
the 1.1 compatibility.
-->
<excludePackageNames>*.internal:*.internal.*:*.config.testing.*:io.helidon.common.metrics</excludePackageNames>
<groups>
<group>
<title>Microprofile</title>
@@ -142,6 +147,17 @@
test, compilation roots.
-->
<sourceFileExclude>**/*_.java</sourceFileExclude>
<!--
Exclude internal bridge classes for metrics which must be public for
service loader discovery.
-->
<sourceFileExclude>**/InternalBridgeImpl.java</sourceFileExclude>
<!--
Exclude MP metrics classes that must be public for visibility but should not be
used by developers.
-->
<sourceFileExclude>**/MetricsCdiExtension.java</sourceFileExclude>
<sourceFileExclude>**/MetricsMpService.java</sourceFileExclude>
</sourceFileExcludes>
<sourceFileIncludes>
<sourceFileInclude>io/helidon/**/*.java</sourceFileInclude>

View File

@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ package io.helidon.metrics;
* Clock interface to allow replacing system clock with
* a custom one (e.g. for unit testing).
*/
public interface Clock {
interface Clock {
/**
* System clock. Please do not use directly, use {@link #system()}.
* This is only visible as we cannot do private modifier in interfaces yet.

View File

@@ -20,7 +20,7 @@ package io.helidon.metrics;
* Clock interface to allow replacing system clock with
* a custom one (e.g. for unit testing).
*/
public interface Clock {
interface Clock {
/**
* System clock. Please do not use directly, use {@link #system()}.
* This is only visible as we cannot do private modifier in interfaces yet.

View File

@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@ import org.eclipse.microprofile.metrics.Gauge;
*
* @param <T> data type reported by the underlying {@code Gauge}
*/
public class DelegatingGauge<T> implements Gauge<T> {
class DelegatingGauge<T> implements Gauge<T> {
private final Method method;
private final Object obj;

View File

@@ -40,7 +40,7 @@ import org.eclipse.microprofile.metrics.annotation.Metric;
* Class MetricProducer.
*/
@ApplicationScoped
public class MetricProducer {
class MetricProducer {
private static Metadata newMetadata(InjectionPoint ip, Metric metric, MetricType metricType) {
return metric == null ? new Metadata(getName(ip),

View File

@@ -29,7 +29,7 @@ import org.eclipse.microprofile.metrics.annotation.RegistryType;
* Producer of each type of registry.
*/
@ApplicationScoped
public final class RegistryProducer {
final class RegistryProducer {
private static final RegistryFactory REGISTRY_FACTORY =
io.helidon.metrics.RegistryFactory.getInstance();

View File

@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -36,7 +36,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
@Retention(RUNTIME)
@Documented
@Qualifier
public @interface VendorDefined {
@interface VendorDefined {
/**
* Literal.

View File

@@ -28,7 +28,7 @@ import org.eclipse.microprofile.metrics.Gauge;
*
* @param <T> data type reported by the underlying {@code Gauge}
*/
public class DelegatingGauge<T> implements Gauge<T> {
class DelegatingGauge<T> implements Gauge<T> {
private final Method method;
private final Object obj;

View File

@@ -47,7 +47,7 @@ import org.eclipse.microprofile.metrics.annotation.Metric;
* Class MetricProducer.
*/
@ApplicationScoped
public class MetricProducer {
class MetricProducer {
private static Metadata newMetadata(InjectionPoint ip, Metric metric, MetricType metricType) {
return metric == null ? new HelidonMetadata(getName(ip),

View File

@@ -28,7 +28,7 @@ import org.eclipse.microprofile.metrics.annotation.RegistryType;
* Producer of each type of registry.
*/
@ApplicationScoped
public final class RegistryProducer {
final class RegistryProducer {
private static final io.helidon.metrics.RegistryFactory REGISTRY_FACTORY =
io.helidon.metrics.RegistryFactory.getInstance();

View File

@@ -36,7 +36,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
@Retention(RUNTIME)
@Documented
@Qualifier
public @interface VendorDefined {
@interface VendorDefined {
/**
* Literal.