[ 
https://issues.apache.org/jira/browse/HADOOP-18229?focusedWorklogId=771364&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-771364
 ]

ASF GitHub Bot logged work on HADOOP-18229:
-------------------------------------------

                Author: ASF GitHub Bot
            Created on: 17/May/22 13:56
            Start Date: 17/May/22 13:56
    Worklog Time Spent: 10m 
      Work Description: slfan1989 commented on PR #4292:
URL: https://github.com/apache/hadoop/pull/4292#issuecomment-1128904918

   Hi,@steveloughran @virajjasani @goiri , I have fixed hadoop-common javadoc 
compilation problem in jdk11, please help to review the code.
   
   my changes are as follows:
   
   1.modify the java doc configuration of the pom file, skip the proto file
   ```
   <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
            <sourceFileExcludes>
                 <sourceFileExclude>**/FSProtos.java</sourceFileExclude>
                 </sourceFileExcludes>
                 
<excludePackageNames>*.proto:*.tracing:*.protobuf</excludePackageNames>
        </configuration>
    </plugin>
   ```
   
   2.fix the warn and error problems, as follows:
   ```
   warning: no @param for in
   warning: no @return
   warning: no @throws for java.io.IOException
   warning: no description for @throws
   error: exception not thrown: java.io.IOException
   error: unknown tag: username
   error: bad use of '>'
   etc...
   ```
   
   hope these fixes will help hadoop project to be more complete, thanks!
   
   




Issue Time Tracking
-------------------

    Worklog Id:     (was: 771364)
    Time Spent: 12.5h  (was: 12h 20m)

> Fix Hadoop Common Java Doc Error
> --------------------------------
>
>                 Key: HADOOP-18229
>                 URL: https://issues.apache.org/jira/browse/HADOOP-18229
>             Project: Hadoop Common
>          Issue Type: Sub-task
>            Reporter: fanshilun
>            Assignee: fanshilun
>            Priority: Major
>              Labels: pull-request-available
>          Time Spent: 12.5h
>  Remaining Estimate: 0h
>
> I found that when hadoop-multibranch compiled PR-4266, some errors would pop 
> up, I tried to solve it
> The wrong compilation information is as follows, I try to fix the Error 
> information
> {code:java}
> [ERROR] 
> /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-4266/ubuntu-focal/src/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/viewfs/InodeTree.java:432:
>  error: exception not thrown: java.io.IOException
> [ERROR]    * @throws IOException
> [ERROR]              ^
> [ERROR] 
> /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-4266/ubuntu-focal/src/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/viewfs/InodeTree.java:885:
>  error: unknown tag: username
> [ERROR]    *  E.g. link: ^/user/(?<username>\\w+) => 
> s3://$user.apache.com/_${user}
> [ERROR]                           ^
> [ERROR] 
> /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-4266/ubuntu-focal/src/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/viewfs/InodeTree.java:885:
>  error: bad use of '>'
> [ERROR]    *  E.g. link: ^/user/(?<username>\\w+) => 
> s3://$user.apache.com/_${user}
> [ERROR]                                            ^
> [ERROR] 
> /home/jenkins/jenkins-agent/workspace/hadoop-multibranch_PR-4266/ubuntu-focal/src/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/viewfs/InodeTree.java:910:
>  error: unknown tag: username
> [ERROR]    *     
> .linkRegex.replaceresolveddstpath:_:-#.^/user/(?<username>\w+)
> {code}



--
This message was sent by Atlassian Jira
(v8.20.7#820007)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to