You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ozone.apache.org by "Marton Elek (Jira)" <ji...@apache.org> on 2021/06/02 13:21:00 UTC
[jira] [Updated] (HDDS-5204) Missing type-level Javadoc comments
[ https://issues.apache.org/jira/browse/HDDS-5204?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Marton Elek updated HDDS-5204:
------------------------------
Fix Version/s: 1.2.0
Resolution: Fixed
Status: Resolved (was: Patch Available)
> Missing type-level Javadoc comments
> -----------------------------------
>
> Key: HDDS-5204
> URL: https://issues.apache.org/jira/browse/HDDS-5204
> Project: Apache Ozone
> Issue Type: Bug
> Reporter: Attila Doroszlai
> Assignee: Attila Doroszlai
> Priority: Major
> Labels: pull-request-available
> Fix For: 1.2.0
>
>
> Javadoc comments used to be required on all public types (classes, interfaces, etc.). In Checkstyle 8.20
> bq. functionality for validating missing javadocs was split into a new check MissingJavadocType.
> So missing javadoc on new types introduced since 2020/Oct/20 (when HDDS-4306 upgraded Checkstyle from 8.19 to 8.29) were not caught, and now we have ~50 violations.
> {noformat}
> hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/cache/TableCache.java
> 114: Missing a Javadoc comment.
> hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/NodeDetails.java
> 25: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMCertStore.java
> 304: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/balancer/ContainerBalancer.java
> 34: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMDBCheckpointProvider.java
> 34: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/MockSCMHADBTransactionBuffer.java
> 28: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/HASecurityUtils.java
> 70: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/LongCodec.java
> 24: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/EnumCodec.java
> 28: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/BooleanCodec.java
> 24: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/ListCodec.java
> 28: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/StringCodec.java
> 24: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/Codec.java
> 23: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/CodecFactory.java
> 32: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/io/GeneratedMessageCodec.java
> 27: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMContext.java
> 180: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/ha/SCMHANodeDetails.java
> 63: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/node/DatanodeUsageInfo.java
> 27: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManagerImpl.java
> 44: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/block/DeletedBlockLogStateManager.java
> 29: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMHAConfiguration.java
> 45: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMServiceManager.java
> 27: Missing a Javadoc comment.
> hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSequenceIDGenerator.java
> 29: Missing a Javadoc comment.
> hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferFactory.java
> 42: Missing a Javadoc comment.
> hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/utils/BufferUtils.java
> 27: Missing a Javadoc comment.
> hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/common/ChecksumByteBufferImpl.java
> 23: Missing a Javadoc comment.
> hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/ha/ConfUtils.java
> 28: Missing a Javadoc comment.
> hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/utils/ClientCommandsUtils.java
> 23: Missing a Javadoc comment.
> hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/ha/RetriableWithNoFailoverException.java
> 22: Missing a Javadoc comment.
> hadoop-hdds/common/src/test/java/org/apache/hadoop/ozone/common/TestChecksumImplsComputeSameValues.java
> 33: Missing a Javadoc comment.
> hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMNodeInfo.java
> 45: Missing a Javadoc comment.
> hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/keyvalue/statemachine/background/BlockDeletingService.java
> 112: Missing a Javadoc comment.
> hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationSupervisor.java
> 120: Missing a Javadoc comment.
> hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/replication/ReplicationServer.java
> 126: Missing a Javadoc comment.
> hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/TestBlockDeletingService.java
> 130: Missing a Javadoc comment.
> hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/replication/TestSimpleContainerDownloader.java
> 41: Missing a Javadoc comment.
> hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/freon/containergenerator/BaseGenerator.java
> 29: Missing a Javadoc comment.
> hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCBatch.java
> 54: Missing a Javadoc comment.
> hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genesis/BenchMarkCRCStreaming.java
> 71: Missing a Javadoc comment.
> hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/ExportContainer.java
> 61: Missing a Javadoc comment.
> hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/signature/SignatureInfo.java
> 110: Missing a Javadoc comment.
> hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Owner.java
> 27: Missing a Javadoc comment.
> hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3BucketAcl.java
> 68: Missing a Javadoc comment.
> 99: Missing a Javadoc comment.
> hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3Acl.java
> 38: Missing a Javadoc comment.
> hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/signature/TestAuthorizationV4QueryParser.java
> 30: Missing a Javadoc comment.
> hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/TestEmptyContentTypeFilter.java
> 27: Missing a Javadoc comment.
> hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/MiniOzoneHAClusterImpl.java
> 659: Missing a Javadoc comment.
> hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOzoneManagerHAKeyDeletion.java
> 29: Missing a Javadoc comment.
> hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/client/rpc/read/TestInputStreamBase.java
> 60: Missing a Javadoc comment.
> hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/hdds/scm/TestSCMSnapshot.java
> 40: Missing a Javadoc comment.
> hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/fs/ozone/TestOzoneFileSystemMissingParent.java
> 42: Missing a Javadoc comment.
> hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/persistence/ContainerHistory.java
> 23: Missing a Javadoc comment.
> hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/io/MultipartCryptoKeyInputStream.java
> 34: Missing a Javadoc comment.
> {noformat}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org