You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by br...@apache.org on 2013/06/21 12:09:58 UTC
svn commit: r1495365 - in
/subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl:
ISVNClient.java ISVNEditor.java remote/RemoteFactory.java
types/VersionExtended.java
Author: brane
Date: Fri Jun 21 10:09:58 2013
New Revision: 1495365
URL: http://svn.apache.org/r1495365
Log:
Fix JavaDoc comments to not use the @note tag and use paragraph separators.
[in subversion/bindings/javahl/src/org/apache/subversion/javahl]
* ISVNClient.java,
ISVNEditor.java,
remote/RemoteFactory.java,
types/VersionExtended.java: Update documentation. No functional changes.
Modified:
subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNClient.java
subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNEditor.java
subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/remote/RemoteFactory.java
subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/types/VersionExtended.java
Modified: subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNClient.java
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNClient.java?rev=1495365&r1=1495364&r2=1495365&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNClient.java (original)
+++ subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNClient.java Fri Jun 21 10:09:58 2013
@@ -221,6 +221,10 @@ public interface ISVNClient
/**
* Adds a file to the repository.
+ *
+ * <p><em>Note:</em> Behaves like the 1.8 version with
+ * <code>noAutoProps</code> set to <code>false</code>.
+ *
* @param path path to be added.
* @param depth the depth to recurse into subdirectories
* @param force if adding a directory and recurse true and path is a
@@ -229,7 +233,6 @@ public interface ISVNClient
* ignore patterns
* @param addParents add any intermediate parents to the working copy
* @throws ClientException
- * @note this method behaves like the 1.8 version with noAutoProps=false
*/
void add(String path, Depth depth, boolean force, boolean noIgnores,
boolean addParents)
@@ -412,6 +415,9 @@ public interface ISVNClient
* 'clean' directory (meaning a directory with no administrative
* directories).
*
+ * <p><em>Note:</em> Behaves like the 1.9 version with
+ * ignoreKeywords set to false.
+ *
* @param srcPath the url of the repository path to be exported
* @param destPath a destination path that must not already exist.
* @param revision the revsion to be exported
@@ -421,8 +427,6 @@ public interface ISVNClient
* @param depth how deep to recurse in subdirectories
* @param nativeEOL which EOL characters to use during export
* @throws ClientException
- * @note this method behaves like the 1.9 version with
- * ignoreKeywords set to false.
*/
long doExport(String srcPath, String destPath, Revision revision,
Revision pegRevision, boolean force, boolean ignoreExternals,
@@ -481,6 +485,10 @@ public interface ISVNClient
/**
* Import a file or directory into a repository directory at
* head.
+ *
+ * <p><em>Note:</em> Behaves like the 1.8 version with noAutoProps
+ * set to false and without the filtering option.
+ *
* @param path the local path
* @param url the target url
* @param depth depth to traverse into subdirectories
@@ -493,8 +501,6 @@ public interface ISVNClient
* @param handler the commit message callback
* @param callback the commit status callback
* @throws ClientException
- * @note this method behaves like the 1.8 version with noAutoProps=false
- * and without the filtering option.
*/
void doImport(String path, String url, Depth depth,
boolean noIgnore, boolean ignoreUnknownNodeTypes,
@@ -538,6 +544,9 @@ public interface ISVNClient
/**
* Merge changes from two paths into a new local path.
*
+ * <p><em>Note:</em> Behaves like the 1.8 version where ignoreAncestry
+ * maps to both ignoreMergeinfo and diffIgnoreAncestry
+ *
* @param path1 first path or url
* @param revision1 first revision
* @param path2 second path or url
@@ -549,8 +558,6 @@ public interface ISVNClient
* @param dryRun do not change anything
* @param recordOnly record mergeinfo but do not run merge
* @throws ClientException
- * @note Behaves like the 1.8 where ignoreAncestry maps to
- * both ignoreMergeinfo and diffIgnoreAncestry
*/
void merge(String path1, Revision revision1, String path2,
Revision revision2, String localPath, boolean force, Depth depth,
@@ -581,6 +588,10 @@ public interface ISVNClient
/**
* Merge set of revisions into a new local path.
+ *
+ * <p><em>Note:</em> Behaves like the 1.8 version where ignoreAncestry
+ * maps to both ignoreMergeinfo and diffIgnoreAncestry
+ *
* @param path path or url
* @param pegRevision revision to interpret path
* @param revisions revisions to merge;
@@ -593,8 +604,6 @@ public interface ISVNClient
* @param dryRun do not change anything
* @param recordOnly record mergeinfo but do not run merge
* @throws ClientException
- * @note Behaves like the 1.8 where ignoreAncestry maps to
- * both ignoreMergeinfo and diffIgnoreAncestry
*/
void merge(String path, Revision pegRevision, List<RevisionRange> revisions,
String localPath, boolean force, Depth depth,
@@ -659,6 +668,10 @@ public interface ISVNClient
/**
* Retrieve either merged or eligible-to-be-merged revisions.
+ *
+ * <p><em>Note:</em> Behaves like the 1.8 version, with unspecified
+ * revision range.
+ *
* @param kind kind of revisions to receive
* @param pathOrUrl target of merge
* @param pegRevision peg rev for pathOrUrl
@@ -668,7 +681,6 @@ public interface ISVNClient
* @param depth the depth to recurse to
* @param revProps the revprops to retrieve
* @param callback the object to receive the log messages
- * @note Behaves like the 1.8 version, with unspecified revision range.
*/
void getMergeinfoLog(Mergeinfo.LogKind kind, String pathOrUrl,
Revision pegRevision, String mergeSourceUrl,
@@ -1172,13 +1184,15 @@ public interface ISVNClient
/**
* Open a persistent session to a repository.
+ *
+ * <p><em>Note:</em> The session object inherits the progress callback,
+ * configuration directory and authentication info.
+ *
* @param pathOrUrl A path in a working copy from which the
* session URL is derived, or the URL itself.
* @throws remote.RetryOpenSession If the session URL was redirected
* @throws SubversionException If an URL redirect cycle was detected
* @throws ClientException
- * @note The session object inherits the progress callback,
- * configuration directory and authentication info.
* @since 1.9
*/
ISVNRemote openRemoteSession(String pathOrUrl)
@@ -1186,6 +1200,10 @@ public interface ISVNClient
/**
* Open a persistent session to a repository.
+ *
+ * <p><em>Note:</em> The session object inherits the progress callback,
+ * configuration directory and authentication info.
+ *
* @param pathOrUrl A path in a working copy from which the
* session URL is derived, or the URL itself.
* @param retryAttempts The number of times to retry the operation
@@ -1195,8 +1213,6 @@ public interface ISVNClient
* @throws remote.RetryOpenSession If the session URL was redirected
* @throws SubversionException If an URL redirect cycle was detected
* @throws ClientException
- * @note The session object inherits the progress callback,
- * configuration directory and authentication info.
* @since 1.9
*/
ISVNRemote openRemoteSession(String pathOrUrl, int retryAttempts)
Modified: subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNEditor.java
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNEditor.java?rev=1495365&r1=1495364&r2=1495365&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNEditor.java (original)
+++ subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/ISVNEditor.java Fri Jun 21 10:09:58 2013
@@ -47,10 +47,10 @@ public interface ISVNEditor
/**
* Create a new directory at <code>relativePath</code>.
* The immediate parent of <code>relativePath</code> is expected to exist.
- *
+ * <p>
* For descriptions of <code>properties</code> and
* <code>replacesRevision</code>, see #addFile().
- *
+ * <p>
* A complete listing of the immediate children of
* <code>relativePath</code> that will be added subsequently is
* given in <code>children</code>. <code>children</code> is a
@@ -70,16 +70,16 @@ public interface ISVNEditor
/**
* Create a new file at <code>relativePath</code>.
* The immediate parent of <code>relativePath</code> is expected to exist.
- *
+ * <p>
* The file's contents are specified in <code>contents</code>
* which has a checksum matching <code>checksum</code>. Both
* values must be non-<code>null</code>.
- *
+ * <p>
* Set the properties of the new file to
* <code>properties</code>. If no properties are being set on the
* new file, <code>properties</code> must be empty. It is an error
* to pass <code>null</code> for <code>properties</code>.
- *
+ * <p>
* If this add is expected to replace a previously existing file,
* symlink or directory at <code>relativePath</code>, the revision
* number of the node to be replaced must be given in
@@ -87,9 +87,9 @@ public interface ISVNEditor
* <code>replacesRevision</code> must be
* Revision.SVN_INVALID_REVNUM.
*
- * @note It is not allowed to call a "delete" followed by an "add" on the
- * same path. Instead, an "add" with <code>replacesRevision</code>
- * set accordingly MUST be used.
+ * <p><em>Note:</em> It is not allowed to call a "delete" followed by
+ * an "add" on the same path. Instead, an "add" with
+ * <code>replacesRevision</code> set accordingly <em>must</em> be used.
*
* @throws ClientException
*/
@@ -132,7 +132,7 @@ public interface ISVNEditor
/**
* Alter the properties of the directory at <code>relativePath</code>.
- *
+ * <p>
* <code>revision</code> specifies the revision at which the
* receiver should expect to find this node. That is,
* <code>relativePath</code> at the start of the whole edit and
@@ -143,13 +143,13 @@ public interface ISVNEditor
* corresponding revision in the repository (e.g. it has not yet
* been committed), then <code>revision</code> should be
* Revision.SVN_INVALID_REVNUM.
- *
+ * <p>
* If any changes to the set of children will be made in the
* future of the edit drive, then <code>children</code>
* <em>must</em> specify the resulting set of children. See
* #addDirectory() for the format of <code>children</code>. If
* not changes will be made, then NULL may be specified.
- *
+ * <p>
* For a description of <code>properties</code>, see
* #addFile(). If no changes to the properties will be made
* (ie. only future changes to the set of children), then
@@ -168,7 +168,7 @@ public interface ISVNEditor
* <code>relativePath</code> with <code>revision</code> as its
* expected revision. See #alterDirectory() for more information
* about <code>revision</code>.
- *
+ * <p>
* If <code>contents</code> is non-<code>null</code>, then the
* stream will be copied to the file, and its checksum must match
* <code>checksum</code> (which must also be
@@ -176,13 +176,13 @@ public interface ISVNEditor
* <code>null</code>, then <code>checksum</code> must also be
* <code>null</code>, and no change will be applied to the file's
* contents.
- *
+ * <p>
* If <code>properties</code> is non-<code>null</code>, then the
* properties will be applied.
- *
+ * <p>
* For a description of <code>checksum</code> and
* <code>contents</code>, see #addFile().
- *
+ * <p>
* This function allows <code>properties</code> to be
* <code>null</code>, but the parameter is otherwise described by
* #addFile().
@@ -201,17 +201,17 @@ public interface ISVNEditor
* <code>relativePath</code> with <code>revision</code> as its
* expected revision. See #alterDirectory() for more information
* about <code>revision</code>.
- *
+ * <p>
* If <code>target</code> is non-<code>null</code>, then the
* symlink's target will be updated.
- *
+ * <p>
* If <code>properties</code> is non-<code>null</code>, then the
* properties will be applied.
- *
+ * <p>
* The target and/or the properties must be changed. It is an
* error to pass <code>null</code> for both <code>target</code>
* and <code>properties</code>.
- *
+ * <p>
* This function allows <code>properties</code> to be
* <code>null</code>, but the parameter is otherwise described by
* #addFile().
@@ -237,11 +237,11 @@ public interface ISVNEditor
/**
* Move the node at <code>sourceRelativePath</code> to
* <code>destinationRelativePath</code>.
- *
+ * <p>
* For a description of <code>replacesRevision</code>, see #addFile().
- *
- * @note See the general instructions on paths for this API. Since
- * the <code>sourceRelativePath</code> argument must generally be
+ * <p>
+ * <p><em>Note:</em> See the general instructions on paths for this API.
+ * Sice the <code>sourceRelativePath</code> argument must generally be
* able to reference any node in the repository, the implication
* is that the editor's root must be the repository root.
*
@@ -256,7 +256,7 @@ public interface ISVNEditor
/**
* Move the node at <code>sourceRelativePath</code> to
* <code>destinationRelativePath</code>.
- *
+ * <p>
* <code>sourceRevision</code> specifies the revision at which the
* receiver should expect to find this node. That is,
* <code>sourceRelativePath</code> at the start of the whole edit
@@ -264,7 +264,7 @@ public interface ISVNEditor
* <code>sourceRevision</code> must lie within the same node-rev
* (aka history-segment). This is just like the #delete() and
* #rotate().
- *
+ * <p>
* For a description of <code>replacesRevision</code>, see #addFile().
*
* @throws ClientException
@@ -276,7 +276,7 @@ public interface ISVNEditor
throws ClientException;
/**
* Perform a rotation among multiple nodes in the target tree.
- *
+ * <p>
* The <code>elements</code> list specifies the nodes in the tree
* which are located at a path and expected to be at a specific
* revision. These nodes are simultaneously moved in a rotation
@@ -285,7 +285,7 @@ public interface ISVNEditor
* specified at index 1 of <code>elements</code>. The node at
* index 1 will be moved to the location at index 2. The node at
* index N-1 will be moved to the relative path specified at index 0.
- *
+ * <p>
* The simplest form of this operation is to swap nodes A and
* B. One may think to move A to a temporary location T, then move
* B to A, then move T to B. However, this last move violations
Modified: subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/remote/RemoteFactory.java
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/remote/RemoteFactory.java?rev=1495365&r1=1495364&r2=1495365&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/remote/RemoteFactory.java (original)
+++ subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/remote/RemoteFactory.java Fri Jun 21 10:09:58 2013
@@ -119,13 +119,16 @@ public class RemoteFactory
/**
* Open a persistent session to a repository.
+ * <p>
+ * <em>Note:</em> The URL can point to a subtree of the repository.
+ * <p>
+ * <em>Note:</em> The session object inherits the progress callback,
+ * configuration directory and authentication info.
+ *
* @param url The initial session root URL.
* @throws RetryOpenSession If the session URL was redirected
* @throws SubversionException If an URL redirect cycle was detected
* @throws ClientException
- * @note The URL can point to a subtree of the repository.
- * @note The session object inherits the progress callback,
- * configuration directory and authentication info.
*/
public ISVNRemote openRemoteSession(String url)
throws ClientException, SubversionException
@@ -136,6 +139,12 @@ public class RemoteFactory
/**
* Open a persistent session to a repository.
+ * <p>
+ * <em>Note:</em> The URL can point to a subtree of the repository.
+ * <p>
+ * <em>Note:</em> The session object inherits the progress callback,
+ * configuration directory and authentication info.
+ *
* @param url The initial session root URL.
* @param retryAttempts The number of times to retry the operation
* if the given URL is redirected.
@@ -144,9 +153,6 @@ public class RemoteFactory
* @throws RetryOpenSession If the session URL was redirected
* @throws SubversionException If an URL redirect cycle was detected
* @throws ClientException
- * @note The URL can point to a subtree of the repository.
- * @note The session object inherits the progress callback,
- * configuration directory and authentication info.
*/
public ISVNRemote openRemoteSession(String url, int retryAttempts)
throws ClientException, SubversionException
@@ -160,16 +166,21 @@ public class RemoteFactory
/**
* Open a persistent session to a repository.
+ * <p>
+ * <em>Note:</em> The URL can point to a subtree of the repository.
+ * <p>
+ * <em>Note:</em> If the UUID does not match the repository,
+ * this function fails.
+ * <p>
+ * <em>Note:</em> The session object inherits the progress callback,
+ * configuration directory and authentication info.
+ *
* @param url The initial session root URL.
* @param reposUUID The expected repository UUID; may not be null..
* @throws IllegalArgumentException If <code>reposUUID</code> is null.
* @throws RetryOpenSession If the session URL was redirected
* @throws SubversionException If an URL redirect cycle was detected
* @throws ClientException
- * @note The URL can point to a subtree of the repository.
- * @note If the UUID does not match the repository, this function fails.
- * @note The session object inherits the progress callback,
- * configuration directory and authentication info.
*/
public ISVNRemote openRemoteSession(String url, String reposUUID)
throws ClientException, SubversionException
@@ -182,6 +193,15 @@ public class RemoteFactory
/**
* Open a persistent session to a repository.
+ * <p>
+ * <em>Note:</em> The URL can point to a subtree of the repository.
+ * <p>
+ * <em>Note:</em> If the UUID does not match the repository,
+ * this function fails.
+ * <p>
+ * <em>Note:</em> The session object inherits the progress callback,
+ * configuration directory and authentication info.
+ *
* @param url The initial session root URL.
* @param reposUUID The expected repository UUID; may not be null..
* @param retryAttempts The number of times to retry the operation
@@ -191,10 +211,6 @@ public class RemoteFactory
* @throws RetryOpenSession If the session URL was redirected
* @throws SubversionException If an URL redirect cycle was detected
* @throws ClientException
- * @note The URL can point to a subtree of the repository.
- * @note If the UUID does not match the repository, this function fails.
- * @note The session object inherits the progress callback,
- * configuration directory and authentication info.
*/
public ISVNRemote openRemoteSession(String url, String reposUUID,
int retryAttempts)
Modified: subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/types/VersionExtended.java
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/types/VersionExtended.java?rev=1495365&r1=1495364&r2=1495365&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/types/VersionExtended.java (original)
+++ subversion/trunk/subversion/bindings/javahl/src/org/apache/subversion/javahl/types/VersionExtended.java Fri Jun 21 10:09:58 2013
@@ -46,8 +46,8 @@ public class VersionExtended
* @return The canonical host triplet (arch-vendor-osname) of the
* system where libsvn_subr was compiled.
*
- * @note On Unix-like systems (includng Mac OS X), this string is
- * the same as the output of the config.guess script for the
+ * <p><em>Note:</em> On Unix-like systems (includng Mac OS X), this string
+ * is the same as the output of the config.guess script for the
* underlying Subversion libraries.
*/
public native String getBuildHost();
@@ -61,7 +61,7 @@ public class VersionExtended
* @return The canonical host triplet (arch-vendor-osname) of the
* system where the current process is running.
*
- * @note This string may not be the same as the output of
+ * <p><em>Note:</em> This string may not be the same as the output of
* config.guess on the same system.
*/
public native String getRuntimeHost();
@@ -140,7 +140,7 @@ public class VersionExtended
* @return Iterator for an immutable internal list of #LoadedLib
* describing loaded shared libraries. The the list may be empty.
*
- * @note On Mac OS X, the loaded frameworks, private frameworks
+ * <p><em>Note:</em> On Mac OS X, the loaded frameworks, private frameworks
* and system libraries will not be listed.
*/
public java.util.Iterator<LoadedLib> getLoadedLibs()
@@ -178,7 +178,8 @@ public class VersionExtended
/**
* Implementation of java.util.Iterator#remove().
- * @note Not implemented, all sequences are immutable.
+ *
+ * <p><em>Note:</em> Not implemented, all sequences are immutable.
*/
public void remove()
{
@@ -219,7 +220,8 @@ public class VersionExtended
/**
* Implementation of java.util.Iterator#remove().
- * @note Not implemented, all sequences are immutable.
+ *
+ * <p><em>Note:</em> Not implemented, all sequences are immutable.
*/
public void remove()
{