commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Bernd Eckenfels <e...@zusammenkunft.net>
Subject Re: svn commit: r1674710 - /commons/proper/io/trunk/src/main/java/org/apache/commons/io/output/CloseShieldOutputStream.java
Date Mon, 20 Apr 2015 12:38:58 GMT
Hello Gary,

I get the same errors, but none of them are related to missing close
</p> tags. 

I dont think that it is correct that javadoc8 cares about
xhtml, it checks for html. Thats why it disallows self closed tags.

But I guess it doesnt matter much we have so many javadoc styles anyway.

Gruss
Bernd

 Am
Sun, 19 Apr 2015 20:53:20 -0700 schrieb Gary Gregory
<garydgregory@gmail.com>:

> Javadoc 8 does not allow for XHTML tags to not be closed (in the
> default mode).
> 
> When I run 'mvn clean site', I get, more of these errors and others:
> 
> 9 errors
> 6 warnings
> [INFO]
> ------------------------------------------------------------------------
> [INFO] BUILD FAILURE
> [INFO]
> ------------------------------------------------------------------------
> [INFO] Total time: 07:16 min
> [INFO] Finished at: 2015-04-19T20:33:23-07:00
> [INFO] Final Memory: 57M/386M
> [INFO]
> ------------------------------------------------------------------------
> [ERROR] Failed to execute goal
> org.apache.maven.plugins:maven-site-plugin:3.3:site (default-site) on
> project commons-io: Error during page generation: Error rendering
> Maven report:
> [ERROR] Exit code: 1 -
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\CopyUtils.java:309:
> warning: no @param for encoding
> [ERROR] public static void copy(
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\CopyUtils.java:358:
> warning: no @param for encoding
> [ERROR] public static void copy(
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\FileCleaner.java:140:
> error: reference not found
> [ERROR] * {@link
> javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)}.
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\FileCleaner.java:33:
> error: reference not found
> [ERROR] * {@link
> javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)}
> or similar.
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\FileCleaningTracker.java:186:
> error: reference not found
> [ERROR] * {@link
> javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)}.
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\FileCleaningTracker.java:40:
> error: reference not found
> [ERROR] * {@link
> javax.servlet.ServletContextListener#contextDestroyed} or similar.
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\IOUtils.java:3069:
> warning: no @return
> [ERROR] public static byte[] readFully(final InputStream input, final
> int length) throws IOException {
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\input\BoundedReader.java:66:
> warning: no description for @throws
> [ERROR] * @throws IOException
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\input\BoundedReader.java:76:
> warning: no description for @throws
> [ERROR] * @throws IOException
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\input\BoundedReader.java:130:
> warning: no description for @throws
> [ERROR] * @throws IOException
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\input\BoundedReader.java:28:
> error: self-closing element not allowed
> [ERROR] * <p/>
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\input\UnixLineEndingInputStream.java:60:
> error: incorrect use of inline tag
> [ERROR] * @inheritDoc
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\input\UnixLineEndingInputStream.java:102:
> error: incorrect use of inline tag
> [ERROR] * @inheritDoc
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\input\WindowsLineEndingInputStream.java:62:
> error: incorrect use of inline tag
> [ERROR] * @inheritDoc
> [ERROR] ^
> [ERROR]
> C:\vcs\svn\apache\commons\trunks-proper\io\src\main\java\org\apache\commons\io\input\WindowsLineEndingInputStream.java:115:
> error: incorrect use of inline tag
> [ERROR] * @inheritDoc
> [ERROR] ^
> [ERROR]
> [ERROR] Command line was: "C:\Program
> Files\Java\jdk1.8.0_45\jre\..\bin\javadoc.exe" @options @packages
> [ERROR]
> [ERROR] Refer to the generated Javadoc files in
> 'C:\vcs\svn\apache\commons\trunks-proper\io\target\site\apidocs' dir.
> [ERROR] -> [Help 1]
> [ERROR]
> [ERROR] To see the full stack trace of the errors, re-run Maven with
> the -e switch.
> [ERROR] Re-run Maven using the -X switch to enable full debug logging.
> [ERROR]
> [ERROR] For more information about the errors and possible solutions,
> please read the following articles:
> [ERROR] [Help 1]
> http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
> 
> Using:
> 
> Apache Maven 3.3.1 (cab6659f9874fa96462afef40fcf6bc033d58c1c;
> 2015-03-13T13:10:27-07:00)
> Maven home: C:\Java\apache-maven-3.3.1
> Java version: 1.8.0_45, vendor: Oracle Corporation
> Java home: C:\Program Files\Java\jdk1.8.0_45\jre
> Default locale: en_US, platform encoding: Cp1252
> OS name: "windows 7", version: "6.1", arch: "amd64", family: "dos"
> 
> Gary
> 
> On Sun, Apr 19, 2015 at 7:10 PM, Bernd Eckenfels
> <ecki@zusammenkunft.net> wrote:
> 
> > Hello,
> >
> > commons-io has multiple Java 8 doclint warnings and errors
> > (mostly missing references and self closing <p/> and @inheritDoc) in
> > the current revision, but "CloseShieldOutputStream without the
> > closing </p> tag is not in that list. What command did
> > you run and what error it is reporting? I tried javadoc:javadoc.
> >
> > Gruss
> > Bernd
> >
> > Am Sun, 19 Apr 2015 18:35:13 -0700
> > schrieb Gary Gregory <garydgregory@gmail.com>:
> >
> > > On Sun, Apr 19, 2015 at 6:05 PM, Bernd Eckenfels
> > > <ecki@zusammenkunft.net> wrote:
> > >
> > > > Hello,
> > > >
> > > > Am Mon, 20 Apr 2015 00:25:55 -0000
> > > > schrieb ggregory@apache.org:
> > > > >
> > > >
> > commons/proper/io/trunk/src/main/java/org/apache/commons/io/output/CloseShieldOutputStream.java
> > > > > (original) +++
> > > > >
> > > >
> > commons/proper/io/trunk/src/main/java/org/apache/commons/io/output/CloseShieldOutputStream.java
> > > > > Mon Apr 20 00:25:55 2015 @@ -24,7 +24,7 @@ import
> > > > > java.io.OutputStream;
> > > > >   * This class is typically used in cases where an output
> > > > > stream needs to be
> > > > >   * passed to a component that wants to explicitly close the
> > > > > stream even if
> > > > >   * other components would still use the stream for output.
> > > > > - *
> > > > > + * </p>
> > > > >   * @version $Id$
> > > > >   * @since 1.4
> > > > >   */
> > > >
> > > > Uhm... is that really an improvement? If you use html tags
> > > > (like it is specified by javadoc) you dont need ending tags.
> > > >
> > >
> > > Try building with Java 8 and see what happens... ;-)
> > >
> > > Gary
> > >
> > > >
> > > > Gruss
> > > > Bernd
> > > >
> > > > ---------------------------------------------------------------------
> > > > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > > > For additional commands, e-mail: dev-help@commons.apache.org
> > > >
> > > >
> > >
> > >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > For additional commands, e-mail: dev-help@commons.apache.org
> >
> >
> 
> 


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message