You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@creadur.apache.org by "Philipp Ottlinger (Jira)" <ji...@apache.org> on 2023/12/12 20:47:00 UTC

[jira] [Resolved] (RAT-326) Fix javadoc errors

     [ https://issues.apache.org/jira/browse/RAT-326?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Philipp Ottlinger resolved RAT-326.
-----------------------------------
    Resolution: Fixed

Existing errors fixed. Introduced individual build step javadoc:javadoc on GHA in order to not introduce build errors.

 

Problem with JDK17 remains; warnings should be fixed step by step.

> Fix javadoc errors
> ------------------
>
>                 Key: RAT-326
>                 URL: https://issues.apache.org/jira/browse/RAT-326
>             Project: Apache Rat
>          Issue Type: Bug
>          Components: site
>    Affects Versions: 0.16
>            Reporter: Claude Warren
>            Assignee: Philipp Ottlinger
>            Priority: Major
>             Fix For: 0.16
>
>
> Build scripts report javadoc errors and warnings.  For example:
> h1. Javadoc errors
>  * broken markup
>  
> h1.  Warnings
> Warning: Javadoc Warnings
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java:84: warning - @return tag has no arguments. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java:339: warning - Tag @see: can't find setAddingLicenses(boolean) in org.apache.rat.ReportConfiguration 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java:371: warning - Tag @see: can't find setAddingLicensesForced(boolean) in org.apache.rat.ReportConfiguration 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java:217: warning - @param argument "license" is not a parameter name. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java:252: warning - @param argument "license" is not a parameter name. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java:431: warning - @param argument "a" is not a parameter name. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/configuration/Format.java:107: warning - @param argument "name" is not a parameter name. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/configuration/Format.java:116: warning - @param argument "name" is not a parameter name. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/configuration/builders/SpdxBuilder.java:38: warning - @return tag has no arguments. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java:104: warning - @return tag has no arguments. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java:116: warning - @return tag has no arguments. 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java:42: warning - Tag @see:illegal character: "58" in "[https://spdx.dev/ids/]" 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java:42: warning - Tag @see:illegal character: "47" in "[https://spdx.dev/ids/]" 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java:42: warning - Tag @see:illegal character: "47" in "[https://spdx.dev/ids/]" 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java:42: warning - Tag @see:illegal character: "47" in "[https://spdx.dev/ids/]" 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java:42: warning - Tag @see:illegal character: "47" in "[https://spdx.dev/ids/]" 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-core/src/main/java/org/apache/rat/analysis/matchers/SPDXMatcherFactory.java:42: warning - Tag @see: reference not found: [https://spdx.dev/ids/] 
>  
> Warning: /home/runner/work/creadur-rat/creadur-rat/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java:117: warning - Tag @link: can't find addStyleSheet(File) in org.apache.rat.anttasks.Report



--
This message was sent by Atlassian Jira
(v8.20.10#820010)