You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by "Masatake Iwasaki (JIRA)" <ji...@apache.org> on 2019/02/08 01:02:00 UTC

[jira] [Commented] (HADOOP-16098) Fix javadoc warnings in hadoop-aws

    [ https://issues.apache.org/jira/browse/HADOOP-16098?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16763198#comment-16763198 ] 

Masatake Iwasaki commented on HADOOP-16098:
-------------------------------------------

{code}
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:jar (module-javadocs) on project hadoop-aws: MavenReportException: Error while generating Javadoc: 
[ERROR] Exit code: 1 - /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/InconsistentAmazonS3Client.java:151: warning: no @param for policy
[ERROR]   public static void setFailureInjectionPolicy(S3AFileSystem fs,
[ERROR]                      ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/InconsistentAmazonS3Client.java:151: warning: no @throws for java.lang.Exception
[ERROR]   public static void setFailureInjectionPolicy(S3AFileSystem fs,
[ERROR]                      ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/InternalConstants.java:31: error: bad HTML entity
[ERROR]  * Please don't refer to these outside of this module & its tests.
[ERROR]                                                       ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AOpContext.java:78: warning: no description for @param
[ERROR]    * @param dstFileStatus
[ERROR]      ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AReadOpContext.java:115: error: bad use of '>'
[ERROR]    * @return a value >= 0
[ERROR]                      ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AUtils.java:1230: warning: no @throws for java.io.IOException
[ERROR]   public static ClientConfiguration createAwsConf(Configuration conf,
[ERROR]                                     ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/AbstractSessionCredentialsProvider.java:71: warning: no @throws for java.io.IOException
[ERROR]   protected void init() throws IOException {
[ERROR]                  ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/TemporaryAWSCredentialsProvider.java:62: warning: no @throws for java.io.IOException
[ERROR]   public TemporaryAWSCredentialsProvider(final Configuration conf)
[ERROR]          ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/TemporaryAWSCredentialsProvider.java:73: warning: no @throws for java.io.IOException
[ERROR]   public TemporaryAWSCredentialsProvider(
[ERROR]          ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/DirListingMetadata.java:71: warning: no @param for lastUpdated
[ERROR]   public DirListingMetadata(Path path, Collection<PathMetadata> listing,
[ERROR]          ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3Guard.java:195: warning: no @param for timeProvider
[ERROR]   public static FileStatus[] dirListingUnion(MetadataStore ms, Path path,
[ERROR]                              ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3Guard.java:285: warning: no @param for timeProvider
[ERROR]   public static void makeDirsOrdered(MetadataStore ms, List<Path> dirs,
[ERROR]                      ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3GuardTool.java:149: warning: no @return
[ERROR]   public abstract String getName();
[ERROR]                          ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3GuardTool.java:254: warning: no @param for paths
[ERROR]   protected void checkBucketNameOrDDBTableNameProvided(List<String> paths) {
[ERROR]                  ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3GuardTool.java:274: warning: no @throws for java.io.IOException
[ERROR]   protected MetadataStore initMetadataStore(boolean forceCreate)
[ERROR]                           ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/MarshalledCredentialBinding.java:70: warning: no @return
[ERROR]   public static MarshalledCredentials fromSTSCredentials(
[ERROR]                                       ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/MarshalledCredentialBinding.java:124: warning: no @param for uri
[ERROR]   public static MarshalledCredentials fromFileSystem(
[ERROR]                                       ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/MarshalledCredentialBinding.java:187: warning: no @param for awsConf
[ERROR]   public static MarshalledCredentials requestSessionCredentials(
[ERROR]                                       ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/RoleModel.java:203: warning: no @param for wildcards
[ERROR]   public static Statement statement(
[ERROR]                           ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/RoleModel.java:226: warning: no @param for wildcards
[ERROR]   public static Statement statement(
[ERROR]                           ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/AbstractDelegationTokenBinding.java:180: warning: no @param for <T>
[ERROR]   protected <T extends AbstractS3ATokenIdentifier> T convertTokenIdentifier(
[ERROR]                                                      ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/AbstractDelegationTokenBinding.java:180: warning: no @return
[ERROR]   protected <T extends AbstractS3ATokenIdentifier> T convertTokenIdentifier(
[ERROR]                                                      ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/AbstractS3ATokenIdentifier.java:157: warning: no @param for kind
[ERROR]   protected AbstractS3ATokenIdentifier(final Text kind) {
[ERROR]             ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/AbstractS3ATokenIdentifier.java:146: warning: no @param for kind
[ERROR]   protected AbstractS3ATokenIdentifier(
[ERROR]             ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/SessionTokenBinding.java:336: warning: no @throws for java.io.IOException
[ERROR]   protected Optional<STSClientFactory.STSClient> prepareSTSClient()
[ERROR]                                                  ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/SessionTokenBinding.java:401: warning: no @return
[ERROR]   protected Optional<OffsetDateTime> getExpirationDateTime() {
[ERROR]                                      ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/SessionTokenBinding.java:413: warning: no @return
[ERROR]   protected Optional<SessionTokenIdentifier> getTokenIdentifier() {
[ERROR]                                              ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/S3ADelegationTokens.java:150: warning: no @throws for java.io.IOException
[ERROR]   public S3ADelegationTokens() throws IOException {
[ERROR]          ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/SessionTokenIdentifier.java:99: warning: no @param for renewer
[ERROR]   public SessionTokenIdentifier(final Text kind,
[ERROR]          ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/delegation/SessionTokenIdentifier.java:99: warning: no @param for realUser
[ERROR]   public SessionTokenIdentifier(final Text kind,
[ERROR]          ^
[ERROR] /home/iwasakims/srcs/hadoop/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/select/InternalSelectConstants.java:33: error: bad HTML entity
[ERROR]  * Please don't refer to these outside of this module & its tests.
{code}

> Fix javadoc warnings in hadoop-aws
> ----------------------------------
>
>                 Key: HADOOP-16098
>                 URL: https://issues.apache.org/jira/browse/HADOOP-16098
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: fs/s3
>    Affects Versions: 3.3.0
>            Reporter: Masatake Iwasaki
>            Assignee: Masatake Iwasaki
>            Priority: Minor
>         Attachments: HADOOP-16098.001.patch
>
>
> mvn package -Pdist fails due to javadoc warnings in hadoop-aws.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org