commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Bernd Eckenfels <e...@zusammenkunft.net>
Subject [VFS][VFS-520] Re: svn commit: r1591517 - /commons/proper/vfs/trunk/src/changes/changes.xml
Date Thu, 01 May 2014 01:01:11 GMT
Hello,

for some reason the commit with the actual javadoc changes does not
show in the commits list. I also had a "internal error" message after
the commit in Eclipse.

# org.eclipse.team.svn.core.connector.SVNConnectorException:
# svn: E160006: No such reported revision '1591517' found in the
# repository.  Perhaps the repository is out of date with respect to
the master repository?
# svn: E175002: REPORT of '/repos/asf/!svn/vcc/default': 500 Internal
# Server Error (https://svn.apache.org)

I am not sure if this is a local problem (as I had a few tries
with the password and the checked-out repo was older).

However I asume the commit was was fine, as the changes show up on
SVN and github. So this mail is just a pointer to my (larger) JavaDoc
refresh commit, in case you want to review it:

http://svn.apache.org/viewvc?view=revision&revision=1591516

https://github.com/apache/commons-vfs/commit/294f0d5783e4abb5f85b69ccc861f8d1f48414a0


I figured there are some different javadoc styles, the ones which make
java8 fail I all have fixed in a very simple style:

---
/**
 * First sentence.
 * <p>
 * More sentence.
 * <ul>
 * <li>Lists dont need p before/after</li>
 * <li>Lists need trailing {@literal </li>}</li>
 * </ul>
 * Also add an empty line and . before tags. And I replace the @todo
   tags
 * with a "TODO - ...<br>".
---

But there are other styles, like

---
/**
 * <p>
 * First sentence.
 * </p>
 * <p>
 * More text.<br>
 * </p>
 * <ul>
 * <li>
 * <p>...</p>
 * ...
---

I did not change them where javadoc does not fail, but I do think that
is not the style the javacoding guideliens recommend.

Bernd


Am Thu, 01 May 2014 00:36:23 -0000
schrieb ecki@apache.org:

> Author: ecki
> Date: Thu May  1 00:36:23 2014
> New Revision: 1591517
> 
> URL: http://svn.apache.org/r1591517
> Log:
> [VFS-520] Make javadoc compatible with javadoc tool from java 8.
> 
> Modified:
>     commons/proper/vfs/trunk/src/changes/changes.xml
> 
> Modified: commons/proper/vfs/trunk/src/changes/changes.xml
> URL:
> http://svn.apache.org/viewvc/commons/proper/vfs/trunk/src/changes/changes.xml?rev=1591517&r1=1591516&r2=1591517&view=diff
> ==============================================================================
> --- commons/proper/vfs/trunk/src/changes/changes.xml (original) +++
> commons/proper/vfs/trunk/src/changes/changes.xml Thu May  1 00:36:23
> 2014 @@ -26,6 +26,9 @@ <!--       <action issue="VFS-443"
> dev="ggregory" type="update" due-to="nickallen"> --> <!--
> [Local] Need an easy way to convert from a FileObject to a File. -->
> <!--       </action> -->
> +      <action issue="VFS-520" dev="ecki" type="update">
> +       Make JavaDoc compatible with Java 8 tool.
> +      </action>
>        <action issue="VFS-518" dev="ggregory" type="update"
> due-to="Roland Illig"> Documentation of FileSystemOptions should be
> more helpful. </action>
> 
> 


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


Mime
View raw message