From 5e2e111280898e47959996a1a1e016e9fcb21179 Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Mon, 18 Dec 2017 11:51:33 +0100 Subject: [PATCH] Fix javadoc in org.eclipse.jgit gitrepo package Change-Id: I2604c7bca87f005004d6d6c80fa9a39a7a1e3807 Signed-off-by: Matthias Sohn --- .../eclipse/jgit/gitrepo/ManifestParser.java | 16 ++++++++++++++- .../org/eclipse/jgit/gitrepo/RepoCommand.java | 20 ++++++++++++++++--- .../org/eclipse/jgit/gitrepo/RepoProject.java | 17 ++++++++++++++-- .../jgit/gitrepo/internal/RepoText.java | 2 ++ 4 files changed, 49 insertions(+), 6 deletions(-) diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/ManifestParser.java b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/ManifestParser.java index ddc6addbc3..4ec45db4f1 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/ManifestParser.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/ManifestParser.java @@ -113,12 +113,22 @@ public class ManifestParser extends DefaultHandler { } /** + * Constructor for ManifestParser + * * @param includedReader + * a + * {@link org.eclipse.jgit.gitrepo.ManifestParser.IncludedFileReader} + * object. * @param filename + * a {@link java.lang.String} object. * @param defaultBranch + * a {@link java.lang.String} object. * @param baseUrl + * a {@link java.lang.String} object. * @param groups + * a {@link java.lang.String} object. * @param rootRepo + * a {@link org.eclipse.jgit.lib.Repository} object. */ public ManifestParser(IncludedFileReader includedReader, String filename, String defaultBranch, String baseUrl, String groups, @@ -153,7 +163,8 @@ public class ManifestParser extends DefaultHandler { * Read the xml file. * * @param inputStream - * @throws IOException + * a {@link java.io.InputStream} object. + * @throws java.io.IOException */ public void read(InputStream inputStream) throws IOException { xmlInRead++; @@ -174,6 +185,7 @@ public class ManifestParser extends DefaultHandler { } } + /** {@inheritDoc} */ @Override public void startElement( String uri, @@ -246,6 +258,7 @@ public class ManifestParser extends DefaultHandler { } } + /** {@inheritDoc} */ @Override public void endElement( String uri, @@ -257,6 +270,7 @@ public class ManifestParser extends DefaultHandler { } } + /** {@inheritDoc} */ @Override public void endDocument() throws SAXException { xmlInRead--; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java index 422f26be9a..c7bc1b6aa3 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java @@ -232,7 +232,10 @@ public class RepoCommand extends GitCommand { } /** + * Constructor for RepoCommand + * * @param repo + * the {@link org.eclipse.jgit.lib.Repository} */ public RepoCommand(Repository repo) { super(repo); @@ -258,7 +261,7 @@ public class RepoCommand extends GitCommand { * Setting inputStream will ignore the path set. It will be closed in * {@link #call}. * - * @param inputStream + * @param inputStream a {@link java.io.InputStream} object. * @return this command * @since 3.5 */ @@ -271,10 +274,11 @@ public class RepoCommand extends GitCommand { * Set base URI of the paths inside the XML. This is typically the name of * the directory holding the manifest repository, eg. for * https://android.googlesource.com/platform/manifest, this should be - * /platform (if you would run this on android.googlesource.com) - * or https://android.googlesource.com/platform elsewhere. + * /platform (if you would run this on android.googlesource.com) or + * https://android.googlesource.com/platform elsewhere. * * @param uri + * the base URI * @return this command */ public RepoCommand setURI(String uri) { @@ -319,6 +323,7 @@ public class RepoCommand extends GitCommand { * revision specified in project, this branch will be used. * * @param branch + * a branch name * @return this command */ public RepoCommand setBranch(String branch) { @@ -336,6 +341,7 @@ public class RepoCommand extends GitCommand { * ignored. * * @param branch + * branch name * @return this command * @since 4.1 */ @@ -404,6 +410,7 @@ public class RepoCommand extends GitCommand { * * @see org.eclipse.jgit.lib.NullProgressMonitor * @param monitor + * a {@link org.eclipse.jgit.lib.ProgressMonitor} * @return this command */ public RepoCommand setProgressMonitor(final ProgressMonitor monitor) { @@ -438,6 +445,7 @@ public class RepoCommand extends GitCommand { * ignored. * * @param author + * the author's {@link org.eclipse.jgit.lib.PersonIdent} * @return this command */ public RepoCommand setAuthor(final PersonIdent author) { @@ -451,6 +459,8 @@ public class RepoCommand extends GitCommand { * This is only used in bare repositories. * * @param callback + * a {@link org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader} + * object. * @return this command */ public RepoCommand setRemoteReader(final RemoteReader callback) { @@ -462,6 +472,9 @@ public class RepoCommand extends GitCommand { * Set the IncludedFileReader callback. * * @param reader + * a + * {@link org.eclipse.jgit.gitrepo.ManifestParser.IncludedFileReader} + * object. * @return this command * @since 4.0 */ @@ -470,6 +483,7 @@ public class RepoCommand extends GitCommand { return this; } + /** {@inheritDoc} */ @Override public RevCommit call() throws GitAPIException { try { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoProject.java b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoProject.java index 00cd38d69e..e827612d23 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoProject.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoProject.java @@ -169,6 +169,8 @@ public class RepoProject implements Comparable { } /** + * Constructor for RepoProject + * * @param name * the relative path to the {@code remote} * @param path @@ -203,6 +205,8 @@ public class RepoProject implements Comparable { } /** + * Constructor for RepoProject + * * @param name * the relative path to the {@code remote} * @param path @@ -225,6 +229,7 @@ public class RepoProject implements Comparable { * Set the url of the sub repo. * * @param url + * project url * @return this for chaining. */ public RepoProject setUrl(String url) { @@ -250,6 +255,7 @@ public class RepoProject implements Comparable { * Set the default revision for the sub repo. * * @param defaultRevision + * the name of the default revision * @return this for chaining. */ public RepoProject setDefaultRevision(String defaultRevision) { @@ -325,6 +331,7 @@ public class RepoProject implements Comparable { * Test whether this sub repo belongs to a specified group. * * @param group + * a group * @return true if {@code group} is present. */ public boolean inGroup(String group) { @@ -365,7 +372,7 @@ public class RepoProject implements Comparable { /** * Add a copy file configuration. * - * @param copyfile + * @param copyfile a {@link org.eclipse.jgit.gitrepo.RepoProject.CopyFile} object. */ public void addCopyFile(CopyFile copyfile) { copyfiles.add(copyfile); @@ -375,6 +382,8 @@ public class RepoProject implements Comparable { * Add a bunch of copyfile configurations. * * @param copyFiles + * a collection of + * {@link org.eclipse.jgit.gitrepo.RepoProject.CopyFile} objects */ public void addCopyFiles(Collection copyFiles) { this.copyfiles.addAll(copyFiles); @@ -392,7 +401,7 @@ public class RepoProject implements Comparable { /** * Add a link file configuration. * - * @param linkfile + * @param linkfile a {@link org.eclipse.jgit.gitrepo.RepoProject.LinkFile} object. * @since 4.8 */ public void addLinkFile(LinkFile linkfile) { @@ -403,6 +412,7 @@ public class RepoProject implements Comparable { * Add a bunch of linkfile configurations. * * @param linkFiles + * a collection of {@link LinkFile}s * @since 4.8 */ public void addLinkFiles(Collection linkFiles) { @@ -448,6 +458,7 @@ public class RepoProject implements Comparable { return thatPath.startsWith(getPathWithSlash()); } + /** {@inheritDoc} */ @Override public boolean equals(Object o) { if (o instanceof RepoProject) { @@ -457,11 +468,13 @@ public class RepoProject implements Comparable { return false; } + /** {@inheritDoc} */ @Override public int hashCode() { return this.getPathWithSlash().hashCode(); } + /** {@inheritDoc} */ @Override public int compareTo(RepoProject that) { return this.getPathWithSlash().compareTo(that.getPathWithSlash()); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/internal/RepoText.java b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/internal/RepoText.java index 02a2565bdd..ccafff667f 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/internal/RepoText.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/internal/RepoText.java @@ -52,6 +52,8 @@ import org.eclipse.jgit.nls.TranslationBundle; public class RepoText extends TranslationBundle { /** + * Get an instance of this translation bundle + * * @return an instance of this translation bundle */ public static RepoText get() { -- 2.39.5