You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@any23.apache.org by "Lewis John McGibbney (Jira)" <ji...@apache.org> on 2019/09/23 14:41:00 UTC
[jira] [Assigned] (ANY23-426) Address Javadoc WARNING's
[ https://issues.apache.org/jira/browse/ANY23-426?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Lewis John McGibbney reassigned ANY23-426:
------------------------------------------
Assignee: Lewis John McGibbney
> Address Javadoc WARNING's
> --------------------------
>
> Key: ANY23-426
> URL: https://issues.apache.org/jira/browse/ANY23-426
> Project: Apache Any23
> Issue Type: Improvement
> Components: build, core, documentation
> Affects Versions: 2.3
> Reporter: Lewis John McGibbney
> Assignee: Lewis John McGibbney
> Priority: Blocker
> Fix For: 2.4
>
>
> Building Any23 under JDK 1.8 results in the following WARNING's
> {code}
> 39 warnings
> [WARNING] Javadoc Warnings
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Setting.java:119: warning: no @param for <S>
> [WARNING] public final <S extends Setting<?>> Optional<S> as(S setting) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Setting.java:119: warning: no @param for setting
> [WARNING] public final <S extends Setting<?>> Optional<S> as(S setting) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Setting.java:133: warning: no @param for newValue
> [WARNING] public final Setting<V> withValue(V newValue) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Setting.java:247: warning: no @param for <V>
> [WARNING] public static <V> Setting<V> create(String identifier, Class<V> valueType, V defaultValue) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:63: warning: no @param for <S>
> [WARNING] public <S extends Setting<?>> Optional<S> find(S setting) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:63: warning: no @param for setting
> [WARNING] public <S extends Setting<?>> Optional<S> find(S setting) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:63: warning: no @return
> [WARNING] public <S extends Setting<?>> Optional<S> find(S setting) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:78: warning: no @param for <E>
> [WARNING] public <E> E get(Setting<E> defaultSetting) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:78: warning: no @param for defaultSetting
> [WARNING] public <E> E get(Setting<E> defaultSetting) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:78: warning: no @return
> [WARNING] public <E> E get(Setting<E> defaultSetting) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:112: warning: no @return
> [WARNING] public static Settings of() {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:119: warning: no @param for s
> [WARNING] public static Settings of(Setting<?> s) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:119: warning: no @return
> [WARNING] public static Settings of(Setting<?> s) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:128: warning: no @param for settings
> [WARNING] public static Settings of(Setting<?>... settings) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:128: warning: no @return
> [WARNING] public static Settings of(Setting<?>... settings) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:138: warning: no @param for c
> [WARNING] public static Settings of(Collection<? extends Setting<?>> c) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/configuration/Settings.java:138: warning: no @return
> [WARNING] public static Settings of(Collection<? extends Setting<?>> c) {
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/plugins/office-scraper/src/main/java/org/apache/any23/vocab/Excel.java:126: warning: no description for @param
> [WARNING] * @param localName
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/writer/WriterFactory.java:37: warning: no @return
> [WARNING] RDFFormat getRdfFormat();
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/writer/WriterFactory.java:45: warning: no @return
> [WARNING] String getMimeType();
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/writer/WriterFactory.java:51: warning: no @param for os
> [WARNING] FormatWriter getRdfWriter(OutputStream os);
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/api/src/main/java/org/apache/any23/writer/WriterFactory.java:51: warning: no @return
> [WARNING] FormatWriter getRdfWriter(OutputStream os);
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/rdf/RDFUtils.java:540: warning: no description for @param
> [WARNING] * @param docUri
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/rdf/RDFUtils.java:549: warning: no description for @param
> [WARNING] * @param type
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/rdf/RDFUtils.java:550: warning: no description for @param
> [WARNING] * @param docIRI
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/rdf/RDFUtils.java:597: warning: no description for @param
> [WARNING] * @param inString
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/csvutils/src/main/java/org/apache/any23/extractor/csv/CSVReaderBuilder.java:65: warning: no description for @throws
> [WARNING] * @throws java.io.IOException
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/csvutils/src/main/java/org/apache/any23/extractor/csv/CSVReaderBuilder.java:80: warning: no description for @throws
> [WARNING] * @throws IOException
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/util/StreamUtils.java:137: warning: no description for @throws
> [WARNING] * @throws TransformerFactoryConfigurationError
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/util/StreamUtils.java:138: warning: no description for @throws
> [WARNING] * @throws TransformerConfigurationException
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/util/StreamUtils.java:140: warning: no @param for doc
> [WARNING] public static InputStream documentToInputStream(Document doc)
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/util/StreamUtils.java:140: warning: no @return
> [WARNING] public static InputStream documentToInputStream(Document doc)
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/extractor/yaml/ElementsProcessor.java:128: warning: no description for @param
> [WARNING] * @param ns
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/extractor/yaml/ElementsProcessor.java:129: warning: no description for @param
> [WARNING] * @param object
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/core/src/main/java/org/apache/any23/extractor/yaml/ElementsProcessor.java:130: warning: no description for @param
> [WARNING] * @param parentNode
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/plugins/basic-crawler/src/main/java/org/apache/any23/plugin/crawler/SiteCrawler.java:207: warning: no description for @param
> [WARNING] * @param listener
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/plugins/basic-crawler/src/main/java/org/apache/any23/plugin/crawler/SiteCrawler.java:216: warning: no description for @param
> [WARNING] * @param listener
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/plugins/basic-crawler/src/main/java/org/apache/any23/plugin/crawler/SiteCrawler.java:228: warning: no description for @throws
> [WARNING] * @throws Exception
> [WARNING] ^
> [WARNING] /Users/lmcgibbn/Downloads/any23/plugins/basic-crawler/src/main/java/org/apache/any23/plugin/crawler/SiteCrawler.java:255: warning: no description for @throws
> [WARNING] * @throws Exception
> [WARNING] ^
> {code}
> In JDK11 the build fails as the WARNING's are escalated to ERROR's.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)