Mercurial > hg4j
changeset 419:7f136a3fa671
Clean javadoc to fix obvious warnings
| author | Artem Tikhomirov <tikhomirov.artem@gmail.com> |
|---|---|
| date | Thu, 22 Mar 2012 21:36:41 +0100 |
| parents | 528b6780a8bd |
| children | 6c22bdc0bdfd |
| files | src/org/tmatesoft/hg/core/HgIncomingCommand.java src/org/tmatesoft/hg/core/HgLogCommand.java src/org/tmatesoft/hg/core/HgOutgoingCommand.java src/org/tmatesoft/hg/core/HgStatusCommand.java src/org/tmatesoft/hg/core/package.html src/org/tmatesoft/hg/internal/Internals.java src/org/tmatesoft/hg/internal/Patch.java src/org/tmatesoft/hg/repo/HgChangelog.java src/org/tmatesoft/hg/repo/HgIgnore.java src/org/tmatesoft/hg/repo/HgManifest.java src/org/tmatesoft/hg/repo/Revlog.java |
| diffstat | 11 files changed, 19 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/core/HgIncomingCommand.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/core/HgIncomingCommand.java Thu Mar 22 21:36:41 2012 +0100 @@ -66,7 +66,7 @@ /** * Select specific branch to push. * Multiple branch specification possible (changeset from any of these would be included in result). - * Note, {@link #executeLite(Object)} does not respect this setting. + * Note, {@link #executeLite()} does not respect this setting. * * @param branch - branch name, case-sensitive, non-null. * @return <code>this</code> for convenience
--- a/src/org/tmatesoft/hg/core/HgLogCommand.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/core/HgLogCommand.java Thu Mar 22 21:36:41 2012 +0100 @@ -184,7 +184,7 @@ } /** - * Similar to {@link #execute(org.tmatesoft.hg.repo.RawChangeset.Inspector)}, collects and return result as a list. + * Similar to {@link #execute(HgChangesetHandler)}, collects and return result as a list. */ public List<HgChangeset> execute() throws HgException { CollectHandler collector = new CollectHandler();
--- a/src/org/tmatesoft/hg/core/HgOutgoingCommand.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/core/HgOutgoingCommand.java Thu Mar 22 21:36:41 2012 +0100 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011 TMate Software Ltd + * Copyright (c) 2011-2012 TMate Software Ltd * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -61,7 +61,7 @@ /** * Select specific branch to pull. * Multiple branch specification possible (changeset from any of these would be included in result). - * Note, {@link #executeLite(Object)} does not respect this setting. + * Note, {@link #executeLite()} does not respect this setting. * * @param branch - branch name, case-sensitive, non-null. * @return <code>this</code> for convenience
--- a/src/org/tmatesoft/hg/core/HgStatusCommand.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/core/HgStatusCommand.java Thu Mar 22 21:36:41 2012 +0100 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011 TMate Software Ltd + * Copyright (c) 2011-2012 TMate Software Ltd * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -145,7 +145,7 @@ /** * Limit status operation to certain sub-tree. * - * @param pathMatcher - matcher to use, pass <code>null/<code> to reset + * @param scopeMatcher - matcher to use, pass <code>null/<code> to reset * @return <code>this</code> for convenience */ public HgStatusCommand match(Path.Matcher scopeMatcher) { @@ -160,7 +160,7 @@ /** * Perform status operation according to parameters set. * - * @param handler callback to get status information + * @param statusHandler callback to get status information * @throws IOException if there are (further unspecified) errors while walking working copy * @throws IllegalArgumentException if handler is <code>null</code> * @throws ConcurrentModificationException if this command already runs (i.e. being used from another thread)
--- a/src/org/tmatesoft/hg/core/package.html Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/core/package.html Thu Mar 22 21:36:41 2012 +0100 @@ -1,6 +1,6 @@ <html> <body> <h2>Hi-level API</h2> -<p>Hi-level API to deal with Mercurial repositories using task-oriented commands. Start with {@link HgRepoFacade} class</p> +<p>Hi-level API to deal with Mercurial repositories using task-oriented commands. Start with {@link org.tmatesoft.hg.core.HgRepoFacade} class</p> </body> </html> \ No newline at end of file
--- a/src/org/tmatesoft/hg/internal/Internals.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/internal/Internals.java Thu Mar 22 21:36:41 2012 +0100 @@ -195,7 +195,7 @@ } /** - * @param hint optional hint pointing to filesystem of interest (generally, it's possible to mount + * @param fsHint optional hint pointing to filesystem of interest (generally, it's possible to mount * filesystems with different capabilities and repository's capabilities would depend on which fs it resides) * @return <code>true</code> if executable files deserve tailored handling */ @@ -205,7 +205,7 @@ } /** - * @param hint optional hint pointing to filesystem of interest (generally, it's possible to mount + * @param fsHint optional hint pointing to filesystem of interest (generally, it's possible to mount * filesystems with different capabilities and repository's capabilities would depend on which fs it resides) * @return <code>true</code> if filesystem knows what symbolic links are */
--- a/src/org/tmatesoft/hg/internal/Patch.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/internal/Patch.java Thu Mar 22 21:36:41 2012 +0100 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011 TMate Software Ltd + * Copyright (c) 2011-2012 TMate Software Ltd * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -21,7 +21,8 @@ import java.util.Formatter; /** - * @see http://mercurial.selenic.com/wiki/BundleFormat, in Changelog group description + * @see http://mercurial.selenic.com/wiki/BundleFormat + * in Changelog group description * * range [start..end] in original source gets replaced with data of length (do not keep, use data.length instead) * range [end(i)..start(i+1)] is copied from the source
--- a/src/org/tmatesoft/hg/repo/HgChangelog.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/repo/HgChangelog.java Thu Mar 22 21:36:41 2012 +0100 @@ -116,8 +116,8 @@ /** * Unlike regular {@link Inspector}, this one supplies changeset revision along with its parents and children according * to parent information of the revlog this inspector visits. - * @see HgDataFile#history(TreeInspector) - * @deprecated use {@link HgChangesetTreeHandler} and HgLogCommand#execute(HgChangesetTreeHandler)} + * @see HgDataFile#history(HgChangelog.TreeInspector) + * @deprecated use {@link org.tmatesoft.hg.core.HgChangesetTreeHandler} and HgLogCommand#execute(org.tmatesoft.hg.core.HgChangesetTreeHandler)} */ @Deprecated public interface TreeInspector {
--- a/src/org/tmatesoft/hg/repo/HgIgnore.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/repo/HgIgnore.java Thu Mar 22 21:36:41 2012 +0100 @@ -213,7 +213,7 @@ } /** - * A handy wrap of {@link #isIgnored(Path)} into {@link Path.Matcher}. Yields same result as {@link #isIgnored(Path)}. + * A handy wrap of {@link #isIgnored(Path)} into {@link org.tmatesoft.hg.util.Path.Matcher}. Yields same result as {@link #isIgnored(Path)}. * @return <code>true</code> if file is deemed ignored. */ public boolean accept(Path path) {
--- a/src/org/tmatesoft/hg/repo/HgManifest.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/repo/HgManifest.java Thu Mar 22 21:36:41 2012 +0100 @@ -338,7 +338,7 @@ public interface Inspector { boolean begin(int mainfestRevision, Nodeid nid, int changelogRevision); /** - * @deprecated switch to {@link Inspector2#next(Nodeid, Path, Flags)} + * @deprecated switch to {@link HgManifest.Inspector2#next(Nodeid, Path, HgManifest.Flags)} */ @Deprecated boolean next(Nodeid nid, String fname, String flags);
--- a/src/org/tmatesoft/hg/repo/Revlog.java Thu Mar 22 21:02:20 2012 +0100 +++ b/src/org/tmatesoft/hg/repo/Revlog.java Thu Mar 22 21:36:41 2012 +0100 @@ -131,7 +131,7 @@ * If unsure, use {@link #isKnown(Nodeid)} to find out whether nodeid belongs to this revlog. * * For occasional queries, this method works with decent performance, despite its O(n/2) approach. - * Alternatively, if you need to perform multiple queries (e.g. at least 15-20), {@link RevisionMap} may come handy. + * Alternatively, if you need to perform multiple queries (e.g. at least 15-20), {@link Revlog.RevisionMap} may come handy. * * @param nid revision to look up * @return revision local index in this revlog @@ -162,7 +162,7 @@ * Note, {@link Nodeid#NULL} nodeid is not reported as known in any revlog. * * @param nodeid - * @return + * @return <code>true</code> if revision is part of this revlog * @throws HgInvalidControlFileException if access to revlog index/data entry failed */ public final boolean isKnown(Nodeid nodeid) throws HgInvalidControlFileException {