Browse Source

Fix javadoc in org.eclipse.jgit gitrepo package

Change-Id: I2604c7bca87f005004d6d6c80fa9a39a7a1e3807
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
tags/v4.10.0.201712302008-r
Matthias Sohn 6 years ago
parent
commit
5e2e111280

+ 15
- 1
org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/ManifestParser.java View File

} }


/** /**
* Constructor for ManifestParser
*
* @param includedReader * @param includedReader
* a
* {@link org.eclipse.jgit.gitrepo.ManifestParser.IncludedFileReader}
* object.
* @param filename * @param filename
* a {@link java.lang.String} object.
* @param defaultBranch * @param defaultBranch
* a {@link java.lang.String} object.
* @param baseUrl * @param baseUrl
* a {@link java.lang.String} object.
* @param groups * @param groups
* a {@link java.lang.String} object.
* @param rootRepo * @param rootRepo
* a {@link org.eclipse.jgit.lib.Repository} object.
*/ */
public ManifestParser(IncludedFileReader includedReader, String filename, public ManifestParser(IncludedFileReader includedReader, String filename,
String defaultBranch, String baseUrl, String groups, String defaultBranch, String baseUrl, String groups,
* Read the xml file. * Read the xml file.
* *
* @param inputStream * @param inputStream
* @throws IOException
* a {@link java.io.InputStream} object.
* @throws java.io.IOException
*/ */
public void read(InputStream inputStream) throws IOException { public void read(InputStream inputStream) throws IOException {
xmlInRead++; xmlInRead++;
} }
} }


/** {@inheritDoc} */
@Override @Override
public void startElement( public void startElement(
String uri, String uri,
} }
} }


/** {@inheritDoc} */
@Override @Override
public void endElement( public void endElement(
String uri, String uri,
} }
} }


/** {@inheritDoc} */
@Override @Override
public void endDocument() throws SAXException { public void endDocument() throws SAXException {
xmlInRead--; xmlInRead--;

+ 17
- 3
org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java View File

} }


/** /**
* Constructor for RepoCommand
*
* @param repo * @param repo
* the {@link org.eclipse.jgit.lib.Repository}
*/ */
public RepoCommand(Repository repo) { public RepoCommand(Repository repo) {
super(repo); super(repo);
* Setting inputStream will ignore the path set. It will be closed in * Setting inputStream will ignore the path set. It will be closed in
* {@link #call}. * {@link #call}.
* *
* @param inputStream
* @param inputStream a {@link java.io.InputStream} object.
* @return this command * @return this command
* @since 3.5 * @since 3.5
*/ */
* Set base URI of the paths inside the XML. This is typically the name of * Set base URI of the paths inside the XML. This is typically the name of
* the directory holding the manifest repository, eg. for * the directory holding the manifest repository, eg. for
* https://android.googlesource.com/platform/manifest, this should be * 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 * @param uri
* the base URI
* @return this command * @return this command
*/ */
public RepoCommand setURI(String uri) { public RepoCommand setURI(String uri) {
* revision specified in project, this branch will be used. * revision specified in project, this branch will be used.
* *
* @param branch * @param branch
* a branch name
* @return this command * @return this command
*/ */
public RepoCommand setBranch(String branch) { public RepoCommand setBranch(String branch) {
* ignored. * ignored.
* *
* @param branch * @param branch
* branch name
* @return this command * @return this command
* @since 4.1 * @since 4.1
*/ */
* *
* @see org.eclipse.jgit.lib.NullProgressMonitor * @see org.eclipse.jgit.lib.NullProgressMonitor
* @param monitor * @param monitor
* a {@link org.eclipse.jgit.lib.ProgressMonitor}
* @return this command * @return this command
*/ */
public RepoCommand setProgressMonitor(final ProgressMonitor monitor) { public RepoCommand setProgressMonitor(final ProgressMonitor monitor) {
* ignored. * ignored.
* *
* @param author * @param author
* the author's {@link org.eclipse.jgit.lib.PersonIdent}
* @return this command * @return this command
*/ */
public RepoCommand setAuthor(final PersonIdent author) { public RepoCommand setAuthor(final PersonIdent author) {
* This is only used in bare repositories. * This is only used in bare repositories.
* *
* @param callback * @param callback
* a {@link org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader}
* object.
* @return this command * @return this command
*/ */
public RepoCommand setRemoteReader(final RemoteReader callback) { public RepoCommand setRemoteReader(final RemoteReader callback) {
* Set the IncludedFileReader callback. * Set the IncludedFileReader callback.
* *
* @param reader * @param reader
* a
* {@link org.eclipse.jgit.gitrepo.ManifestParser.IncludedFileReader}
* object.
* @return this command * @return this command
* @since 4.0 * @since 4.0
*/ */
return this; return this;
} }


/** {@inheritDoc} */
@Override @Override
public RevCommit call() throws GitAPIException { public RevCommit call() throws GitAPIException {
try { try {

+ 15
- 2
org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoProject.java View File

} }


/** /**
* Constructor for RepoProject
*
* @param name * @param name
* the relative path to the {@code remote} * the relative path to the {@code remote}
* @param path * @param path
} }


/** /**
* Constructor for RepoProject
*
* @param name * @param name
* the relative path to the {@code remote} * the relative path to the {@code remote}
* @param path * @param path
* Set the url of the sub repo. * Set the url of the sub repo.
* *
* @param url * @param url
* project url
* @return this for chaining. * @return this for chaining.
*/ */
public RepoProject setUrl(String url) { public RepoProject setUrl(String url) {
* Set the default revision for the sub repo. * Set the default revision for the sub repo.
* *
* @param defaultRevision * @param defaultRevision
* the name of the default revision
* @return this for chaining. * @return this for chaining.
*/ */
public RepoProject setDefaultRevision(String defaultRevision) { public RepoProject setDefaultRevision(String defaultRevision) {
* Test whether this sub repo belongs to a specified group. * Test whether this sub repo belongs to a specified group.
* *
* @param group * @param group
* a group
* @return true if {@code group} is present. * @return true if {@code group} is present.
*/ */
public boolean inGroup(String group) { public boolean inGroup(String group) {
/** /**
* Add a copy file configuration. * Add a copy file configuration.
* *
* @param copyfile
* @param copyfile a {@link org.eclipse.jgit.gitrepo.RepoProject.CopyFile} object.
*/ */
public void addCopyFile(CopyFile copyfile) { public void addCopyFile(CopyFile copyfile) {
copyfiles.add(copyfile); copyfiles.add(copyfile);
* Add a bunch of copyfile configurations. * Add a bunch of copyfile configurations.
* *
* @param copyFiles * @param copyFiles
* a collection of
* {@link org.eclipse.jgit.gitrepo.RepoProject.CopyFile} objects
*/ */
public void addCopyFiles(Collection<CopyFile> copyFiles) { public void addCopyFiles(Collection<CopyFile> copyFiles) {
this.copyfiles.addAll(copyFiles); this.copyfiles.addAll(copyFiles);
/** /**
* Add a link file configuration. * Add a link file configuration.
* *
* @param linkfile
* @param linkfile a {@link org.eclipse.jgit.gitrepo.RepoProject.LinkFile} object.
* @since 4.8 * @since 4.8
*/ */
public void addLinkFile(LinkFile linkfile) { public void addLinkFile(LinkFile linkfile) {
* Add a bunch of linkfile configurations. * Add a bunch of linkfile configurations.
* *
* @param linkFiles * @param linkFiles
* a collection of {@link LinkFile}s
* @since 4.8 * @since 4.8
*/ */
public void addLinkFiles(Collection<LinkFile> linkFiles) { public void addLinkFiles(Collection<LinkFile> linkFiles) {
return thatPath.startsWith(getPathWithSlash()); return thatPath.startsWith(getPathWithSlash());
} }


/** {@inheritDoc} */
@Override @Override
public boolean equals(Object o) { public boolean equals(Object o) {
if (o instanceof RepoProject) { if (o instanceof RepoProject) {
return false; return false;
} }


/** {@inheritDoc} */
@Override @Override
public int hashCode() { public int hashCode() {
return this.getPathWithSlash().hashCode(); return this.getPathWithSlash().hashCode();
} }


/** {@inheritDoc} */
@Override @Override
public int compareTo(RepoProject that) { public int compareTo(RepoProject that) {
return this.getPathWithSlash().compareTo(that.getPathWithSlash()); return this.getPathWithSlash().compareTo(that.getPathWithSlash());

+ 2
- 0
org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/internal/RepoText.java View File

public class RepoText extends TranslationBundle { public class RepoText extends TranslationBundle {


/** /**
* Get an instance of this translation bundle
*
* @return an instance of this translation bundle * @return an instance of this translation bundle
*/ */
public static RepoText get() { public static RepoText get() {

Loading…
Cancel
Save