]> source.dussan.org Git - jgit.git/commitdiff
Fix all Javadoc warnings and fail on them 03/202303/11
authorAntoine Musso <hashar@free.fr>
Wed, 31 May 2023 15:57:28 +0000 (17:57 +0200)
committerMatthias Sohn <matthias.sohn@sap.com>
Thu, 15 Jun 2023 23:08:13 +0000 (01:08 +0200)
This fixes all the javadoc warnings, stops ignoring doclint 'missing'
category and fails the build on javadoc warnings for public and
protected classes and class members.

Since javadoc doesn't allow access specifiers when specifying doclint
configuration we cannot set `-Xdoclint:all,-missing/private`
hence there is no simple way to skip private elements from doclint.
Therefore we check javadoc using the Eclipse Java compiler
(which is used by default) and javadoc configuration in
`.settings/org.eclipse.jdt.core.prefs` files.
This allows more fine grained configuration.

We can reconsider this when javadoc starts supporting access specifiers
in the doclint configuration.

Below are detailled explanations for most modifications.

@inheritDoc
===========
doclint complains about explicits `{@inheritDoc}` when the parent does
not have any documentation. As far as I can tell, javadoc defaults to
inherit comments and should only be used when one wants to append extra
documentation from the parent. Given the parent has no documentation,
remove those usages which doclint complains about.

In some case I have moved up the documentation from the concrete class
up to the abstract class.

Remove `{@inheritDoc}` on overriden methods which don't add additional
documentation since javadoc defaults to inherit javadoc of overridden
methods.

@value to @link
===============
In PackConfig, DEFAULT_SEARCH_FOR_REUSE_TIMEOUT and similar are forged
from Integer.MAX_VALUE and are thus not considered constants (I guess
cause the value would depends on the platform). Replace it with a link
to `Integer.MAX_VALUE`.

In `StringUtils.toBoolean`, @value was used to refer to the
`stringValue` parameter. I have replaced it with `{@code stringValue}`.

{@link <url>} to <a>
====================
@link does not support being given an external URL. Replaces them with
HTML `<a>`.

@since: being invalid
=====================

org.eclipse.jgit/src/org/eclipse/jgit/util/Equality.java has an invalid
tag `@since: ` due to the extra `:`. Javadoc does not complain about it
with version 11.0.18+10 but does with 11.0.19.7. It is invalid
regardless.

invalid HTML syntax
===================

- javadoc doesn't allow <br/>, <p/> and </p> anymore, use <br> and <p>
instead
- replace <tt>code</tt> by {@code code}
- <table> tags don't allow summary attribute, specify caption as
<caption>caption</caption> to fix this

doclint visibility issue
========================

In the private abstract classes `BaseDirCacheEditor` and
`BasePackConnection` links to other methods in the abstract class are
inherited in the public subclasses but doclint gets confused and
considers them unreachable. The HTML documentation for the sub classes
shows the relative links in the sub classes, so it is all correct. It
must be a bug somewhere in javadoc.
Mute those warnings with: @SuppressWarnings("doclint:missing")

Misc
====
Replace `<` and `>` with HTML encoded entities (`&lt; and `&gt;`).
In `SshConstants` I went enclosing a serie of -> arrows in @literal.

Additional tags
===============
Configure maven-javad0c-plugin to allow the following additional tags
defined in https://openjdk.org/jeps/8068562:
- apiNote
- implSpec
- implNote

Missing javadoc
===============
Add missing @params and descriptions

Change-Id: I840056389aa59135cfb360da0d5e40463ce35bd0
Also-By: Matthias Sohn <matthias.sohn@sap.com>
627 files changed:
org.eclipse.jgit.ant/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitAddTask.java
org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitCheckoutTask.java
org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitCloneTask.java
org.eclipse.jgit.ant/src/org/eclipse/jgit/ant/tasks/GitInitTask.java
org.eclipse.jgit.archive/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/BaseFormat.java
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/Tbz2Format.java
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java
org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java
org.eclipse.jgit.gpg.bc/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.gpg.bc/src/org/eclipse/jgit/gpg/bc/internal/BouncyCastleGpgKeyLocator.java
org.eclipse.jgit.gpg.bc/src/org/eclipse/jgit/gpg/bc/internal/BouncyCastleGpgKeyPassphrasePrompt.java
org.eclipse.jgit.gpg.bc/src/org/eclipse/jgit/gpg/bc/internal/keys/KeyGrip.java
org.eclipse.jgit.gpg.bc/src/org/eclipse/jgit/gpg/bc/internal/keys/SExprParser.java
org.eclipse.jgit.gpg.bc/src/org/eclipse/jgit/gpg/bc/internal/keys/SecretKeys.java
org.eclipse.jgit.http.apache/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.http.apache/src/org/eclipse/jgit/transport/http/apache/HttpClientConnection.java
org.eclipse.jgit.http.apache/src/org/eclipse/jgit/transport/http/apache/TemporaryBufferEntity.java
org.eclipse.jgit.http.server/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/AsIsFileFilter.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitFilter.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/GitServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoPacksServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/InfoRefsServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/IsLocalFilter.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/NoCacheFilter.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ObjectFileServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ReceivePackErrorHandler.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/ReceivePackServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/RepositoryFilter.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartOutputStream.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/SmartServiceInfoRefs.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/TextFileServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/UploadPackErrorHandler.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/UploadPackServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ErrorServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaFilter.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/MetaServlet.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/NoParameterFilterConfig.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexGroupFilter.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/RegexPipeline.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/ServletBinderImpl.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/SuffixPipeline.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/glue/WrappedRequest.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultReceivePackFactory.java
org.eclipse.jgit.http.server/src/org/eclipse/jgit/http/server/resolver/DefaultUploadPackFactory.java
org.eclipse.jgit.http.test/src/org/eclipse/jgit/http/test/RefsUnreadableInMemoryRepository.java
org.eclipse.jgit.http.test/src/org/eclipse/jgit/http/test/TestRepositoryResolver.java
org.eclipse.jgit.junit.http/src/org/eclipse/jgit/junit/http/AccessEvent.java
org.eclipse.jgit.junit.http/src/org/eclipse/jgit/junit/http/AppServer.java
org.eclipse.jgit.junit.http/src/org/eclipse/jgit/junit/http/HttpTestCase.java
org.eclipse.jgit.junit.http/src/org/eclipse/jgit/junit/http/MockServletConfig.java
org.eclipse.jgit.junit.http/src/org/eclipse/jgit/junit/http/RecordingLogger.java
org.eclipse.jgit.junit.http/src/org/eclipse/jgit/junit/http/SimpleHttpServer.java
org.eclipse.jgit.junit.http/src/org/eclipse/jgit/junit/http/TestRequestLog.java
org.eclipse.jgit.junit.ssh/src/org/eclipse/jgit/junit/ssh/SshTestGitServer.java
org.eclipse.jgit.junit.ssh/src/org/eclipse/jgit/junit/ssh/SshTestHarness.java
org.eclipse.jgit.junit/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/JGitTestUtil.java
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/LocalDiskRepositoryTestCase.java
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/MockSystemReader.java
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/Repeat.java
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepeatRule.java
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/RepositoryTestCase.java
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/StrictWorkMonitor.java
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/TestRepository.java
org.eclipse.jgit.junit/src/org/eclipse/jgit/junit/time/MonotonicFakeClock.java
org.eclipse.jgit.lfs.server/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.lfs.server/src/org/eclipse/jgit/lfs/server/LargeFileRepository.java
org.eclipse.jgit.lfs.server/src/org/eclipse/jgit/lfs/server/LfsProtocolServlet.java
org.eclipse.jgit.lfs.server/src/org/eclipse/jgit/lfs/server/fs/FileLfsRepository.java
org.eclipse.jgit.lfs.server/src/org/eclipse/jgit/lfs/server/fs/ObjectDownloadListener.java
org.eclipse.jgit.lfs.server/src/org/eclipse/jgit/lfs/server/fs/ObjectUploadListener.java
org.eclipse.jgit.lfs.server/src/org/eclipse/jgit/lfs/server/s3/S3Repository.java
org.eclipse.jgit.lfs/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/LfsPointer.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/SmudgeFilter.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/AtomicObjectOutputStream.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/LfsConfig.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/internal/LfsConnectionFactory.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AbbreviatedLongObjectId.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/AnyLongObjectId.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LfsPointerFilter.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/LongObjectId.java
org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/MutableLongObjectId.java
org.eclipse.jgit.pgm/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.pgm/src/org/eclipse/jgit/console/ConsoleAuthenticator.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/console/ConsoleCredentialsProvider.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Add.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/AmazonS3Client.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Archive.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Blame.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Branch.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Checkout.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Clean.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Clone.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/CommandRef.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Commit.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Config.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/ConvertRefStorage.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Daemon.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Describe.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Diff.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/DiffTree.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Fetch.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Gc.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Glog.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/IndexPack.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Init.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Log.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/LsRemote.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/LsTree.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Main.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Merge.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/MergeBase.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Push.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/ReceivePack.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Reflog.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Remote.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Repo.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Reset.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/RevList.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/RevParse.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/RevWalkTextBuiltin.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Rm.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Show.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/ShowRef.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Status.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Tag.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/TextBuiltin.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/UploadPack.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Version.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/BenchmarkReftable.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/DiffAlgorithms.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/LfsStore.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/MakeCacheTree.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/ReadDirCache.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/ReadReftable.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/RebuildCommitGraph.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/ShowCacheTree.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/ShowCommands.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/ShowDirCache.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/ShowPackDelta.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/TextHashFunctions.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/VerifyReftable.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/WriteDirCache.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/debug/WriteReftable.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/AbstractTreeIteratorHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/CmdLineParser.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/GpgSignHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/InstantHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/ObjectIdHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/OptionWithValuesListHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/PathTreeFilterHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/RefSpecHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/RevCommitHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/RevTreeHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/SubcommandHandler.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/opt/UntrackedFilesHandler.java
org.eclipse.jgit.ssh.apache.agent/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.ssh.apache.agent/src/org/eclipse/jgit/internal/transport/sshd/agent/connector/UnixSockets.java
org.eclipse.jgit.ssh.apache/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/internal/transport/sshd/JGitClientSession.java
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/internal/transport/sshd/KnownHostEntryReader.java
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/internal/transport/sshd/OpenSshServerKeyDatabase.java
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/transport/sshd/IdentityPasswordProvider.java
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/transport/sshd/KeyPasswordProvider.java
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/transport/sshd/SshdSessionFactory.java
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/transport/sshd/agent/Connector.java
org.eclipse.jgit.ssh.jsch/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.ssh.jsch/src/org/eclipse/jgit/internal/transport/ssh/jsch/CredentialsProviderUserInfo.java
org.eclipse.jgit.ssh.jsch/src/org/eclipse/jgit/transport/ssh/jsch/JschConfigSessionFactory.java
org.eclipse.jgit.ssh.jsch/src/org/eclipse/jgit/transport/ssh/jsch/JschSession.java
org.eclipse.jgit.ssh.jsch/src/org/eclipse/jgit/transport/ssh/jsch/OpenSshConfig.java
org.eclipse.jgit.test/tst/org/eclipse/jgit/api/PushCommandTest.java
org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/revwalk/ObjectReachabilityTestCase.java
org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/revwalk/ReachabilityCheckerTestCase.java
org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/FileRepositoryBuilderAfterOpenConfigTest.java
org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/RefDirectoryAfterOpenConfigTest.java
org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/storage/file/SnapshottingRefDirectoryTest.java
org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/UploadPackTest.java
org.eclipse.jgit.ui/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit.ui/src/org/eclipse/jgit/awtui/AwtAuthenticator.java
org.eclipse.jgit.ui/src/org/eclipse/jgit/awtui/AwtCredentialsProvider.java
org.eclipse.jgit.ui/src/org/eclipse/jgit/awtui/CommitGraphPane.java
org.eclipse.jgit/.settings/org.eclipse.jdt.core.prefs
org.eclipse.jgit/src/org/eclipse/jgit/api/AddNoteCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/ArchiveCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/CheckoutCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/CherryPickCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/CleanCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/CreateBranchCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/DeleteBranchCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/DeleteTagCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/GarbageCollectCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java
org.eclipse.jgit/src/org/eclipse/jgit/api/ListBranchCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/ListNotesCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/ListTagCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/LogCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/MergeResult.java
org.eclipse.jgit/src/org/eclipse/jgit/api/NameRevCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/PullResult.java
org.eclipse.jgit/src/org/eclipse/jgit/api/RebaseCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/RebaseResult.java
org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/RenameBranchCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/ResetCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/ShowNoteCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/StashListCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleAddCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleDeinitCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleDeinitResult.java
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleInitCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleStatusCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/SubmoduleSyncCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/TransportCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/api/errors/CheckoutConflictException.java
org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attribute.java
org.eclipse.jgit/src/org/eclipse/jgit/attributes/Attributes.java
org.eclipse.jgit/src/org/eclipse/jgit/attributes/AttributesHandler.java
org.eclipse.jgit/src/org/eclipse/jgit/attributes/AttributesRule.java
org.eclipse.jgit/src/org/eclipse/jgit/attributes/FilterCommandRegistry.java
org.eclipse.jgit/src/org/eclipse/jgit/blame/BlameResult.java
org.eclipse.jgit/src/org/eclipse/jgit/blame/Candidate.java
org.eclipse.jgit/src/org/eclipse/jgit/blame/Region.java
org.eclipse.jgit/src/org/eclipse/jgit/blame/ReverseWalk.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffAlgorithm.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffEntry.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffFormatter.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/Edit.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/EditList.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/HashedSequence.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/HashedSequenceComparator.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/HistogramDiff.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/LowLevelDiffAlgorithm.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/PatchIdDiffFormatter.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/RawText.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/RawTextComparator.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/RenameDetector.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/Subsequence.java
org.eclipse.jgit/src/org/eclipse/jgit/diff/SubsequenceComparator.java
org.eclipse.jgit/src/org/eclipse/jgit/dircache/BaseDirCacheEditor.java
org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCache.java
org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheBuildIterator.java
org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheBuilder.java
org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheCheckout.java
org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheEditor.java
org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheIterator.java
org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheTree.java
org.eclipse.jgit/src/org/eclipse/jgit/errors/LargeObjectException.java
org.eclipse.jgit/src/org/eclipse/jgit/errors/RevisionSyntaxException.java
org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedEvent.java
org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedEvent.java
org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerHandle.java
org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerList.java
org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedEvent.java
org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryEvent.java
org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedEvent.java
org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/AbstractHead.java
org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/CharacterHead.java
org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/GroupHead.java
org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/LastHead.java
org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/RestrictedWildCardHead.java
org.eclipse.jgit/src/org/eclipse/jgit/fnmatch/WildCardHead.java
org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/ManifestParser.java
org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/gitrepo/RepoProject.java
org.eclipse.jgit/src/org/eclipse/jgit/hooks/CommitMsgHook.java
org.eclipse.jgit/src/org/eclipse/jgit/hooks/PostCommitHook.java
org.eclipse.jgit/src/org/eclipse/jgit/hooks/PreCommitHook.java
org.eclipse.jgit/src/org/eclipse/jgit/hooks/PrePushHook.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/FastIgnoreRule.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/IgnoreNode.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/AbstractMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/LeadingAsteriskMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/NameMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/PathMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/Strings.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/TrailingAsteriskMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildCardMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/diff/FilteredRenameDetector.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/diffmergetool/CommandExecutor.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/diffmergetool/DiffTools.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/diffmergetool/ExternalToolUtils.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/diffmergetool/FileElement.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/diffmergetool/MergeTools.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/diffmergetool/PreDefinedDiffTool.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/diffmergetool/UserDefinedMergeTool.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/fsck/FsckPackParser.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/revwalk/AddToBitmapFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/revwalk/AddToBitmapWithCacheFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/revwalk/AddUnseenToBitmapFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/revwalk/BitmappedReachabilityChecker.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/commitgraph/CommitGraph.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/commitgraph/CommitGraphConstants.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/commitgraph/CommitGraphV1.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/commitgraph/CommitGraphWriter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/commitgraph/GraphCommits.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/BeforeDfsPackIndexLoadedEvent.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsBlockCache.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsCachedPack.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsConfig.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsInserter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsObjDatabase.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsObjectRepresentation.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsObjectToPack.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPackDescription.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPackParser.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPacksChangedEvent.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReader.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsRefDatabase.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsRefRename.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsRefUpdate.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReftableDatabase.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReftableStack.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsRepository.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsRepositoryBuilder.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsRepositoryDescription.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsStreamKey.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/InMemoryRepository.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/LargePackedWholeObject.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/PackInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/BasePackBitmapIndex.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/BitmapIndexImpl.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ByteArrayWindow.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ByteBufferWindow.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/CachedObjectDirectory.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/CheckoutEntryImpl.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/FileObjectDatabase.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/FileReftableDatabase.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/FileReftableStack.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/FileRepository.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/FileSnapshot.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GcLog.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GlobalAttributesNode.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/InfoAttributesNode.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LargePackedWholeObject.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LazyObjectIdSetFile.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LocalCachedPack.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LocalObjectRepresentation.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LocalObjectToPack.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LockFile.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LooseObjects.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ObjectDirectory.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ObjectDirectoryInserter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ObjectDirectoryPackParser.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/Pack.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackBitmapIndex.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackBitmapIndexBuilder.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackBitmapIndexRemapper.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackBitmapIndexV1.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackDirectory.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackFileSnapshot.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackIndex.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackIndexV1.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackIndexV2.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackIndexWriterV1.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackIndexWriterV2.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackInserter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackObjectSizeIndexWriter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/PackedBatchRefUpdate.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/RefDirectory.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/RefDirectoryRename.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/RefDirectoryUpdate.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogEntryImpl.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogReaderImpl.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogWriter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/SimpleDataInput.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/SimpleDataOutput.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/SnapshottingRefDirectory.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/WindowCursor.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/io/BlockSource.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/io/CancellableDigestOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/memory/TernarySearchTree.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/DeltaIndex.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/DeltaTask.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/ObjectToPack.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackExt.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackWriter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/EmptyLogCursor.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/LogCursor.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/MergedReftable.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/RefCursor.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/Reftable.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/ReftableBatchRefUpdate.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/ReftableOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/ReftableReader.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/reftable/ReftableReflogReader.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/submodule/SubmoduleValidator.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/transport/ssh/OpenSshConfigFile.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/AbbrevConfig.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/AbbreviatedObjectId.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/AnyObjectId.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/BatchRefUpdate.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/BatchingProgressMonitor.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/BranchTrackingStatus.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/CommitBuilder.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/Config.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigConstants.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ConfigLine.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/Constants.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/DefaultTypedConfigGetter.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/EmptyProgressMonitor.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/GpgSignature.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/IndexDiff.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/MutableObjectId.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/NullProgressMonitor.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectBuilder.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectChecker.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectId.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectIdOwnerMap.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectIdRef.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectIdSubclassMap.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectReader.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/PersonIdent.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/RebaseTodoFile.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/RebaseTodoLine.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefComparator.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefDatabase.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefRename.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefUpdate.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefWriter.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ReflogReader.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/StoredConfig.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/SymbolicRef.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/TagBuilder.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/TextProgressMonitor.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/ThreadSafeProgressMonitor.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/TreeFormatter.java
org.eclipse.jgit/src/org/eclipse/jgit/lib/TypedConfigGetter.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/EolAwareOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/MergeAlgorithm.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/MergeFormatter.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/MergeResult.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/RecursiveMerger.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/ResolveMerger.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/StrategyOneSided.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/StrategyRecursive.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/StrategyResolve.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/StrategySimpleTwoWayInCore.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/ThreeWayMergeStrategy.java
org.eclipse.jgit/src/org/eclipse/jgit/merge/ThreeWayMerger.java
org.eclipse.jgit/src/org/eclipse/jgit/nls/NLS.java
org.eclipse.jgit/src/org/eclipse/jgit/notes/DefaultNoteMerger.java
org.eclipse.jgit/src/org/eclipse/jgit/notes/Note.java
org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMap.java
org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMapMerger.java
org.eclipse.jgit/src/org/eclipse/jgit/patch/CombinedFileHeader.java
org.eclipse.jgit/src/org/eclipse/jgit/patch/CombinedHunkHeader.java
org.eclipse.jgit/src/org/eclipse/jgit/patch/FileHeader.java
org.eclipse.jgit/src/org/eclipse/jgit/patch/FormatError.java
org.eclipse.jgit/src/org/eclipse/jgit/patch/HunkHeader.java
org.eclipse.jgit/src/org/eclipse/jgit/patch/PatchApplier.java
org.eclipse.jgit/src/org/eclipse/jgit/revplot/PlotCommit.java
org.eclipse.jgit/src/org/eclipse/jgit/revplot/PlotCommitList.java
org.eclipse.jgit/src/org/eclipse/jgit/revplot/PlotWalk.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/AbstractRevQueue.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/BlockRevQueue.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/DateRevQueue.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/DepthGenerator.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/DepthWalk.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/FIFORevQueue.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/FollowFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/FooterKey.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/FooterLine.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/Generator.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/LIFORevQueue.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/ObjectWalk.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevBlob.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommit.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommitCG.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommitList.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevFlag.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevObject.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevObjectList.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTag.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTree.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevWalk.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevWalkUtils.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RewriteGenerator.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/TopoNonIntermixSortGenerator.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/TopoSortGenerator.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/TreeRevFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/CommitTimeRevFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/MaxCountRevFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/NotRevFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/RevFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/RevFlagFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/SkipRevFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/SubStringRevFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/storage/file/FileBasedConfig.java
org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackConfig.java
org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleConflict.java
org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/AbstractAdvertiseRefsHook.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/AdvertiseRefsHook.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/AdvertiseRefsHookChain.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/BaseConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/BaseFetchConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackFetchConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackPushConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/BundleFetchConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/ChainingCredentialsProvider.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/CredentialItem.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/FilterSpec.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/FtpChannel.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/HMACSHA1NonceGenerator.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/HttpAuthMethod.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/InternalFetchConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/InternalPushConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/LsRefsV2Request.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/NetRCCredentialsProvider.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/NonceGenerator.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/ObjectInfoRequest.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PackParser.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PackedObjectInfo.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PostReceiveHookChain.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PostUploadHookChain.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PreReceiveHookChain.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PreUploadHookChain.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/ProtocolV0Parser.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PushCertificate.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PushCertificateIdent.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PushConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PushProcess.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceiveCommand.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivePack.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/RefLeaseSpec.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/RefSpec.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/RemoteRefUpdate.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandProgressMonitor.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/SshConfigStore.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/SshConstants.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/SshTransport.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TestProtocol.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TrackingRefUpdate.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportAmazonS3.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportBundleFile.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportBundleStream.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportGitAnon.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportGitSsh.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportHttp.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportLocal.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportProtocol.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportSftp.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/URIish.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/UserAgent.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/UsernamePasswordCredentialsProvider.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/WalkEncryption.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/WalkFetchConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/WalkPushConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/http/HttpConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/http/HttpConnectionFactory.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/http/HttpConnectionFactory2.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/http/JDKHttpConnection.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/resolver/FileResolver.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/CanonicalTreeParser.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/EmptyTreeIterator.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/FileTreeIterator.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/WorkingTreeIterator.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/ByteArraySet.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/IndexDiffFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/InterIndexDiffFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/NotIgnoredFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/NotTreeFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/PathFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/PathSuffixFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/SkipWorkTreeFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/treewalk/filter/TreeFilter.java
org.eclipse.jgit/src/org/eclipse/jgit/util/BlockList.java
org.eclipse.jgit/src/org/eclipse/jgit/util/CachedAuthenticator.java
org.eclipse.jgit/src/org/eclipse/jgit/util/Equality.java
org.eclipse.jgit/src/org/eclipse/jgit/util/FS.java
org.eclipse.jgit/src/org/eclipse/jgit/util/FS_POSIX.java
org.eclipse.jgit/src/org/eclipse/jgit/util/FS_Win32.java
org.eclipse.jgit/src/org/eclipse/jgit/util/FS_Win32_Cygwin.java
org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java
org.eclipse.jgit/src/org/eclipse/jgit/util/HttpSupport.java
org.eclipse.jgit/src/org/eclipse/jgit/util/IntList.java
org.eclipse.jgit/src/org/eclipse/jgit/util/LfsFactory.java
org.eclipse.jgit/src/org/eclipse/jgit/util/LongList.java
org.eclipse.jgit/src/org/eclipse/jgit/util/RawCharSequence.java
org.eclipse.jgit/src/org/eclipse/jgit/util/RawSubStringPattern.java
org.eclipse.jgit/src/org/eclipse/jgit/util/RefList.java
org.eclipse.jgit/src/org/eclipse/jgit/util/RefMap.java
org.eclipse.jgit/src/org/eclipse/jgit/util/SshSupport.java
org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/AutoCRLFInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/AutoCRLFOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/AutoLFInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/AutoLFOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/CountingOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/DisabledOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/IsolatedOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/LimitedInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/MessageWriter.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/StreamCopyThread.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/TeeInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/TeeOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/ThrowingPrintWriter.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/TimeoutInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/TimeoutOutputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/io/UnionInputStream.java
org.eclipse.jgit/src/org/eclipse/jgit/util/sha1/SHA1.java
org.eclipse.jgit/src/org/eclipse/jgit/util/time/MonotonicSystemClock.java
org.eclipse.jgit/src/org/eclipse/jgit/util/time/ProposedTimestamp.java
pom.xml

index f79df5b9dd9ce1c38f9eab0cdb01d5ae58ff7ba3..a08ba7b56f1f9bfa941078049c5f98eb8d8b4b8d 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 0d409bbf03eacb338a099e6b44a5925d24b97eb6..07b60cfc791572187fdcd86a7bb6b41e3b99937a 100644 (file)
@@ -75,7 +75,6 @@ public class GitAddTask extends Task {
                return path;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void execute() throws BuildException {
                if (src == null) {
index 1f10588b4e2f6470b9bb8b17b0dfeed708b2e3f9..ecb5f9addd78c4b0554e872a9f5207b7537eac13 100644 (file)
@@ -77,7 +77,6 @@ public class GitCheckoutTask extends Task {
                this.force = force;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void execute() throws BuildException {
                CheckoutCommand checkout;
index c143c9c6e1b92733d70b7668c3359fa9e9e84662..facf2ac6a06c1fbaa88e584ef5a37ad1305300b4 100644 (file)
@@ -76,7 +76,6 @@ public class GitCloneTask extends Task {
                this.branch = branch;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void execute() throws BuildException {
                log("Cloning repository " + uri);
index 161168fbe34249b5e2207372cd587122613f444f..5c2a26b9ee392aac18c6b521df5f234b9143c467 100644 (file)
@@ -48,7 +48,6 @@ public class GitInitTask extends Task {
                this.bare = bare;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void execute() throws BuildException {
                if (bare) {
index 2abe9529d324e4f4bac31f77f60da3f4452cc153..b27b6c3c7d54a1497d829f0090e455e387089dba 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 0ebac77228aeca54833c2b91769f7d645be4c8db..25cd36817aeaabb32dc4f7dab0fc81addbf75989 100644 (file)
@@ -40,6 +40,7 @@ public class BaseFormat {
         *            options map
         * @return stream with option applied
         * @throws IOException
+        *             if an IO error occurred
         */
        protected ArchiveOutputStream applyFormatOptions(ArchiveOutputStream s,
                        Map<String, Object> o) throws IOException {
index 702bad62fe4965a0c6ed5e41c632cfbb59a5b20c..dfa60321b0d2516e8be794ee3309f0932ea04e73 100644 (file)
@@ -39,7 +39,6 @@ public final class TarFormat extends BaseFormat implements
        private static final List<String> SUFFIXES = Collections
                        .unmodifiableList(Arrays.asList(".tar")); //$NON-NLS-1$
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
                        throws IOException {
@@ -47,7 +46,6 @@ public final class TarFormat extends BaseFormat implements
                                Collections.<String, Object> emptyMap());
        }
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
                        Map<String, Object> o) throws IOException {
@@ -58,7 +56,6 @@ public final class TarFormat extends BaseFormat implements
                return applyFormatOptions(out, o);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void putEntry(ArchiveOutputStream out,
                        ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@@ -108,19 +105,16 @@ public final class TarFormat extends BaseFormat implements
                out.closeArchiveEntry();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterable<String> suffixes() {
                return SUFFIXES;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object other) {
                return (other instanceof TarFormat);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return getClass().hashCode();
index 940dafd40fd37526a1727399384576f99ee1f0b3..26da4311472de8dd581887ffff163780940a9c4c 100644 (file)
@@ -33,7 +33,6 @@ public final class Tbz2Format extends BaseFormat implements
 
        private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat();
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
                        throws IOException {
@@ -41,7 +40,6 @@ public final class Tbz2Format extends BaseFormat implements
                                Collections.<String, Object> emptyMap());
        }
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
                        Map<String, Object> o) throws IOException {
@@ -55,7 +53,6 @@ public final class Tbz2Format extends BaseFormat implements
                return tarFormat.createArchiveOutputStream(out, o);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void putEntry(ArchiveOutputStream out,
                        ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@@ -63,19 +60,16 @@ public final class Tbz2Format extends BaseFormat implements
                tarFormat.putEntry(out, tree, path, mode, loader);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterable<String> suffixes() {
                return SUFFIXES;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object other) {
                return (other instanceof Tbz2Format);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return getClass().hashCode();
index 72e2439f68a0033009c4f8570c6e2eca32197aeb..d1ed035d0fa54e67a3dce4e0b231eee3ec93f6a1 100644 (file)
@@ -34,7 +34,6 @@ public final class TgzFormat extends BaseFormat implements
 
        private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat();
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
                        throws IOException {
@@ -42,7 +41,6 @@ public final class TgzFormat extends BaseFormat implements
                                Collections.<String, Object> emptyMap());
        }
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
                        Map<String, Object> o) throws IOException {
@@ -58,7 +56,6 @@ public final class TgzFormat extends BaseFormat implements
                return tarFormat.createArchiveOutputStream(out, o);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void putEntry(ArchiveOutputStream out,
                        ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@@ -66,19 +63,16 @@ public final class TgzFormat extends BaseFormat implements
                tarFormat.putEntry(out, tree, path, mode, loader);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterable<String> suffixes() {
                return SUFFIXES;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object other) {
                return (other instanceof TgzFormat);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return getClass().hashCode();
index b16fb6dcbdd9b8139d8f2e5d92ba010a3e090682..42549de302be1d5cc6224ccd253494c4109cf934 100644 (file)
@@ -33,7 +33,6 @@ public final class TxzFormat extends BaseFormat implements
 
        private final ArchiveCommand.Format<ArchiveOutputStream> tarFormat = new TarFormat();
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
                        throws IOException {
@@ -41,7 +40,6 @@ public final class TxzFormat extends BaseFormat implements
                                Collections.<String, Object> emptyMap());
        }
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
                        Map<String, Object> o) throws IOException {
@@ -55,7 +53,6 @@ public final class TxzFormat extends BaseFormat implements
                return tarFormat.createArchiveOutputStream(out, o);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void putEntry(ArchiveOutputStream out,
                        ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@@ -63,19 +60,16 @@ public final class TxzFormat extends BaseFormat implements
                tarFormat.putEntry(out, tree, path, mode, loader);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterable<String> suffixes() {
                return SUFFIXES;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object other) {
                return (other instanceof TxzFormat);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return getClass().hashCode();
index 97a24c75cbc489e07ea133ecc10b2b0026427594..6cb42ae1e5117258504345dc7c4b9cc1d281943b 100644 (file)
@@ -35,7 +35,6 @@ public final class ZipFormat extends BaseFormat implements
        private static final List<String> SUFFIXES = Collections
                        .unmodifiableList(Arrays.asList(".zip")); //$NON-NLS-1$
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s)
                        throws IOException {
@@ -43,7 +42,6 @@ public final class ZipFormat extends BaseFormat implements
                                Collections.<String, Object> emptyMap());
        }
 
-       /** {@inheritDoc} */
        @Override
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s,
                        Map<String, Object> o) throws IOException {
@@ -55,7 +53,6 @@ public final class ZipFormat extends BaseFormat implements
                return applyFormatOptions(out, o);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void putEntry(ArchiveOutputStream out,
                        ObjectId tree, String path, FileMode mode, ObjectLoader loader)
@@ -97,19 +94,16 @@ public final class ZipFormat extends BaseFormat implements
                out.closeArchiveEntry();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterable<String> suffixes() {
                return SUFFIXES;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object other) {
                return (other instanceof ZipFormat);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return getClass().hashCode();
index d1f54bbe65c24289e522dc34d1788648d2c197f8..d5c0e6c7e0e8c3e0fde785849f2237caf7467e3d 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 8cd03bd36fd34cb584574c66accd41d2d3631058..d7bf34e3ac4c9c509750d6ee8dcb515f43ced457 100644 (file)
@@ -324,7 +324,9 @@ public class BouncyCastleGpgKeyLocator {
         * @throws IOException
         *             in case of problems reading the file
         * @throws NoSuchAlgorithmException
+        *             if an algorithm isn't available
         * @throws NoSuchProviderException
+        *             if a provider isn't available
         * @throws NoOpenPgpKeyException
         *             if the file does not contain any OpenPGP key
         */
@@ -368,12 +370,17 @@ public class BouncyCastleGpgKeyLocator {
         * @throws IOException
         *             in case of issues reading key files
         * @throws NoSuchAlgorithmException
+        *             algorithm is not available
         * @throws NoSuchProviderException
+        *             provider is not available
         * @throws PGPException
         *             in case of issues finding a key, including no key found
         * @throws CanceledException
+        *             operation was cancelled
         * @throws URISyntaxException
+        *             URI is invalid
         * @throws UnsupportedCredentialItem
+        *             credential item is not supported
         */
        @NonNull
        public BouncyCastleGpgKey findSecretKey() throws IOException,
@@ -543,10 +550,11 @@ public class BouncyCastleGpgKeyLocator {
        /**
         * Return the first suitable key for signing in the key ring collection. For
         * this case we only expect there to be one key available for signing.
-        * </p>
         *
         * @param signingkey
+        *            the signing key
         * @param secringFile
+        *            the secring file
         *
         * @return the first suitable PGP secret key found for signing
         * @throws IOException
index 61441959830355fcb0a6f3e97105c512afed58a7..463b661127aabd3184813c5e90b59853dd01adfb 100644 (file)
@@ -69,10 +69,13 @@ class BouncyCastleGpgKeyPassphrasePrompt implements AutoCloseable {
         *            the location the key was loaded from
         * @return the passphrase (maybe <code>null</code>)
         * @throws PGPException
+        *             if a PGP problem occurred
         * @throws CanceledException
         *             in case passphrase was not entered by user
         * @throws URISyntaxException
+        *             if the URI isn't parseable
         * @throws UnsupportedCredentialItem
+        *             if a credential item isn't supported
         */
        public char[] getPassphrase(byte[] keyFingerprint, Path keyLocation)
                        throws PGPException, CanceledException, UnsupportedCredentialItem,
index c9317247106b4be08cf57ac76ff158654d08a9a4..3eee18aef5d25250c3d8c7d1b3755dedf4541ce9 100644 (file)
@@ -36,8 +36,8 @@ import org.eclipse.jgit.util.sha1.SHA1;
  * Utilities to compute the <em>keygrip</em> of a key. A keygrip is a SHA1 hash
  * over the public key parameters and is used internally by the gpg-agent to
  * find the secret key belonging to a public key: the secret key is stored in a
- * file under ~/.gnupg/private-keys-v1.d/ with a name "&lt;keygrip>.key". While
- * this storage organization is an implementation detail of GPG, the way
+ * file under ~/.gnupg/private-keys-v1.d/ with a name "&lt;keygrip&gt;.key".
+ * While this storage organization is an implementation detail of GPG, the way
  * keygrips are computed is not; they are computed by libgcrypt and their
  * definition is stable.
  */
index a9bb22c78059f1073aa0176f1e5d3957494cac78..c93c2164c996bdfc8a800ab468f9cd25dbdfaaf9 100644 (file)
@@ -95,7 +95,9 @@ public class SExprParser {
         *
         * @return a secret key object.
         * @throws IOException
+        *             if an IO error occurred
         * @throws PGPException
+        *             if some PGP error occurred
         */
        public PGPSecretKey parseSecretKey(InputStream inputStream,
                        PBEProtectionRemoverFactory keyProtectionRemoverFactory,
@@ -252,7 +254,9 @@ public class SExprParser {
         *
         * @return a secret key object.
         * @throws IOException
+        *             if an IO error occurred
         * @throws PGPException
+        *             if a PGP error occurred
         */
        public PGPSecretKey parseSecretKey(InputStream inputStream,
                        PBEProtectionRemoverFactory keyProtectionRemoverFactory,
index 269a1ba0f687f87b96bafc61dda120218f001386..a659d38fd3d39096bf29e0c1fa5936fec7fb7e19 100644 (file)
@@ -373,6 +373,7 @@ public final class SecretKeys {
         *            index of the closing quote in {@code in}
         * @return the dequoted raw string value
         * @throws StreamCorruptedException
+        *             if object stream is corrupt
         */
        private static byte[] dequote(byte[] in, int from, int to)
                        throws StreamCorruptedException {
index f79df5b9dd9ce1c38f9eab0cdb01d5ae58ff7ba3..a08ba7b56f1f9bfa941078049c5f98eb8d8b4b8d 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 90348f54b9774a121d380297f0b370f8f28d2d6c..6d806dee371773e64250f23c731d6101199e3c69 100644 (file)
@@ -203,6 +203,7 @@ public class HttpClientConnection implements HttpConnection {
         * Sets the buffer from which to take the request body
         *
         * @param buffer
+        *            the buffer
         */
        public void setBuffer(TemporaryBuffer buffer) {
                this.entity = new TemporaryBufferEntity(buffer);
@@ -212,7 +213,9 @@ public class HttpClientConnection implements HttpConnection {
         * Constructor for HttpClientConnection.
         *
         * @param urlStr
+        *            url string
         * @throws MalformedURLException
+        *             if url is malformed
         */
        public HttpClientConnection(String urlStr) throws MalformedURLException {
                this(urlStr, null);
@@ -222,8 +225,11 @@ public class HttpClientConnection implements HttpConnection {
         * Constructor for HttpClientConnection.
         *
         * @param urlStr
+        *            url string
         * @param proxy
+        *            proxy
         * @throws MalformedURLException
+        *             if url is malformed
         */
        public HttpClientConnection(String urlStr, Proxy proxy)
                        throws MalformedURLException {
@@ -234,9 +240,13 @@ public class HttpClientConnection implements HttpConnection {
         * Constructor for HttpClientConnection.
         *
         * @param urlStr
+        *            url string
         * @param proxy
+        *            proxy
         * @param cl
+        *            client
         * @throws MalformedURLException
+        *             if url is malformed
         */
        public HttpClientConnection(String urlStr, Proxy proxy, HttpClient cl)
                        throws MalformedURLException {
@@ -245,20 +255,17 @@ public class HttpClientConnection implements HttpConnection {
                this.proxy = proxy;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getResponseCode() throws IOException {
                execute();
                return resp.getStatusLine().getStatusCode();
        }
 
-       /** {@inheritDoc} */
        @Override
        public URL getURL() {
                return url;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getResponseMessage() throws IOException {
                execute();
@@ -287,7 +294,6 @@ public class HttpClientConnection implements HttpConnection {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, List<String>> getHeaderFields() {
                Map<String, List<String>> ret = new HashMap<>();
@@ -304,13 +310,11 @@ public class HttpClientConnection implements HttpConnection {
                return ret;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setRequestProperty(String name, String value) {
                req.addHeader(name, value);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setRequestMethod(String method) throws ProtocolException {
                this.method = method;
@@ -328,25 +332,21 @@ public class HttpClientConnection implements HttpConnection {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setUseCaches(boolean usecaches) {
                // not needed
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setConnectTimeout(int timeout) {
                this.timeout = Integer.valueOf(timeout);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setReadTimeout(int readTimeout) {
                this.readTimeout = Integer.valueOf(readTimeout);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getContentType() {
                HttpEntity responseEntity = resp.getEntity();
@@ -358,7 +358,6 @@ public class HttpClientConnection implements HttpConnection {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public InputStream getInputStream() throws IOException {
                execute();
@@ -366,7 +365,6 @@ public class HttpClientConnection implements HttpConnection {
        }
 
        // will return only the first field
-       /** {@inheritDoc} */
        @Override
        public String getHeaderField(@NonNull String name) {
                Header header = resp.getFirstHeader(name);
@@ -379,7 +377,6 @@ public class HttpClientConnection implements HttpConnection {
                                .stream().map(Header::getValue).collect(Collectors.toList()));
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getContentLength() {
                Header contentLength = resp.getFirstHeader("content-length"); //$NON-NLS-1$
@@ -395,19 +392,16 @@ public class HttpClientConnection implements HttpConnection {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setInstanceFollowRedirects(boolean followRedirects) {
                this.followRedirects = Boolean.valueOf(followRedirects);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setDoOutput(boolean dooutput) {
                // TODO: check whether we can really ignore this.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setFixedLengthStreamingMode(int contentLength) {
                if (entity != null)
@@ -416,7 +410,6 @@ public class HttpClientConnection implements HttpConnection {
                entity.setContentLength(contentLength);
        }
 
-       /** {@inheritDoc} */
        @Override
        public OutputStream getOutputStream() throws IOException {
                if (entity == null)
@@ -424,7 +417,6 @@ public class HttpClientConnection implements HttpConnection {
                return entity.getBuffer();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setChunkedStreamingMode(int chunklen) {
                if (entity == null)
@@ -432,31 +424,26 @@ public class HttpClientConnection implements HttpConnection {
                entity.setChunked(true);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getRequestMethod() {
                return method;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean usingProxy() {
                return isUsingProxy;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void connect() throws IOException {
                execute();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setHostnameVerifier(HostnameVerifier hostnameverifier) {
                this.hostnameverifier = hostnameverifier;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void configure(KeyManager[] km, TrustManager[] tm,
                        SecureRandom random) throws KeyManagementException {
index 101886c887dcc405456bb6794553a57e61853046..40be0747ef689828a4ff1464541668286cc7a66a 100644 (file)
@@ -33,6 +33,7 @@ public class TemporaryBufferEntity extends AbstractHttpEntity
         * content stored in the specified buffer
         *
         * @param buffer
+        *            the buffer
         */
        public TemporaryBufferEntity(TemporaryBuffer buffer) {
                this.buffer = buffer;
@@ -47,13 +48,11 @@ public class TemporaryBufferEntity extends AbstractHttpEntity
                return buffer;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isRepeatable() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getContentLength() {
                if (contentLength != null)
@@ -61,20 +60,17 @@ public class TemporaryBufferEntity extends AbstractHttpEntity
                return buffer.length();
        }
 
-       /** {@inheritDoc} */
        @Override
        public InputStream getContent() throws IOException, IllegalStateException {
                return buffer.openInputStream();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeTo(OutputStream outstream) throws IOException {
                // TODO: dont we need a progressmonitor
                buffer.writeTo(outstream, null);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isStreaming() {
                return false;
@@ -84,6 +80,7 @@ public class TemporaryBufferEntity extends AbstractHttpEntity
         * Set the <code>contentLength</code>
         *
         * @param contentLength
+        *            content length
         */
        public void setContentLength(int contentLength) {
                this.contentLength = Integer.valueOf(contentLength);
index f79df5b9dd9ce1c38f9eab0cdb01d5ae58ff7ba3..a08ba7b56f1f9bfa941078049c5f98eb8d8b4b8d 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 59dc309ccf0abd30010ce4cf63770a58b53963ed..fb74dc7024b22bce0182cf7bad3758ec888e3119 100644 (file)
@@ -37,19 +37,16 @@ class AsIsFileFilter implements Filter {
                this.asIs = getAnyFile;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void init(FilterConfig config) throws ServletException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void destroy() {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doFilter(ServletRequest request, ServletResponse response,
                        FilterChain chain) throws IOException, ServletException {
index 0957cc80fa40f5d570fe00d89d0af4e3bcbfca78..2f3eee41d6a99cc84c4a61d9114023b062cc1f99 100644 (file)
@@ -189,7 +189,6 @@ public class GitFilter extends MetaFilter {
                        throw new IllegalStateException(HttpServerText.get().alreadyInitializedByContainer);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
                super.init(filterConfig);
@@ -305,7 +304,6 @@ public class GitFilter extends MetaFilter {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected ServletBinder register(ServletBinder binder) {
                if (resolver == null)
index 8e49b37b3d38f9c8100163bb8f72ba3edc6bb460..0157dff9f5989b3cde928af497cbe25b06551083 100644 (file)
@@ -170,7 +170,6 @@ public class GitServlet extends MetaServlet {
                gitFilter.addReceivePackFilter(filter);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void init(ServletConfig config) throws ServletException {
                gitFilter.init(new FilterConfig() {
index e90580b75f36feb8c55c5f0a458189d491e07e15..d94cc41268f0d2864e46accb6fc595bdffc373f6 100644 (file)
@@ -27,7 +27,6 @@ import org.eclipse.jgit.lib.ObjectDatabase;
 class InfoPacksServlet extends HttpServlet {
        private static final long serialVersionUID = 1L;
 
-       /** {@inheritDoc} */
        @Override
        public void doGet(final HttpServletRequest req,
                        final HttpServletResponse rsp) throws IOException {
index f67313d77fce0bf360dbc2924885c4e64ed623bd..4d86be1916c4fea6a4d5f5202b6596219698b7d6 100644 (file)
@@ -29,7 +29,6 @@ import org.eclipse.jgit.util.HttpSupport;
 class InfoRefsServlet extends HttpServlet {
        private static final long serialVersionUID = 1L;
 
-       /** {@inheritDoc} */
        @Override
        public void doGet(final HttpServletRequest req,
                        final HttpServletResponse rsp) throws IOException {
index e0d95128e3c56886a585a5ce124dfa602a89e8d1..434cdb48d16d58a9a21dab3987fab5b0aeacb3ed 100644 (file)
@@ -33,19 +33,16 @@ import org.eclipse.jgit.lib.Repository;
  * downstream servlet can directly access its contents on disk.
  */
 class IsLocalFilter implements Filter {
-       /** {@inheritDoc} */
        @Override
        public void init(FilterConfig config) throws ServletException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void destroy() {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doFilter(ServletRequest request, ServletResponse response,
                        FilterChain chain) throws IOException, ServletException {
index 4f9e6f2223b68c8c6e598a0494cf3099955ba4d4..b1a2b30995b278688f495d99e48aceb1f35bbfdf 100644 (file)
@@ -26,19 +26,16 @@ import javax.servlet.http.HttpServletResponse;
 
 /** Add HTTP response headers to prevent caching by proxies/browsers. */
 class NoCacheFilter implements Filter {
-       /** {@inheritDoc} */
        @Override
        public void init(FilterConfig config) throws ServletException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void destroy() {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doFilter(ServletRequest request, ServletResponse response,
                        FilterChain chain) throws IOException, ServletException {
index 625ab3e663eaa37f54a73b2c7e20605ecbe3489b..e581707ccfc93653a2554e14634fd1b36d35e511 100644 (file)
@@ -87,14 +87,12 @@ abstract class ObjectFileServlet extends HttpServlet {
 
        abstract String etag(FileSender sender) throws IOException;
 
-       /** {@inheritDoc} */
        @Override
        public void doGet(final HttpServletRequest req,
                        final HttpServletResponse rsp) throws IOException {
                serve(req, rsp, true);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void doHead(final HttpServletRequest req,
                        final HttpServletResponse rsp) throws ServletException, IOException {
index a7ca4d0931616d43f791fe50e28bda0f67fcd751..c87bbe61454434ee946d53307fa6f1fc232b4044 100644 (file)
@@ -42,6 +42,7 @@ public interface ReceivePackErrorHandler {
         * @param r
         *            A continuation that handles a git-receive-pack request.
         * @throws IOException
+        *             if an IO error occurred
         */
        void receive(HttpServletRequest req, HttpServletResponse rsp,
                        ReceivePackRunnable r) throws IOException;
@@ -52,7 +53,9 @@ public interface ReceivePackErrorHandler {
                 * See {@link ReceivePack#receiveWithExceptionPropagation}.
                 *
                 * @throws ServiceMayNotContinueException
+                *             if transport service cannot continue
                 * @throws IOException
+                *             if an IO error occurred
                 */
                void receive() throws ServiceMayNotContinueException, IOException;
        }
index f8c95f56d4ced9ffdbc9cab492660427f97ea50d..56b4c807439eb4343075eb03348cfc5f794505fd 100644 (file)
@@ -136,7 +136,6 @@ class ReceivePackServlet extends HttpServlet {
                this.handler = handler;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doPost(final HttpServletRequest req,
                        final HttpServletResponse rsp) throws IOException {
index 943e7f5d4fe909b453d126f8865d22b3333476e4..9ff922bd7d0605d13d9afd8f26891f6030d6562b 100644 (file)
@@ -71,19 +71,16 @@ public class RepositoryFilter implements Filter {
                this.resolver = resolver;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void init(FilterConfig config) throws ServletException {
                context = config.getServletContext();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void destroy() {
                context = null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doFilter(final ServletRequest request,
                        final ServletResponse response, final FilterChain chain)
index 11123d00797daf6a9431322ede176f7214136f9f..fdac79d4b0b8bc83f209891d8f6c857ccbdeef09 100644 (file)
@@ -50,7 +50,6 @@ class SmartOutputStream extends TemporaryBuffer {
                this.compressStream = compressStream;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected OutputStream overflow() throws IOException {
                startedOutput = true;
@@ -63,7 +62,6 @@ class SmartOutputStream extends TemporaryBuffer {
                return out;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                super.close();
index 6110bff33497614d09f96d76e412bd60be1a66cb..aa04431285f791867480a7145d64f07a7212b8aa 100644 (file)
@@ -47,19 +47,16 @@ abstract class SmartServiceInfoRefs implements Filter {
                this.filters = filters.toArray(new Filter[0]);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void init(FilterConfig config) throws ServletException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void destroy() {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doFilter(ServletRequest request, ServletResponse response,
                        FilterChain chain) throws IOException, ServletException {
@@ -122,8 +119,12 @@ abstract class SmartServiceInfoRefs implements Filter {
         * @param db
         *            repository
         * @throws IOException
+        *             if an IO error occurred
         * @throws ServiceNotEnabledException
+        *             if a service is not available
         * @throws ServiceNotAuthorizedException
+        *             if service requires authentication and the current user
+        *             didn't provide credentials
         */
        protected abstract void begin(HttpServletRequest req, Repository db)
                        throws IOException, ServiceNotEnabledException,
@@ -135,35 +136,43 @@ abstract class SmartServiceInfoRefs implements Filter {
         * @param req
         *            request
         * @param pck
+        *            used to frame lines in PacketLineOut format
         * @throws IOException
+        *             if an IO error occurred
         * @throws ServiceNotEnabledException
+        *             if a service is not available
         * @throws ServiceNotAuthorizedException
+        *             if service requires authentication and the current user
+        *             didn't provide credentials
         */
        protected abstract void advertise(HttpServletRequest req,
                        PacketLineOutRefAdvertiser pck) throws IOException,
                        ServiceNotEnabledException, ServiceNotAuthorizedException;
 
        /**
-        * Writes the appropriate response to an info/refs request received by
-        * a smart service. In protocol v0, this starts with "#
-        * service=serviceName" followed by a flush packet, but this is not
-        * necessarily the case in other protocol versions.
+        * Writes the appropriate response to an info/refs request received by a
+        * smart service. In protocol v0, this starts with "# service=serviceName"
+        * followed by a flush packet, but this is not necessarily the case in other
+        * protocol versions.
         * <p>
-        * The default implementation writes "# service=serviceName" and a
-        * flush packet, then calls {@link #advertise}. Subclasses should
-        * override this method if they support protocol versions other than
-        * protocol v0.
+        * The default implementation writes "# service=serviceName" and a flush
+        * packet, then calls {@link #advertise}. Subclasses should override this
+        * method if they support protocol versions other than protocol v0.
         *
         * @param req
         *            request
         * @param pckOut
         *            destination of response
         * @param serviceName
-        *            service name to be written out in protocol v0; may or may
-        *            not be used in other versions
+        *            service name to be written out in protocol v0; may or may not
+        *            be used in other versions
         * @throws IOException
+        *             if an IO error occurred
         * @throws ServiceNotEnabledException
+        *             if a service is not available
         * @throws ServiceNotAuthorizedException
+        *             if service requires authentication and the current user
+        *             didn't provide credentials
         */
        protected void respond(HttpServletRequest req,
                        PacketLineOut pckOut, String serviceName)
index df8eb7727144c11577c2a436d335f34ddc81c6a0..0b225e769f82c2f372e05312a2d6821cff023dc4 100644 (file)
@@ -35,7 +35,6 @@ class TextFileServlet extends HttpServlet {
                this.fileName = name;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doGet(final HttpServletRequest req,
                        final HttpServletResponse rsp) throws IOException {
index 2aadbbc984f14f0377147b877b16ba1328b890c2..aaf537f28317e560be14f4f27eae8154feb854fe 100644 (file)
@@ -58,6 +58,7 @@ public interface UploadPackErrorHandler {
                }
                return SC_INTERNAL_SERVER_ERROR;
        }
+
        /**
         * @param req
         *            The HTTP request
@@ -66,6 +67,7 @@ public interface UploadPackErrorHandler {
         * @param r
         *            A continuation that handles a git-upload-pack request.
         * @throws IOException
+        *             if an IO error occurred
         */
        void upload(HttpServletRequest req, HttpServletResponse rsp,
                        UploadPackRunnable r) throws IOException;
@@ -76,7 +78,9 @@ public interface UploadPackErrorHandler {
                 * See {@link UploadPack#uploadWithExceptionPropagation}.
                 *
                 * @throws ServiceMayNotContinueException
+                *             transport service cannot continue
                 * @throws IOException
+                *             if an IO error occurred
                 */
                void upload() throws ServiceMayNotContinueException, IOException;
        }
index f16e56d9496f1377660b49ccaaf5ebb7ed7f12d1..74419a50d843ba58a3271d9b6e68b13efeae53c1 100644 (file)
@@ -158,7 +158,6 @@ class UploadPackServlet extends HttpServlet {
                                : this::defaultUploadPackHandler;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doPost(HttpServletRequest req, HttpServletResponse rsp)
                        throws IOException {
index 7f4243a730b1e663dac150de5cd2824956a0249a..822bb7964461be889a7e9b4947c989b4d12324dd 100644 (file)
@@ -35,7 +35,6 @@ public class ErrorServlet extends HttpServlet {
                this.status = status;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse rsp)
                        throws ServletException, IOException {
index 772b9966166c0d00b53f7e265bfbc92a33d8e1b0..e626bec134b4956ae0d7a4c6cd5e0abb7378dbd7 100644 (file)
@@ -97,13 +97,11 @@ public class MetaFilter implements Filter {
                return register(new RegexPipeline.Binder(pattern));
        }
 
-       /** {@inheritDoc} */
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
                servletContext = filterConfig.getServletContext();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void destroy() {
                if (pipelines != null) {
@@ -140,7 +138,6 @@ public class MetaFilter implements Filter {
                };
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doFilter(ServletRequest request, ServletResponse response,
                        FilterChain chain) throws IOException, ServletException {
index a0fa5ea5bb1372cd2d970e40b651c515ba60398b..9a1a24960f9f24c6421075a69c6d6a47d941748b 100644 (file)
@@ -88,7 +88,6 @@ public class MetaServlet extends HttpServlet {
                return filter.serveRegex(expression);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void init(ServletConfig config) throws ServletException {
                String name = filter.getClass().getName();
@@ -96,13 +95,11 @@ public class MetaServlet extends HttpServlet {
                filter.init(new NoParameterFilterConfig(name, ctx));
        }
 
-       /** {@inheritDoc} */
        @Override
        public void destroy() {
                filter.destroy();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void service(HttpServletRequest req, HttpServletResponse res)
                        throws ServletException, IOException {
index ebe272885b84fc7067a882a0f0530f26b3dc4703..3f7ee2a664aec8c3618adfabf2835e12a058890c 100644 (file)
@@ -26,13 +26,11 @@ final class NoParameterFilterConfig implements FilterConfig {
                this.context = context;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getInitParameter(String name) {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Enumeration<String> getInitParameterNames() {
                return new Enumeration<>() {
@@ -49,13 +47,11 @@ final class NoParameterFilterConfig implements FilterConfig {
                };
        }
 
-       /** {@inheritDoc} */
        @Override
        public ServletContext getServletContext() {
                return context;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getFilterName() {
                return filterName;
index a321c96728e73b88ea4f940660885a52d8da6b07..c8ff6a3308b5744ecf9ca98a0193a104f3b23046 100644 (file)
@@ -49,19 +49,16 @@ public class RegexGroupFilter implements Filter {
                this.groupIdx = groupIdx - 1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void init(FilterConfig config) throws ServletException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void destroy() {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void doFilter(final ServletRequest request,
                        final ServletResponse rsp, final FilterChain chain)
index 431202b2ba54a63e6999f6d11700aa58b743d62f..5baa14a618ada205c1e497233299d4731b2b160c 100644 (file)
@@ -131,7 +131,6 @@ class RegexPipeline extends UrlPipeline {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "Pipeline[regex: " + pattern + " ]";
index 21f1800239e41e77ca6b1586ac3460fd9430cc38..cd490230d97b0240abfcff6753523920a2881318 100644 (file)
@@ -28,7 +28,6 @@ abstract class ServletBinderImpl implements ServletBinder {
                this.filters = new ArrayList<>();
        }
 
-       /** {@inheritDoc} */
        @Override
        public ServletBinder through(Filter filter) {
                if (filter == null)
@@ -37,7 +36,6 @@ abstract class ServletBinderImpl implements ServletBinder {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void with(HttpServlet servlet) {
                if (servlet == null)
index 86441b18c355f35286a373fea6b448ee16911e4d..39d57b59ecda42dc777134fdf18cdab90be23989 100644 (file)
@@ -70,7 +70,6 @@ class SuffixPipeline extends UrlPipeline {
                super.service(new WrappedRequest(req, newPath, newInfo), rsp);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "Pipeline[ *" + suffix + " ]";
index e6bc934288315f42c26d888afc47d1a12e5f44a9..4bac040238b8b60d6153d325f2ae04e307aa0b5f 100644 (file)
@@ -38,20 +38,17 @@ public class WrappedRequest extends HttpServletRequestWrapper {
                this.pathInfo = pathInfo;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getPathTranslated() {
                final String p = getPathInfo();
                return p != null ? getSession().getServletContext().getRealPath(p) : null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getPathInfo() {
                return pathInfo;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getServletPath() {
                return path;
index 16b27e8bd6378e47f15a74579eb21e6fccedc22f..0bf10cbd7866a4aa08b2599a67b36f4949276264 100644 (file)
@@ -47,7 +47,6 @@ public class DefaultReceivePackFactory implements
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public ReceivePack create(HttpServletRequest req, Repository db)
                        throws ServiceNotEnabledException, ServiceNotAuthorizedException {
index d362a96bec50f6075fc5e9a4d9470fcadb3cd9d8..29314359c8c211709367b60514d10ece025ab765 100644 (file)
@@ -38,7 +38,6 @@ public class DefaultUploadPackFactory implements
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public UploadPack create(HttpServletRequest req, Repository db)
                        throws ServiceNotEnabledException, ServiceNotAuthorizedException {
index 4167b038e1f63e025584186d5b016165977b8be9..86da87f8d6655c21b64ef227c2d0e2214b33ed60 100644 (file)
@@ -36,7 +36,6 @@ class RefsUnreadableInMemoryRepository extends InMemoryRepository {
                failing = false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefDatabase getRefDatabase() {
                return refs;
@@ -54,7 +53,6 @@ class RefsUnreadableInMemoryRepository extends InMemoryRepository {
 
        private class RefsUnreadableRefDatabase extends MemRefDatabase {
 
-               /** {@inheritDoc} */
                @Override
                public Ref exactRef(String name) throws IOException {
                        if (failing) {
@@ -63,7 +61,6 @@ class RefsUnreadableInMemoryRepository extends InMemoryRepository {
                        return super.exactRef(name);
                }
 
-               /** {@inheritDoc} */
                @Override
                public Map<String, Ref> getRefs(String prefix) throws IOException {
                        if (failing) {
@@ -73,7 +70,6 @@ class RefsUnreadableInMemoryRepository extends InMemoryRepository {
                        return super.getRefs(prefix);
                }
 
-               /** {@inheritDoc} */
                @Override
                public List<Ref> getRefsByPrefix(String prefix) throws IOException {
                        if (failing) {
@@ -83,7 +79,6 @@ class RefsUnreadableInMemoryRepository extends InMemoryRepository {
                        return super.getRefsByPrefix(prefix);
                }
 
-               /** {@inheritDoc} */
                @Override
                public List<Ref> getRefsByPrefixWithExclusions(String include, Set<String> excludes)
                                throws IOException {
@@ -94,7 +89,6 @@ class RefsUnreadableInMemoryRepository extends InMemoryRepository {
                        return super.getRefsByPrefixWithExclusions(include, excludes);
                }
 
-               /** {@inheritDoc} */
                @Override
                public Set<Ref> getTipsWithSha1(ObjectId id) throws IOException {
                        if (failing) {
index 6478b942285ae7a6a0aac3f9e12e930d79b52c2b..82168d1c5ac9a4b04c897eaeed431252c91d90b4 100644 (file)
@@ -41,7 +41,6 @@ public final class TestRepositoryResolver
                this.repoName = repoName;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Repository open(HttpServletRequest req, String name)
                        throws RepositoryNotFoundException, ServiceNotEnabledException {
index 873d4306756c668b98fdff21984c90cf8b8647c9..3d4f3792438aadedf93ac9b78c1f00a8cbf6e34e 100644 (file)
@@ -146,7 +146,6 @@ public class AccessEvent {
                return responseHeaders != null ? responseHeaders.get(name) : null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder b = new StringBuilder();
index 36f2f2bc7fff6ce30da5ab4aaa8288271074447a..de4535ab5298d02362ede0d8f4d161860a5a049c 100644 (file)
@@ -260,7 +260,9 @@ public class AppServer {
         * Configure basic authentication.
         *
         * @param ctx
+        *            servlet context handler
         * @param methods
+        *            the methods
         * @return servlet context handler
         */
        public ServletContextHandler authBasic(ServletContextHandler ctx,
index 877b918695908e6e3fc747667318ced43508e101..8a4d363709fb7ddc8283b1e48763af6d0a1f4a0e 100644 (file)
@@ -45,14 +45,12 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
        /** In-memory application server; subclass must start. */
        protected AppServer server;
 
-       /** {@inheritDoc} */
        @Override
        public void setUp() throws Exception {
                super.setUp();
                server = createServer();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void tearDown() throws Exception {
                server.tearDown();
@@ -78,6 +76,7 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         *
         * @return the TestRepository
         * @throws IOException
+        *             if an IO error occurred
         */
        protected TestRepository<Repository> createTestRepository()
                        throws IOException {
@@ -90,8 +89,10 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Convert path to URIish
         *
         * @param path
+        *            the path
         * @return the URIish
         * @throws URISyntaxException
+        *             if URI is invalid
         */
        protected URIish toURIish(String path) throws URISyntaxException {
                URI u = server.getURI().resolve(path);
@@ -102,9 +103,12 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Convert a path relative to the app's context path to a URIish
         *
         * @param app
+        *            app name
         * @param name
+        *            context path name
         * @return the warnings (if any) from the last execution
         * @throws URISyntaxException
+        *             if URI is invalid
         */
        protected URIish toURIish(ServletContextHandler app, String name)
                        throws URISyntaxException {
@@ -128,7 +132,9 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Get requests.
         *
         * @param base
+        *            base URI
         * @param path
+        *            the request path relative to {@code base}
         *
         * @return list of events
         */
@@ -140,6 +146,7 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Get requests.
         *
         * @param path
+        *            request path
         *
         * @return list of events
         */
@@ -151,8 +158,11 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Run fsck
         *
         * @param db
+        *            the repository
         * @param tips
+        *            tips to start checking from
         * @throws Exception
+        *             if an error occurred
         */
        protected static void fsck(Repository db, RevObject... tips)
                        throws Exception {
@@ -166,6 +176,7 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Mirror refs
         *
         * @param refs
+        *            the refs
         * @return set of RefSpecs
         */
        protected static Set<RefSpec> mirror(String... refs) {
@@ -183,9 +194,12 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Push a commit
         *
         * @param from
+        *            repository from which to push
         * @param q
+        *            commit to push
         * @return collection of RefUpdates
         * @throws IOException
+        *             if an IO error occurred
         */
        protected static Collection<RemoteRefUpdate> push(TestRepository from,
                        RevCommit q) throws IOException {
@@ -205,7 +219,9 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Create loose object path
         *
         * @param base
+        *            base URI
         * @param id
+        *            objectId
         * @return path of the loose object
         */
        public static String loose(URIish base, AnyObjectId id) {
@@ -219,6 +235,7 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Join a base URIish and a path
         *
         * @param base
+        *            base URI
         * @param path
         *            a relative path
         * @return the joined path
@@ -237,8 +254,11 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Rewrite a url
         *
         * @param url
+        *            the URL
         * @param newProtocol
+        *            new protocol
         * @param newPort
+        *            new port
         * @return the rewritten url
         */
        protected static String rewriteUrl(String url, String newProtocol,
@@ -263,9 +283,12 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase {
         * Extend a path
         *
         * @param uri
+        *            the URI
         * @param pathComponents
+        *            path components
         * @return the extended URIish
         * @throws URISyntaxException
+        *             if URI is invalid
         */
        protected static URIish extendPath(URIish uri, String pathComponents)
                        throws URISyntaxException {
index 715fd19451b7f53eb120d279f0592c4d638c42c6..cd1eba4bfd43fa0ba1f7f0d13cea8e536a3e0c06 100644 (file)
@@ -28,19 +28,19 @@ public class MockServletConfig implements ServletConfig {
         * Set init parameter.
         *
         * @param name
+        *            parameter name
         * @param value
+        *            parameter value
         */
        public void setInitParameter(String name, String value) {
                parameters.put(name, value);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getInitParameter(String name) {
                return parameters.get(name);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Enumeration<String> getInitParameterNames() {
                final Iterator<String> i = parameters.keySet().iterator();
@@ -58,13 +58,11 @@ public class MockServletConfig implements ServletConfig {
                };
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getServletName() {
                return "MOCK_SERVLET";
        }
 
-       /** {@inheritDoc} */
        @Override
        public ServletContext getServletContext() {
                return null;
index af63084e936801cbe2387c43d2d2be858c69e05d..f56e1fa5c4117e527a0c77f238354235a2f171a2 100644 (file)
@@ -70,6 +70,7 @@ public class RecordingLogger extends MarkerIgnoringBase {
         * Constructor for <code>RecordingLogger</code>.
         *
         * @param name
+        *            logger name
         */
        public RecordingLogger(String name) {
                this.name = name;
index 2493f999fa0db201ba9e899258503bd6a940489c..01f18dab75b44c192db89ec0492f72eccd1f2a9b 100644 (file)
@@ -40,6 +40,7 @@ public class SimpleHttpServer {
         * Constructor for <code>SimpleHttpServer</code>.
         *
         * @param repository
+        *            the repository
         */
        public SimpleHttpServer(Repository repository) {
                this(repository, false);
@@ -49,7 +50,9 @@ public class SimpleHttpServer {
         * Constructor for <code>SimpleHttpServer</code>.
         *
         * @param repository
+        *            the repository
         * @param withSsl
+        *            whether to encrypt the communication
         */
        public SimpleHttpServer(Repository repository, boolean withSsl) {
                this.db = repository;
@@ -60,6 +63,7 @@ public class SimpleHttpServer {
         * Start the server
         *
         * @throws Exception
+        *             if an error occurred
         */
        public void start() throws Exception {
                ServletContextHandler sBasic = server.authBasic(smart("/sbasic"));
@@ -76,6 +80,7 @@ public class SimpleHttpServer {
         * Stop the server.
         *
         * @throws Exception
+        *             if an error occurred
         */
        public void stop() throws Exception {
                server.tearDown();
index 04cb2428a2cfb2dada5791e4eefecaa8ab94b6c7..afa8c35bb2cec6cb47037fb3b18228b719ab91ad 100644 (file)
@@ -72,7 +72,6 @@ class TestRequestLog extends HandlerWrapper {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void handle(String target, Request baseRequest,
                        HttpServletRequest request, HttpServletResponse response)
index 5d043ffc3af70e56f6d50457465bb2347c09a25d..1138be8a96c523cad3cc73571993c34e568f371a 100644 (file)
@@ -116,7 +116,9 @@ public class SshTestGitServer {
         * @param hostKey
         *            the unencrypted private key to use as host key
         * @throws IOException
+        *             if an IO error occurred
         * @throws GeneralSecurityException
+        *             if something went wrong
         */
        public SshTestGitServer(@NonNull String testUser, @NonNull Path testKey,
                        @NonNull Repository repository, @NonNull byte[] hostKey)
@@ -138,7 +140,9 @@ public class SshTestGitServer {
         * @param hostKey
         *            the unencrypted private key to use as host key
         * @throws IOException
+        *             if an IO error occurred
         * @throws GeneralSecurityException
+        *             if something went wrong
         * @since 5.9
         */
        public SshTestGitServer(@NonNull String testUser, @NonNull Path testKey,
@@ -413,6 +417,7 @@ public class SshTestGitServer {
         * @return the port the server listens on; test clients should connect to
         *         that port
         * @throws IOException
+        *             if an IO error occurred
         */
        public int start() throws IOException {
                server.start();
@@ -423,6 +428,7 @@ public class SshTestGitServer {
         * Stops the test server.
         *
         * @throws IOException
+        *             if an IO error occurred
         */
        public void stop() throws IOException {
                executorService.shutdownNow();
index a28d5ebd98d2b54e2c9fa126e0a9c1ea1d04787c..6fa30d7e1ec326c1ee63b032b8cdb6449658ca21 100644 (file)
@@ -191,6 +191,7 @@ public abstract class SshTestHarness extends RepositoryTestCase {
         *            to use
         * @return the public-key part of the line
         * @throws IOException
+        *             if an IO error occurred
         */
        protected static String createKnownHostsFile(File file, String host,
                        int port, File publicKey) throws IOException {
index bdfba71f547395199424412af04e1725cc96494b..bb15648cbf5123738fedd63eb3dcac3dd723090b 100644 (file)
@@ -56,7 +56,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 61d3b860e9217218550152e5c1db8fb08e7a86c3..177d8737cb6fdaf046bd93d11998980361b265f7 100644 (file)
@@ -107,6 +107,7 @@ public abstract class JGitTestUtil {
         * Get test resource file.
         *
         * @param fileName
+        *            file name
         * @return the test resource file
         */
        public static File getTestResourceFile(String fileName) {
@@ -141,8 +142,11 @@ public abstract class JGitTestUtil {
         * Copy test resource.
         *
         * @param name
+        *            resource name
         * @param dest
+        *            destination file
         * @throws IOException
+        *             if an IO error occurred
         */
        public static void copyTestResource(String name, File dest)
                        throws IOException {
@@ -165,10 +169,14 @@ public abstract class JGitTestUtil {
         * Write a trash file.
         *
         * @param db
+        *            the repository
         * @param name
+        *            file name
         * @param data
+        *            file content
         * @return the trash file
         * @throws IOException
+        *             if an IO error occurred
         */
        public static File writeTrashFile(final Repository db,
                        final String name, final String data) throws IOException {
@@ -181,11 +189,16 @@ public abstract class JGitTestUtil {
         * Write a trash file.
         *
         * @param db
+        *            the repository
         * @param subdir
+        *            under working tree
         * @param name
+        *            file name
         * @param data
+        *            file content
         * @return the trash file
         * @throws IOException
+        *             if an IO error occurred
         */
        public static File writeTrashFile(final Repository db,
                        final String subdir,
@@ -237,9 +250,12 @@ public abstract class JGitTestUtil {
         * Read a file's content
         *
         * @param db
+        *            the repository
         * @param name
+        *            file name
         * @return the content of the file
         * @throws IOException
+        *             if an IO error occurred
         */
        public static String read(Repository db, String name)
                        throws IOException {
@@ -251,6 +267,7 @@ public abstract class JGitTestUtil {
         * Check if file exists
         *
         * @param db
+        *            the repository
         * @param name
         *            name of the file
         * @return {@code true} if the file exists
@@ -264,8 +281,11 @@ public abstract class JGitTestUtil {
         * Delete a trash file.
         *
         * @param db
+        *            the repository
         * @param name
+        *            file name
         * @throws IOException
+        *             if an IO error occurred
         */
        public static void deleteTrashFile(final Repository db,
                        final String name) throws IOException {
@@ -284,6 +304,7 @@ public abstract class JGitTestUtil {
         *            the target of the symbolic link
         * @return the path to the symbolic link
         * @throws Exception
+        *             if an error occurred
         * @since 4.2
         */
        public static Path writeLink(Repository db, String link,
index 59662cec95817261f0cfd1a5fecc9237036ba16b..0945327ab357c05597bdf3dbc95450890e16ab36 100644 (file)
@@ -107,6 +107,7 @@ public abstract class LocalDiskRepositoryTestCase {
         * Setup test
         *
         * @throws Exception
+        *             if an error occurred
         */
        @Before
        public void setUp() throws Exception {
@@ -189,6 +190,7 @@ public abstract class LocalDiskRepositoryTestCase {
         * Tear down the test
         *
         * @throws Exception
+        *             if an error occurred
         */
        @After
        public void tearDown() throws Exception {
@@ -314,11 +316,11 @@ public abstract class LocalDiskRepositoryTestCase {
         *            {@link #CONTENT} controlling which info is present in the
         *            resulting string.
         * @return a string encoding the index state
-        * @throws IllegalStateException
         * @throws IOException
+        *             if an IO error occurred
         */
        public static String indexState(Repository repo, int includedOptions)
-                       throws IllegalStateException, IOException {
+                       throws IOException {
                DirCache dc = repo.readDirCache();
                StringBuilder sb = new StringBuilder();
                TreeSet<Instant> timeStamps = new TreeSet<>();
@@ -452,6 +454,7 @@ public abstract class LocalDiskRepositoryTestCase {
         *            a subdirectory
         * @return a unique directory for a test
         * @throws IOException
+        *             if an IO error occurred
         */
        protected File createTempDirectory(String name) throws IOException {
                File directory = new File(createTempFile(), name);
@@ -467,6 +470,7 @@ public abstract class LocalDiskRepositoryTestCase {
         *            working directory
         * @return a unique directory for a test repository
         * @throws IOException
+        *             if an IO error occurred
         */
        protected File createUniqueTestGitDir(boolean bare) throws IOException {
                String gitdirName = createTempFile().getPath();
@@ -487,6 +491,7 @@ public abstract class LocalDiskRepositoryTestCase {
         *
         * @return a unique path that does not exist.
         * @throws IOException
+        *             if an IO error occurred
         */
        protected File createTempFile() throws IOException {
                File p = File.createTempFile("tmp_", "", tmp);
@@ -586,6 +591,7 @@ public abstract class LocalDiskRepositoryTestCase {
         *            the file
         * @return the content of the file
         * @throws IOException
+        *             if an IO error occurred
         */
        protected String read(File f) throws IOException {
                return JGitTestUtil.read(f);
index 6bfe70659bd57a6f354856c31a27b34cd03da5b6..4dbfc59ec7bb98c2e131339233bcdb61cdfbcf89 100644 (file)
@@ -144,32 +144,30 @@ public class MockSystemReader extends SystemReader {
         * Set a property
         *
         * @param key
+        *            the key
         * @param value
+        *            the value
         */
        public void setProperty(String key, String value) {
                values.put(key, value);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getenv(String variable) {
                return values.get(variable);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getProperty(String key) {
                return values.get(key);
        }
 
-       /** {@inheritDoc} */
        @Override
        public FileBasedConfig openUserConfig(Config parent, FS fs) {
                assert parent == null || parent == systemGitConfig;
                return userGitConfig;
        }
 
-       /** {@inheritDoc} */
        @Override
        public FileBasedConfig openSystemConfig(Config parent, FS fs) {
                assert parent == null;
@@ -193,19 +191,16 @@ public class MockSystemReader extends SystemReader {
                return systemGitConfig;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getHostname() {
                return "fake.host.example.com";
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getCurrentTime() {
                return now;
        }
 
-       /** {@inheritDoc} */
        @Override
        public MonotonicClock getClock() {
                return () -> {
@@ -236,31 +231,26 @@ public class MockSystemReader extends SystemReader {
                now += secDelta * 1000L;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getTimezone(long when) {
                return getTimeZone().getOffset(when) / (60 * 1000);
        }
 
-       /** {@inheritDoc} */
        @Override
        public TimeZone getTimeZone() {
                return TimeZone.getTimeZone("GMT-03:30");
        }
 
-       /** {@inheritDoc} */
        @Override
        public Locale getLocale() {
                return Locale.US;
        }
 
-       /** {@inheritDoc} */
        @Override
        public SimpleDateFormat getSimpleDateFormat(String pattern) {
                return new SimpleDateFormat(pattern, getLocale());
        }
 
-       /** {@inheritDoc} */
        @Override
        public DateFormat getDateTimeInstance(int dateStyle, int timeStyle) {
                return DateFormat
index 343aa92f8a79f9443a21a583f47fe99641d352b0..4bf2eb59da6b3bcd29b3be7b5c4fd2f497009d66 100644 (file)
@@ -21,6 +21,8 @@ import java.lang.annotation.Target;
 public @interface Repeat {
        /**
         * Number of repetitions
+        *
+        * @return number of repetitions
         */
        public abstract int n();
 
index adcc10cad8d15e86aaafcfe65f0529e8973e71ab..30fffe9d94449f05712dbc7726fd260ee5952cc6 100644 (file)
@@ -125,7 +125,6 @@ public class RepeatRule implements TestRule {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public Statement apply(Statement statement, Description description) {
                Statement result = statement;
index 04988f6289f1f3d639a5563ecb8d9efe25cf6935..3a283ce10dd71537fc359fa148b1150538acf29c 100644 (file)
@@ -62,8 +62,11 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Copy a file
         *
         * @param src
+        *            file to copy
         * @param dst
+        *            destination of the copy
         * @throws IOException
+        *             if an IO error occurred
         */
        protected static void copyFile(File src, File dst)
                        throws IOException {
@@ -81,9 +84,12 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Write a trash file
         *
         * @param name
+        *            file name
         * @param data
+        *            file content
         * @return the trash file
         * @throws IOException
+        *             if an IO error occurred
         */
        protected File writeTrashFile(String name, String data)
                        throws IOException {
@@ -99,6 +105,7 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         *            the target of the symbolic link
         * @return the path to the symbolic link
         * @throws Exception
+        *             if an error occurred
         * @since 4.2
         */
        protected Path writeLink(String link, String target)
@@ -110,10 +117,14 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Write a trash file
         *
         * @param subdir
+        *            in working tree
         * @param name
+        *            file name
         * @param data
+        *            file content
         * @return the trash file
         * @throws IOException
+        *             if an IO error occurred
         */
        protected File writeTrashFile(final String subdir, final String name,
                        final String data)
@@ -125,8 +136,10 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Read content of a file
         *
         * @param name
+        *            file name
         * @return the file's content
         * @throws IOException
+        *             if an IO error occurred
         */
        protected String read(String name) throws IOException {
                return JGitTestUtil.read(db, name);
@@ -149,6 +162,7 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * @param name
         *            file name
         * @throws IOException
+        *             if an IO error occurred
         */
        protected void deleteTrashFile(String name) throws IOException {
                JGitTestUtil.deleteTrashFile(db, name);
@@ -158,9 +172,11 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Check content of a file.
         *
         * @param f
+        *            file
         * @param checkData
         *            expected content
         * @throws IOException
+        *             if an IO error occurred
         */
        protected static void checkFile(File f, String checkData)
                        throws IOException {
@@ -181,7 +197,6 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
        /** Working directory of {@link #db}. */
        protected File trash;
 
-       /** {@inheritDoc} */
        @Override
        @Before
        public void setUp() throws Exception {
@@ -229,11 +244,11 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         *            {@link #CONTENT} controlling which info is present in the
         *            resulting string.
         * @return a string encoding the index state
-        * @throws IllegalStateException
         * @throws IOException
+        *             if an IO error occurred
         */
        public String indexState(int includedOptions)
-                       throws IllegalStateException, IOException {
+                       throws IOException {
                return indexState(db, includedOptions);
        }
 
@@ -251,7 +266,9 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         *            a {@link org.eclipse.jgit.treewalk.FileTreeIterator} which
         *            determines which files should go into the new index
         * @throws FileNotFoundException
+        *             file was not found
         * @throws IOException
+        *             if an IO error occurred
         */
        protected void resetIndex(FileTreeIterator treeItr)
                        throws FileNotFoundException, IOException {
@@ -339,7 +356,9 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * @return return the last measured value of the filesystem timer which is
         *         greater than then the lastmodification time of lastfile.
         * @throws InterruptedException
+        *             if thread was interrupted
         * @throws IOException
+        *             if an IO error occurred
         * @since 5.1.9
         */
        public static Instant fsTick(File lastFile)
@@ -378,8 +397,11 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Create a branch
         *
         * @param objectId
+        *            new value to create the branch on
         * @param branchName
+        *            branch name
         * @throws IOException
+        *             if an IO error occurred
         */
        protected void createBranch(ObjectId objectId, String branchName)
                        throws IOException {
@@ -393,6 +415,7 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         *
         * @return list of refs
         * @throws IOException
+        *             if an IO error occurred
         */
        public List<Ref> getRefs() throws IOException {
                return db.getRefDatabase().getRefs();
@@ -402,11 +425,12 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Checkout a branch
         *
         * @param branchName
-        * @throws IllegalStateException
+        *            branch name
         * @throws IOException
+        *             if an IO error occurred
         */
        protected void checkoutBranch(String branchName)
-                       throws IllegalStateException, IOException {
+                       throws IOException {
                try (RevWalk walk = new RevWalk(db)) {
                        RevCommit head = walk.parseCommit(db.resolve(Constants.HEAD));
                        RevCommit branch = walk.parseCommit(db.resolve(branchName));
@@ -436,7 +460,9 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         *            the contents which should be written into the files
         * @return the File object associated to the last written file.
         * @throws IOException
+        *             if an IO error occurred
         * @throws InterruptedException
+        *             if thread was interrupted
         */
        protected File writeTrashFiles(boolean ensureDistinctTimestamps,
                        String... contents)
@@ -459,8 +485,11 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * one.
         *
         * @param filename
+        *            file name
         * @param contents
+        *            file content
         * @param branch
+        *            branch name
         * @return the created commit
         */
        protected RevCommit commitFile(String filename, String contents, String branch) {
@@ -494,7 +523,9 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Create <code>DirCacheEntry</code>
         *
         * @param path
+        *            file path
         * @param mode
+        *            file mode
         * @return the DirCacheEntry
         */
        protected DirCacheEntry createEntry(String path, FileMode mode) {
@@ -505,8 +536,11 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Create <code>DirCacheEntry</code>
         *
         * @param path
+        *            file path
         * @param mode
+        *            file mode
         * @param content
+        *            file content
         * @return the DirCacheEntry
         */
        protected DirCacheEntry createEntry(final String path, final FileMode mode,
@@ -518,9 +552,13 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Create <code>DirCacheEntry</code>
         *
         * @param path
+        *            file path
         * @param mode
+        *            file mode
         * @param stage
+        *            stage index of the new entry
         * @param content
+        *            file content
         * @return the DirCacheEntry
         */
        protected DirCacheEntry createEntry(final String path, final FileMode mode,
@@ -538,7 +576,9 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Create <code>DirCacheEntry</code>
         *
         * @param path
+        *            file path
         * @param objectId
+        *            of the entry
         * @return the DirCacheEntry
         */
        protected DirCacheEntry createGitLink(String path, AnyObjectId objectId) {
@@ -553,8 +593,11 @@ public abstract class RepositoryTestCase extends LocalDiskRepositoryTestCase {
         * Assert files are equal
         *
         * @param expected
+        *            expected file
         * @param actual
+        *            actual file
         * @throws IOException
+        *             if an IO error occurred
         */
        public static void assertEqualsFile(File expected, File actual)
                        throws IOException {
index c77bca97514fef669eddc6e6642dd6e47d031e95..0168ecea30215d5e9a5ff20f1ff533b891065574 100644 (file)
@@ -20,32 +20,27 @@ import org.eclipse.jgit.lib.ProgressMonitor;
 public final class StrictWorkMonitor implements ProgressMonitor {
        private int lastWork, totalWork;
 
-       /** {@inheritDoc} */
        @Override
        public void start(int totalTasks) {
                // empty
        }
 
-       /** {@inheritDoc} */
        @Override
        public void beginTask(String title, int total) {
                this.totalWork = total;
                lastWork = 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void update(int completed) {
                lastWork += completed;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void endTask() {
                assertEquals("Units of work recorded", totalWork, lastWork);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isCancelled() {
                return false;
index 483b9a7c8173ec9ed4f1ac17bd0a5dcb84e6f66c..4b4553547795ff754cb213f6a1ab1e72fbb15941 100644 (file)
@@ -115,6 +115,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         * @param db
         *            the test repository to write into.
         * @throws IOException
+        *             if an IO error occurred
         */
        public TestRepository(R db) throws IOException {
                this(db, new RevWalk(db), new MockSystemReader());
@@ -128,6 +129,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         * @param rw
         *            the RevObject pool to use for object lookup.
         * @throws IOException
+        *             if an IO error occurred
         */
        public TestRepository(R db, RevWalk rw) throws IOException {
                this(db, rw, new MockSystemReader());
@@ -144,6 +146,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            the MockSystemReader to use for clock and other system
         *            operations.
         * @throws IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        public TestRepository(R db, RevWalk rw, MockSystemReader reader)
@@ -235,6 +238,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            file content, will be UTF-8 encoded.
         * @return reference to the blob.
         * @throws Exception
+        *             if an error occurred
         */
        public RevBlob blob(String content) throws Exception {
                return blob(content.getBytes(UTF_8));
@@ -247,6 +251,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            binary file content.
         * @return the new, fully parsed blob.
         * @throws Exception
+        *             if an error occurred
         */
        public RevBlob blob(byte[] content) throws Exception {
                ObjectId id;
@@ -266,6 +271,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            a blob, previously constructed in the repository.
         * @return the entry.
         * @throws Exception
+        *             if an error occurred
         */
        public DirCacheEntry file(String path, RevBlob blob)
                        throws Exception {
@@ -284,6 +290,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            a blob, previously constructed in the repository.
         * @return the entry.
         * @throws Exception
+        *             if an error occurred
         * @since 6.3
         */
        public DirCacheEntry link(String path, RevBlob blob) throws Exception {
@@ -301,6 +308,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            to be sorted properly and may be empty.
         * @return the new, fully parsed tree specified by the entry list.
         * @throws Exception
+        *             if an error occurred
         */
        public RevTree tree(DirCacheEntry... entries) throws Exception {
                final DirCache dc = DirCache.newInCore();
@@ -326,6 +334,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            the path to find the entry of.
         * @return the parsed object entry at this path, never null.
         * @throws Exception
+        *             if an error occurred
         */
        public RevObject get(RevTree tree, String path)
                        throws Exception {
@@ -357,6 +366,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            zero or more IDs of the commit's parents.
         * @return the ID of the new commit.
         * @throws Exception
+        *             if an error occurred
         * @since 5.5
         */
        public ObjectId unparsedCommit(ObjectId... parents) throws Exception {
@@ -373,6 +383,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            zero or more parents of the commit.
         * @return the new commit.
         * @throws Exception
+        *             if an error occurred
         */
        public RevCommit commit(RevCommit... parents) throws Exception {
                return commit(1, tree(), parents);
@@ -389,6 +400,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            zero or more parents of the commit.
         * @return the new commit.
         * @throws Exception
+        *             if an error occurred
         */
        public RevCommit commit(RevTree tree, RevCommit... parents)
                        throws Exception {
@@ -407,6 +419,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            zero or more parents of the commit.
         * @return the new commit.
         * @throws Exception
+        *             if an error occurred
         */
        public RevCommit commit(int secDelta, RevCommit... parents)
                        throws Exception {
@@ -428,6 +441,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            zero or more parents of the commit.
         * @return the new, fully parsed commit.
         * @throws Exception
+        *             if an error occurred
         */
        public RevCommit commit(final int secDelta, final RevTree tree,
                        final RevCommit... parents) throws Exception {
@@ -450,6 +464,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            zero or more IDs of the commit's parents.
         * @return the ID of the new commit.
         * @throws Exception
+        *             if an error occurred
         * @since 5.5
         */
        public ObjectId unparsedCommit(final int secDelta, final RevTree tree,
@@ -496,6 +511,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            object the tag should be pointed at.
         * @return the new, fully parsed annotated tag object.
         * @throws Exception
+        *             if an error occurred
         */
        public RevTag tag(String name, RevObject dst) throws Exception {
                final TagBuilder t = new TagBuilder();
@@ -524,6 +540,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            the target object.
         * @return the target object.
         * @throws Exception
+        *             if an error occurred
         */
        public RevCommit update(String ref, CommitBuilder to) throws Exception {
                return update(ref, to.create());
@@ -534,12 +551,13 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *
         * @param ref
         *            the name of the reference to amend, which must already exist.
-        *            If {@code ref} does not start with {@code refs/} and is not the
-        *            magic names {@code HEAD} {@code FETCH_HEAD} or {@code
-        *            MERGE_HEAD}, then {@code refs/heads/} will be prefixed in front
-        *            of the given name, thereby assuming it is a branch.
+        *            If {@code ref} does not start with {@code refs/} and is not
+        *            the magic names {@code HEAD} {@code FETCH_HEAD} or {@code
+        *            MERGE_HEAD}, then {@code refs/heads/} will be prefixed in
+        *            front of the given name, thereby assuming it is a branch.
         * @return commit builder that amends the branch on commit.
         * @throws Exception
+        *             if an error occurred
         */
        public CommitBuilder amendRef(String ref) throws Exception {
                String name = normalizeRef(ref);
@@ -556,6 +574,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            the id of the commit to amend.
         * @return commit builder.
         * @throws Exception
+        *             if an error occurred
         */
        public CommitBuilder amend(AnyObjectId id) throws Exception {
                return amend(pool.parseCommit(id), commit());
@@ -610,6 +629,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            the target object.
         * @return the target object.
         * @throws Exception
+        *             if an error occurred
         */
        public <T extends AnyObjectId> T update(String ref, T obj) throws Exception {
                ref = normalizeRef(ref);
@@ -632,9 +652,10 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         * Delete a reference.
         *
         * @param ref
-        *            the name of the reference to delete. This is normalized
-        *            in the same way as {@link #update(String, AnyObjectId)}.
+        *            the name of the reference to delete. This is normalized in the
+        *            same way as {@link #update(String, AnyObjectId)}.
         * @throws Exception
+        *             if an error occurred
         * @since 4.4
         */
        public void delete(String ref) throws Exception {
@@ -674,6 +695,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         * @param id
         *            ID of detached head.
         * @throws Exception
+        *             if an error occurred
         * @see #reset(String)
         */
        public void reset(AnyObjectId id) throws Exception {
@@ -695,13 +717,14 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
        /**
         * Soft-reset HEAD to a different commit.
         * <p>
-        * This is equivalent to {@code git reset --soft} in that it modifies HEAD but
-        * not the index or the working tree of a non-bare repository.
+        * This is equivalent to {@code git reset --soft} in that it modifies HEAD
+        * but not the index or the working tree of a non-bare repository.
         *
         * @param name
-        *            revision string; either an existing ref name, or something that
-        *            can be parsed to an object ID.
+        *            revision string; either an existing ref name, or something
+        *            that can be parsed to an object ID.
         * @throws Exception
+        *             if an error occurred
         */
        public void reset(String name) throws Exception {
                RefUpdate.Result result;
@@ -735,6 +758,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         * @return the new, fully parsed commit, or null if no work was done due to
         *         the resulting tree being identical.
         * @throws Exception
+        *             if an error occurred
         */
        public RevCommit cherryPick(AnyObjectId id) throws Exception {
                RevCommit commit = pool.parseCommit(id);
@@ -779,6 +803,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         * Update the dumb client server info files.
         *
         * @throws Exception
+        *             if an error occurred
         */
        public void updateServerInfo() throws Exception {
                if (db instanceof FileRepository) {
@@ -816,6 +841,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            parsing of.
         * @return {@code object}
         * @throws Exception
+        *             if an error occurred
         */
        public <T extends RevObject> T parseBody(T object) throws Exception {
                pool.parseBody(object);
@@ -851,6 +877,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            the object to tag
         * @return the tagged object
         * @throws Exception
+        *             if an error occurred
         */
        public ObjectId lightweightTag(String name, ObjectId obj) throws Exception {
                if (!name.startsWith(Constants.R_TAGS))
@@ -868,8 +895,11 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         *            the tips to start checking from; if not supplied the refs of
         *            the repository are used instead.
         * @throws MissingObjectException
+        *             if object is missing
         * @throws IncorrectObjectTypeException
+        *             if object has unexpected type
         * @throws IOException
+        *             if an IO error occurred
         */
        public void fsck(RevObject... tips) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
@@ -922,6 +952,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
         * not removed.
         *
         * @throws Exception
+        *             if an error occurred
         */
        public void packAndPrune() throws Exception {
                if (db.getObjectDatabase() instanceof ObjectDirectory) {
@@ -1022,6 +1053,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
                 *            the commit to update to.
                 * @return {@code to}.
                 * @throws Exception
+                *             if an error occurred
                 */
                public RevCommit update(CommitBuilder to) throws Exception {
                        return update(to.create());
@@ -1034,6 +1066,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
                 *            the commit to update to.
                 * @return {@code to}.
                 * @throws Exception
+                *             if an error occurred
                 */
                public RevCommit update(RevCommit to) throws Exception {
                        return TestRepository.this.update(ref, to);
@@ -1041,7 +1074,9 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
 
                /**
                 * Delete this branch.
+                *
                 * @throws Exception
+                *             if an error occurred
                 * @since 4.4
                 */
                public void delete() throws Exception {
@@ -1102,6 +1137,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
                 *            parent commit
                 * @return this commit builder
                 * @throws Exception
+                *             if an error occurred
                 */
                public CommitBuilder parent(RevCommit p) throws Exception {
                        if (parents.isEmpty()) {
@@ -1165,6 +1201,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
                 *            the file content
                 * @return this commit builder
                 * @throws Exception
+                *             if an error occurred
                 */
                public CommitBuilder add(String path, String content) throws Exception {
                        return add(path, blob(content));
@@ -1179,6 +1216,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
                 *            blob for this file
                 * @return this commit builder
                 * @throws Exception
+                *             if an error occurred
                 */
                public CommitBuilder add(String path, RevBlob id)
                                throws Exception {
@@ -1404,6 +1442,7 @@ public class TestRepository<R extends Repository> implements AutoCloseable {
                 *
                 * @return child commit builder
                 * @throws Exception
+                *             if an error occurred
                 */
                public CommitBuilder child() throws Exception {
                        return new CommitBuilder(this);
index e5338d36cd1c85df324b16bc1ec91b9ca65f7c40..31db6a2c7b92eb432d6d4aaad56bbf1ca0fcdbe5 100644 (file)
@@ -40,7 +40,6 @@ public class MonotonicFakeClock implements MonotonicClock {
                now += unit.toMillis(add);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ProposedTimestamp propose() {
                long t = now++;
index 0857bc15f2983842faf9d7097b69104b3ffcbe7c..3a92f0c4346a8005f52f3189e2aa1a6f4266755b 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 5e37664eb38ac71a6210fcbb945eba396db7b6f3..4c81baf8388a66e39d4e2d0f0bc984ad31515a35 100644 (file)
@@ -60,6 +60,7 @@ public interface LargeFileRepository {
         * @return length of the object content in bytes, -1 if the object doesn't
         *         exist
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        long getSize(AnyLongObjectId id) throws IOException;
 }
index 3ec08ecc838759a13effa3dc37655be578ad3ac9..6747b014dcbeb02e547394a8943ffd7a752889b2 100644 (file)
@@ -164,7 +164,6 @@ public abstract class LfsProtocolServlet extends HttpServlet {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void doPost(HttpServletRequest req, HttpServletResponse res)
                        throws ServletException, IOException {
index 31d5b2f8c5d4051176d29ea677c7138bea9f41a0..ff648aaebf97b84fec0677a7c690d4cfd197b6d9 100644 (file)
@@ -38,13 +38,16 @@ public class FileLfsRepository implements LargeFileRepository {
        private final Path dir;
 
        /**
-        * <p>Constructor for FileLfsRepository.</p>
+        * <p>
+        * Constructor for FileLfsRepository.
+        * </p>
         *
         * @param url
         *            external URL of this repository
         * @param dir
         *            storage directory
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public FileLfsRepository(String url, Path dir) throws IOException {
                this.url = url;
@@ -52,26 +55,22 @@ public class FileLfsRepository implements LargeFileRepository {
                Files.createDirectories(dir);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Response.Action getDownloadAction(AnyLongObjectId id) {
                return getAction(id);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Action getUploadAction(AnyLongObjectId id, long size) {
                return getAction(id);
        }
 
-       /** {@inheritDoc} */
        @Override
        @Nullable
        public Action getVerifyAction(AnyLongObjectId id) {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getSize(AnyLongObjectId id) throws IOException {
                Path p = getPath(id);
@@ -148,6 +147,8 @@ public class FileLfsRepository implements LargeFileRepository {
        }
 
        /**
+        * Get URL of content server
+        *
         * @return the url of the content server
         * @since 4.11
         */
@@ -156,6 +157,8 @@ public class FileLfsRepository implements LargeFileRepository {
        }
 
        /**
+        * Set the URL of the content server
+        *
         * @param url
         *            the url of the content server
         * @since 4.11
index d42701125eefc05e6d442d93ba695860c56a6c12..2ea92da82b5a6284b7a19fb2a826a8a91d7eb5e7 100644 (file)
@@ -50,7 +50,9 @@ public class ObjectDownloadListener implements WriteListener {
        private ByteBuffer buffer = ByteBuffer.allocateDirect(8192);
 
        /**
-        * <p>Constructor for ObjectDownloadListener.</p>
+        * <p>
+        * Constructor for ObjectDownloadListener.
+        * </p>
         *
         * @param repository
         *            the repository storing large objects
@@ -61,6 +63,7 @@ public class ObjectDownloadListener implements WriteListener {
         * @param id
         *            id of the object to be downloaded
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public ObjectDownloadListener(FileLfsRepository repository,
                        AsyncContext context, HttpServletResponse response,
index f5212fe25999419586f25c37b639b9de89a1fd18..1ac2b2072a73a038b3f73a09fce943f8bab9f7e3 100644 (file)
@@ -92,7 +92,9 @@ public class ObjectUploadListener implements ReadListener {
         * @param id
         *            a {@link org.eclipse.jgit.lfs.lib.AnyLongObjectId} object.
         * @throws java.io.FileNotFoundException
+        *             if file wasn't found
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public ObjectUploadListener(FileLfsRepository repository,
                        AsyncContext context, HttpServletRequest request,
@@ -146,7 +148,6 @@ public class ObjectUploadListener implements ReadListener {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void onAllDataRead() throws IOException {
                close();
@@ -156,6 +157,7 @@ public class ObjectUploadListener implements ReadListener {
         * Close resources held by this listener
         *
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected void close() throws IOException {
                try {
@@ -174,7 +176,6 @@ public class ObjectUploadListener implements ReadListener {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void onError(Throwable e) {
                try {
index c7c7a7146b5c1ca4ae0d115e3e3159cc192b2ece..3c98d7b9e5bf4a4791f31ab4961739041ee6cfc2 100644 (file)
@@ -58,7 +58,6 @@ public class S3Repository implements LargeFileRepository {
                this.s3Config = config;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Response.Action getDownloadAction(AnyLongObjectId oid) {
                URL endpointUrl = getObjectUrl(oid);
@@ -75,7 +74,6 @@ public class S3Repository implements LargeFileRepository {
                return a;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Response.Action getUploadAction(AnyLongObjectId oid, long size) {
                cacheObjectMetaData(oid, size);
@@ -95,13 +93,11 @@ public class S3Repository implements LargeFileRepository {
                return a;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Action getVerifyAction(AnyLongObjectId id) {
                return null; // TODO(ms) implement this
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getSize(AnyLongObjectId oid) throws IOException {
                URL endpointUrl = getObjectUrl(oid);
index 0857bc15f2983842faf9d7097b69104b3ffcbe7c..3a92f0c4346a8005f52f3189e2aa1a6f4266755b 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index f0526ff8a27d3bd13ccbcc0bbc1d8d9db8c05e92..13b74dff7dfa5aeeee86f4537ac64b228de77117 100644 (file)
@@ -95,7 +95,6 @@ public class CleanFilter extends FilterCommand {
                this.aOut = new AtomicObjectOutputStream(tmpFile.toAbsolutePath());
        }
 
-       /** {@inheritDoc} */
        @Override
        public int run() throws IOException {
                try {
index 0a8a3faec355b440c7b51fab22070eb49b0e44a6..afe963640d0fba64425d0144c79dbbd7284adbc5 100644 (file)
@@ -136,6 +136,7 @@ public class LfsPointer implements Comparable<LfsPointer> {
         * @return an {@link org.eclipse.jgit.lfs.LfsPointer} or {@code null} if the
         *         stream was not parseable as LfsPointer
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        @Nullable
        public static LfsPointer parseLfsPointer(InputStream in)
@@ -264,7 +265,6 @@ public class LfsPointer implements Comparable<LfsPointer> {
                return VERSION.equals(rest) || VERSION_LEGACY.equals(rest);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "LfsPointer: oid=" + oid.name() + ", size=" //$NON-NLS-1$ //$NON-NLS-2$
index c26a1bfbb3dd50f8b0365f8964a727e7615e6b60..b6515b92e15df8340d3bc10623bcb4a16eb250c8 100644 (file)
@@ -127,6 +127,7 @@ public class SmudgeFilter extends FilterCommand {
         *            the objects to download
         * @return the paths of all mediafiles which have been downloaded
         * @throws IOException
+        *             if an IO error occurred
         * @since 4.11
         */
        public static Collection<Path> downloadLfsResource(Lfs lfs, Repository db,
@@ -217,7 +218,6 @@ public class SmudgeFilter extends FilterCommand {
                return downloadedPaths;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int run() throws IOException {
                try {
index 3f1f0acac4844397f0be7020973718777991ae74..009250294ef62ecfa73596e9669cb82d92e01bb9 100644 (file)
@@ -45,6 +45,7 @@ public class AtomicObjectOutputStream extends OutputStream {
         * @param id
         *            a {@link org.eclipse.jgit.lfs.lib.AnyLongObjectId} object.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public AtomicObjectOutputStream(Path path, AnyLongObjectId id)
                        throws IOException {
@@ -61,6 +62,7 @@ public class AtomicObjectOutputStream extends OutputStream {
         * @param path
         *            a {@link java.nio.file.Path} object.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public AtomicObjectOutputStream(Path path) throws IOException {
                this(path, null);
@@ -78,25 +80,21 @@ public class AtomicObjectOutputStream extends OutputStream {
                return id;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                out.write(b);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b) throws IOException {
                out.write(b);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b, int off, int len) throws IOException {
                out.write(b, off, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                out.close();
index 857ccbe0566b23efd3d6cbb11bf2e7447f3969a2..0469337b1ff761508672ffca2e14dcca477d0d31 100644 (file)
@@ -70,6 +70,7 @@ public class LfsConfig {
         *
         * @return the delegate {@link Config}
         * @throws IOException
+        *             if an IO error occurred
         */
        private Config getDelegate() throws IOException {
                if (delegate == null) {
@@ -86,6 +87,7 @@ public class LfsConfig {
         * @return The loaded lfs config
         *
         * @throws IOException
+        *             if an IO error occurred
         */
        private Config load() throws IOException {
                Config result = null;
@@ -114,6 +116,7 @@ public class LfsConfig {
         *
         * @return the config, or <code>null</code>
         * @throws IOException
+        *             if an IO error occurred
         */
        @Nullable
        private Config loadFromWorkingTree()
@@ -139,6 +142,7 @@ public class LfsConfig {
         *
         * @return the config, or <code>null</code> if the entry does not exist
         * @throws IOException
+        *             if an IO error occurred
         */
        @Nullable
        private Config loadFromIndex()
@@ -162,6 +166,7 @@ public class LfsConfig {
         *
         * @return the config, or <code>null</code> if the file does not exist
         * @throws IOException
+        *             if an IO error occurred
         */
        @Nullable
        private Config loadFromHead() throws IOException {
@@ -207,6 +212,7 @@ public class LfsConfig {
         *            the key name
         * @return a String value from the config, <code>null</code> if not found
         * @throws IOException
+        *             if an IO error occurred
         */
        @Nullable
        public String getString(final String section, final String subsection,
index 12b688d157738f23c59c308c857e951a852e5bce..f9c623d8b7df4e6832be63e632a33da51a5f6327 100644 (file)
@@ -67,6 +67,7 @@ public class LfsConnectionFactory {
         * @return the connection for the lfs server. e.g.
         *         "https://github.com/github/git-lfs.git/info/lfs"
         * @throws IOException
+        *             if an IO error occurred
         */
        public static HttpConnection getLfsConnection(Repository db, String method,
                        String purpose) throws IOException {
@@ -287,6 +288,7 @@ public class LfsConnectionFactory {
                 * no timeout can be determined, the token will be used only once.
                 *
                 * @param action
+                *            action with an additional expiration timestamp
                 */
                public AuthCache(Protocol.ExpiringAction action) {
                        this.cachedAction = action;
index 9016e53940bc9193c005861bba41c60e7b606d41..7ae805c33fa0a4b84d3c290500cf9312984fa6cd 100644 (file)
@@ -314,13 +314,11 @@ public final class AbbreviatedLongObjectId implements Serializable {
                return mask(nibbles, word, v);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return (int) (w1 >> 32);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object o) {
                if (o instanceof AbbreviatedLongObjectId) {
@@ -355,7 +353,6 @@ public final class AbbreviatedLongObjectId implements Serializable {
                return new String(b, 0, nibbles);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index d866db4a2d7f408e7aec9703b0852a9fd7b8d541..75d500ef2064993e65b1c12c2ef2f7a048fb41a1 100644 (file)
@@ -249,7 +249,6 @@ public abstract class AnyLongObjectId implements Comparable<AnyLongObjectId> {
                return abbr.prefixCompare(this) == 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final int hashCode() {
                return (int) (w1 >> 32);
@@ -267,7 +266,6 @@ public abstract class AnyLongObjectId implements Comparable<AnyLongObjectId> {
                return other != null ? equals(this, other) : false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean equals(Object o) {
                if (o instanceof AnyLongObjectId) {
@@ -475,7 +473,6 @@ public abstract class AnyLongObjectId implements Comparable<AnyLongObjectId> {
                        dst[o--] = '0';
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 99bae49abbefbc1d1fc95f92b1567d3646018192..75798ca0f1651f7293ef7b56ee0d24a5266a69d1 100644 (file)
@@ -41,7 +41,6 @@ public class LfsPointerFilter extends TreeFilter {
                return pointer;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk walk) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
@@ -63,13 +62,11 @@ public class LfsPointerFilter extends TreeFilter {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter clone() {
                return new LfsPointerFilter();
index 15b3ca4c62c7a1a02fa3fad2928de00f293184fe..3959115462025426db599b5a7646f96a53e804e3 100644 (file)
@@ -256,7 +256,6 @@ public class LongObjectId extends AnyLongObjectId implements Serializable {
                w4 = src.w4;
        }
 
-       /** {@inheritDoc} */
        @Override
        public LongObjectId toObjectId() {
                return this;
index 012e4ae915ec510e4b939601820fd7a367e88163..5397d8135cc88667469dabad503fb931d47b31f6 100644 (file)
@@ -221,7 +221,6 @@ public class MutableLongObjectId extends AnyLongObjectId {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public LongObjectId toObjectId() {
                return new LongObjectId(this);
index 2abe9529d324e4f4bac31f77f60da3f4452cc153..b27b6c3c7d54a1497d829f0090e455e387089dba 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 681cf5d626bea449a2d4551a941cdf93244c005a..201fa3d22dbe4645c988984de0b649031143381b 100644 (file)
@@ -38,7 +38,6 @@ public class ConsoleAuthenticator extends CachedAuthenticator {
 
        private final Console cons = System.console();
 
-       /** {@inheritDoc} */
        @Override
        protected PasswordAuthentication promptPasswordAuthentication() {
                final String realm = formatRealm();
index 63ce838f0b98ee74bb111773f1704f30990d4ba0..5bdfc7bb518b2a41efa1a6e72a784f9f631e8b88 100644 (file)
@@ -43,13 +43,11 @@ public class ConsoleCredentialsProvider extends CredentialsProvider {
 
        private final Console cons = System.console();
 
-       /** {@inheritDoc} */
        @Override
        public boolean isInteractive() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean supports(CredentialItem... items) {
                for (CredentialItem i : items) {
@@ -71,7 +69,6 @@ public class ConsoleCredentialsProvider extends CredentialsProvider {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean get(URIish uri, CredentialItem... items)
                        throws UnsupportedCredentialItem {
index ff0b55d1b8973b3a8da32333f14258dd0de20908..2ebab5e5d2f7b40589ec355b1742872a542ea143 100644 (file)
@@ -31,7 +31,6 @@ class Add extends TextBuiltin {
        @Argument(required = true, metaVar = "metaVar_filepattern", usage = "usage_filesToAddContentFrom")
        private List<String> filepatterns = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                try (Git git = new Git(db)) {
index 0acad86f4053daa8e67fa7190e1b4bf0fd3b8a70..9c0915c6310145c861012835cd4eb30422fb5fdb 100644 (file)
@@ -42,13 +42,11 @@ class AmazonS3Client extends TextBuiltin {
        @Argument(index = 3, metaVar = "metaVar_KEY", required = true)
        private String key;
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                final AmazonS3 s3 = new AmazonS3(properties());
index 4028105b8705ddf83bbdd62f4d66680163e5233b..f98f8cb728d153c89e1921290481c3d3213ded6a 100644 (file)
@@ -41,7 +41,6 @@ class Archive extends TextBuiltin {
        @Option(name = "--output", aliases = { "-o" }, metaVar = "metaVar_file", usage = "usage_archiveOutput")
        private String output;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                if (tree == null)
index 1a3a2f6f4b07968950d0a49939df1bebd19685d6..93d02c196c749835af8684741b8204508e5d918a 100644 (file)
@@ -104,7 +104,6 @@ class Blame extends TextBuiltin {
        /** Used to get a current time stamp for lines without commit. */
        private final PersonIdent dummyDate = new PersonIdent("", ""); //$NON-NLS-1$ //$NON-NLS-2$
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                if (file == null) {
index 27668b5378499a26e2acfbd206210f79773fcdd5..e680394a79b24d3339ade267f746282f8b69dadb 100644 (file)
@@ -148,7 +148,6 @@ class Branch extends TextBuiltin {
 
        private int maxNameLength;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try {
index 98724bfceb2f248bf83f32b8901405841f6af20a..229d54d44fccc8b46edbc93e8a2478939abe9023 100644 (file)
@@ -51,7 +51,6 @@ class Checkout extends TextBuiltin {
        @Option(name = "--", metaVar = "metaVar_paths", handler = RestOfArgumentsHandler.class)
        private List<String> paths = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                if (createBranch) {
index 6db73e632d77e616d4b77ba107f6ea68a1648026..348f2e7dbbff5196a8da46f6a5a4daf46d5aa242 100644 (file)
@@ -32,7 +32,6 @@ class Clean extends TextBuiltin {
        @Option(name = "--dryRun", aliases = { "-n" })
        private boolean dryRun = false;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
index 9f9fa8fe9965c9bf7ddc03bcf5db0f1853c71fb8..1efba55f052112fc3b60de6c3a6e199c760e3da3 100644 (file)
@@ -72,13 +72,11 @@ class Clone extends AbstractFetchCommand implements CloneCommand.Callback {
        @Argument(index = 1, metaVar = "metaVar_directory")
        private String localName;
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                if (localName != null && gitdir != null)
@@ -148,7 +146,6 @@ class Clone extends AbstractFetchCommand implements CloneCommand.Callback {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void initializedSubmodules(Collection<String> submodules) {
                try {
@@ -162,7 +159,6 @@ class Clone extends AbstractFetchCommand implements CloneCommand.Callback {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void cloningSubmodule(String path) {
                try {
@@ -174,7 +170,6 @@ class Clone extends AbstractFetchCommand implements CloneCommand.Callback {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void checkingOut(AnyObjectId commit, String path) {
                try {
index 7a197a75a569e86909c35ecea46f1068c69c1af1..fb5a8fffc1f951e630b3a1b93def350e71a0f5b5 100644 (file)
@@ -141,7 +141,6 @@ public class CommandRef {
                return r;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index b0713f782cbbff25719bccc28cff1fa74e0f2a9c..8df028d2e25a1e2e98d1f043e9bc9d6aebde1d93 100644 (file)
@@ -84,7 +84,6 @@ class Commit extends TextBuiltin {
        @Argument(metaVar = "metaVar_commitPaths", usage = "usage_CommitPaths")
        private List<String> paths = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
index 979c6fa9458ee98b7618814e12d843d6ef39788c..52f40c2957ba67b013861ed56961d1bbb50e4f80 100644 (file)
@@ -68,7 +68,6 @@ class Config extends TextBuiltin {
        @Option(name = "--file", aliases = { "-f" }, metaVar = "metaVar_file", usage = "usage_configFile")
        private File configFile;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                if (!list) {
index 47e4b6ba79366ee4614766a0fbe8cb7c9feb241f..06e37da8412c20fa72023d8afbf78be362767482 100644 (file)
@@ -28,7 +28,6 @@ class ConvertRefStorage extends TextBuiltin {
                        "-r" }, usage = "usage_convertRefStorageRefLogs")
        private boolean writeLogs = true;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                ((FileRepository) db).convertRefStorage(format, writeLogs, backup);
index f987f2c80635d380f24d1726f1adb1130496737a..ec201a55ef22011c463a596dfed85a27a3ecdc04 100644 (file)
@@ -64,13 +64,11 @@ class Daemon extends TextBuiltin {
        @Argument(required = true, metaVar = "metaVar_directory", usage = "usage_directoriesToExport")
        List<File> directory = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                PackConfig packConfig = new PackConfig();
index 116db037d4cd4beb2b234b464a5f7613abd12bee..913d7c790d66414cbf0691e0cd70adfb753935e2 100644 (file)
@@ -47,7 +47,6 @@ class Describe extends TextBuiltin {
        @Option(name = "--abbrev", usage = "usage_Abbrev")
        private Integer abbrev;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
index 3152c4455422c97346675b6e6591ba4ffd7d59fe..61979d1695fef7c48dbafaad8be6e3b25799d662 100644 (file)
@@ -155,14 +155,12 @@ class Diff extends TextBuiltin {
 
        // END -- Options shared with Log
 
-       /** {@inheritDoc} */
        @Override
        protected void init(Repository repository, String gitDir) {
                super.init(repository, gitDir);
                diffFmt = new DiffFormatter(new BufferedOutputStream(outs));
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                diffFmt.setRepository(db);
index 9aaf3f5c5a6bb351ad0a8523e8aca4dfb99a15dd..352ffde26c38864913a125d39b969e09c6470d10 100644 (file)
@@ -40,7 +40,6 @@ class DiffTree extends TextBuiltin {
        @Option(name = "--", metaVar = "metaVar_path", handler = PathTreeFilterHandler.class)
        private TreeFilter pathFilter = TreeFilter.ALL;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (TreeWalk walk = new TreeWalk(db)) {
index 2e0c36b287d168c00e69a44f1b4f9dd177246d09..7a007e3b584d50761c00356c8ec07dd39290287e 100644 (file)
@@ -113,7 +113,6 @@ class Fetch extends AbstractFetchCommand implements FetchCommand.Callback {
        @Argument(index = 1, metaVar = "metaVar_refspec")
        private List<RefSpec> toget;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
@@ -167,7 +166,6 @@ class Fetch extends AbstractFetchCommand implements FetchCommand.Callback {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void fetchingSubmodule(String name) {
                try {
index c87f0b6dcf641cd82468284b5e5ea8ae8c48d777..2796b9115ff94170fa37aad75a5ad0ab92c6297e 100644 (file)
@@ -27,7 +27,6 @@ class Gc extends TextBuiltin {
        @Option(name = "--prune-preserved", usage = "usage_PrunePreserved")
        private Boolean prunePreserved;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                Git git = Git.wrap(db);
index 53180189282635e556d0d92161f5b653dc74714a..ce687c463978b5525fe79f9becf94226cc8df625 100644 (file)
@@ -65,7 +65,6 @@ class Glog extends RevWalkTextBuiltin {
                frame.getContentPane().add(world);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected int walkLoop() throws Exception {
                graphPane.getCommitList().source(walk);
@@ -77,13 +76,11 @@ class Glog extends RevWalkTextBuiltin {
                return graphPane.getCommitList().size();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void show(RevCommit c) throws Exception {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected RevWalk createWalk() {
                if (objects)
index 9732335130b0436e3ae4275fe05e7ba0b39ed415..b3808d6fda26cd8b05eae7812bbb59c5752c2dbd 100644 (file)
@@ -28,7 +28,6 @@ class IndexPack extends TextBuiltin {
        @Option(name = "--index-version", usage = "usage_indexFileFormatToCreate")
        private int indexVersion = -1;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                BufferedInputStream in = new BufferedInputStream(ins);
index 7a0d96d4190699ec93021a5448ba3b30f68b2054..9c4af813a4012c7894ddcb6726bd2e1eb3c1645d 100644 (file)
@@ -40,13 +40,11 @@ class Init extends TextBuiltin {
        @Argument(index = 0, metaVar = "metaVar_directory")
        private String directory;
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                InitCommand command = Git.init();
index d693051738c121687fe6751ae094950d3203f365..852a4b377bbe7e5010bbe0d53c423f03babc6789 100644 (file)
@@ -182,14 +182,12 @@ class Log extends RevWalkTextBuiltin {
                dateFormatter = new GitDateFormatter(Format.DEFAULT);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void init(Repository repository, String gitDir) {
                super.init(repository, gitDir);
                diffFmt = new DiffFormatter(new BufferedOutputStream(outs));
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                config = new GpgConfig(db.getConfig());
@@ -244,7 +242,6 @@ class Log extends RevWalkTextBuiltin {
                                NoteMap.read(argWalk.getObjectReader(), notesCommit));
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void show(RevCommit c) throws Exception {
                outw.print(CLIText.get().commitLabel);
@@ -314,10 +311,14 @@ class Log extends RevWalkTextBuiltin {
        }
 
        /**
+        * Show notes for given commit
+        *
         * @param c
+        *            given commit
         * @return <code>true</code> if at least one note was printed,
         *         <code>false</code> otherwise
         * @throws IOException
+        *             if an IO error occurred
         */
        private boolean showNotes(RevCommit c) throws IOException {
                if (noteMaps == null)
@@ -344,12 +345,17 @@ class Log extends RevWalkTextBuiltin {
 
        /**
         * @param c
+        *            given commit
         * @param map
+        *            note map
         * @param label
+        *            label
         * @param emptyLine
+        *            whether to start with an empty line
         * @return <code>true</code> if note was printed, <code>false</code>
         *         otherwise
         * @throws IOException
+        *             if an IO error occurred
         */
        private boolean showNotes(RevCommit c, NoteMap map, String label,
                        boolean emptyLine)
index 83446ccd533cab3193574c789a1d4ddcacac2714..89ceed256d7feb2d2552c2fe5fe9af3a6158d5b1 100644 (file)
@@ -40,7 +40,6 @@ class LsRemote extends TextBuiltin {
        @Argument(index = 0, metaVar = "metaVar_uriish", required = true)
        private String remote;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                LsRemoteCommand command = Git.lsRemoteRepository().setRemote(remote)
@@ -63,7 +62,6 @@ class LsRemote extends TextBuiltin {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean requiresRepository() {
                return false;
index bb140018bd340bc639c77a27b603619fdadca912..34b48c1b1ad62cb86846c9cf21cfb5475e525dc4 100644 (file)
@@ -38,7 +38,6 @@ class LsTree extends TextBuiltin {
        @Option(name = "--", metaVar = "metaVar_paths", handler = StopOptionHandler.class)
        private List<String> paths = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (TreeWalk walk = new TreeWalk(db)) {
index 613fc5ff325f8ace8366367a33c89eeacb1faab7..d059eff5d72623bd8ec55a2702322c8019b45558 100644 (file)
@@ -97,6 +97,7 @@ public class Main {
         * @param argv
         *            arguments.
         * @throws java.lang.Exception
+        *             if an error occurred
         */
        public static void main(String[] argv) throws Exception {
                // make sure built-in filters are registered
@@ -121,6 +122,7 @@ public class Main {
         * @param argv
         *            arguments.
         * @throws java.lang.Exception
+        *             if an error occurred
         */
        protected void run(String[] argv) throws Exception {
                writer = createErrorWriter();
@@ -263,9 +265,11 @@ public class Main {
 
        /**
         * @param status
+        *            exit status code, nonzero value indicates an error
         * @param t
         *            can be {@code null}
         * @throws Exception
+        *             if an IO error occurred
         */
        void exit(int status, Exception t) throws Exception {
                writer.flush();
index 27a3d90fad8ff1ff862bb44e22997d474dfa9580..b78998dd74341d883d00fda4a8a5ff380bb90e08 100644 (file)
@@ -86,7 +86,6 @@ class Merge extends TextBuiltin {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                if (squash && ff == FastForwardMode.NO_FF) {
index 68eeff748dc84854b408b025ad5858f24aa247fd..aacde2f430f3d03a6ad1f8c5088ec272c507a21c 100644 (file)
@@ -33,7 +33,6 @@ class MergeBase extends TextBuiltin {
        @Argument(index = 1, metaVar = "metaVar_commitish", required = true)
        private List<RevCommit> commits = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try {
index f2e3a16008328b96dacdb59c798841620f6cf351..6535d95e9a6e4e539fd52084c358fa3dea85864c 100644 (file)
@@ -81,7 +81,6 @@ class Push extends TextBuiltin {
 
        private boolean shownURI;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
index f570f7f99bda72d7324c11a3f777354865c9d693..f89a4d12bed3c39d5a58ce82eb3234d291406633 100644 (file)
@@ -26,13 +26,11 @@ class ReceivePack extends TextBuiltin {
        @Argument(index = 0, required = true, metaVar = "metaVar_directory", usage = "usage_RepositoryToReceiveInto")
        File dstGitdir;
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                final org.eclipse.jgit.transport.ReceivePack rp;
index c63532df60da1f6bfca44c3669180313eb5452c2..46485cc5efaf34e955387ed286bd9750ff9e4d20 100644 (file)
@@ -28,7 +28,6 @@ class Reflog extends TextBuiltin {
        @Argument(metaVar = "metaVar_ref")
        private String ref;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
index 6d6feed7b8c1ae19d234366721d3bc003037097e..a3100ac8ed971e834a5e08fc339fa5a75cb5da06 100644 (file)
@@ -52,7 +52,6 @@ class Remote extends TextBuiltin {
        @Argument(index = 2, metaVar = "metaVar_uriish")
        private String uri;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
@@ -114,7 +113,6 @@ class Remote extends TextBuiltin {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void printUsage(String message, CmdLineParser clp)
                        throws IOException {
index 0588a7cdbe2644e6924f8d18abfad108fa61f8db..da622e11305a58d489b44ebcdf916d48703789f0 100644 (file)
@@ -26,7 +26,6 @@ class Repo extends TextBuiltin {
        @Argument(required = true, metaVar = "metaVar_path", usage = "usage_pathToXml")
        private String path;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try {
index 3454cf25151491660faa4d807f508961d197395b..f33cb6be7107a781bbe7a352b4cb5778b2153261 100644 (file)
@@ -41,7 +41,6 @@ class Reset extends TextBuiltin {
        @Option(name = "--", metaVar = "metaVar_paths", handler = RestOfArgumentsHandler.class)
        private List<String> paths = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
index e86ad01823bca6bf8e4b2ea2d76e08e8218de956..59fc5f296c42fae3bb11502b9098e9e7c66902f5 100644 (file)
@@ -18,7 +18,6 @@ import org.eclipse.jgit.revwalk.RevTree;
 
 @Command(usage = "usage_RevList")
 class RevList extends RevWalkTextBuiltin {
-       /** {@inheritDoc} */
        @Override
        protected void show(RevCommit c) throws Exception {
                if (c.has(RevFlag.UNINTERESTING))
@@ -32,7 +31,6 @@ class RevList extends RevWalkTextBuiltin {
                outw.println();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void show(ObjectWalk ow, RevObject obj)
                        throws Exception {
index 9e4d1c9dd531cc6195b2225f81420afb88b6db1d..b1fb07b5b85b6a8e1e381128d67fcb523b996dca 100644 (file)
@@ -35,7 +35,6 @@ class RevParse extends TextBuiltin {
        @Argument(index = 0, metaVar = "metaVar_commitish")
        private List<ObjectId> commits = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try {
index 696a924ecf16a38dd47b6c1333d1cbb3d702795e..51e597c57affce2db2d95b3f64357bcfd6db365c 100644 (file)
@@ -114,7 +114,6 @@ abstract class RevWalkTextBuiltin extends TextBuiltin {
        @Option(name = "--max-count", aliases = "-n", metaVar = "metaVar_n")
        private int maxCount = -1;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                walk = createWalk();
@@ -228,7 +227,8 @@ abstract class RevWalkTextBuiltin extends TextBuiltin {
         *
         * @param c
         *            The current {@link org.eclipse.jgit.revwalk.RevCommit}
-        * @throws java.lang.Exception
+        * @throws Exception
+        *             if an error occurred
         */
        protected abstract void show(RevCommit c) throws Exception;
 
@@ -243,7 +243,8 @@ abstract class RevWalkTextBuiltin extends TextBuiltin {
         *            {@link #walkLoop()}
         * @param currentObject
         *            The current {@link org.eclipse.jgit.revwalk.RevObject}
-        * @throws java.lang.Exception
+        * @throws Exception
+        *             if an error occurred
         */
        protected void show(final ObjectWalk objectWalk,
                        final RevObject currentObject) throws Exception {
index 4a337983eb13654d6d5e53de7ad75b42d672410a..234da1a1c52885f179b9a05f0d28887b009f6f25 100644 (file)
@@ -27,7 +27,6 @@ class Rm extends TextBuiltin {
        @Option(name = "--", handler = StopOptionHandler.class)
        private List<String> paths = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
index c18d35a205fb5724ca369107e77a3b256191d71f..4feb090032a9c43125412093177ebfb69063b3ce 100644 (file)
@@ -161,14 +161,12 @@ class Show extends TextBuiltin {
                fmt = new SimpleDateFormat("EEE MMM dd HH:mm:ss yyyy ZZZZZ", Locale.US); //$NON-NLS-1$
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void init(Repository repository, String gitDir) {
                super.init(repository, gitDir);
                diffFmt = new DiffFormatter(new BufferedOutputStream(outs));
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("boxing")
        @Override
        protected void run() {
index a58785fef3d5d2d863b538627c6e4ac0ef59370e..64b182e17d651622f4df96217c13051c8e1fcf10 100644 (file)
@@ -21,7 +21,6 @@ import org.eclipse.jgit.lib.RefComparator;
 
 @Command(usage = "usage_ShowRef")
 class ShowRef extends TextBuiltin {
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try {
index 141de0cd5dceeedf66909bb8c3fc9e516a1c2a7b..1ef39a1a7d485f8e88064dd64558b7485621dbe2 100644 (file)
@@ -55,7 +55,6 @@ class Status extends TextBuiltin {
        @Option(name = "--", metaVar = "metaVar_paths", handler = RestOfArgumentsHandler.class)
        protected List<String> filterPaths;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
@@ -239,10 +238,11 @@ class Status extends TextBuiltin {
         * Print section header
         *
         * @param pattern
-        *            a {@link java.lang.String} object.
+        *            a {@link String} object.
         * @param arguments
-        *            a {@link java.lang.Object} object.
-        * @throws java.io.IOException
+        *            a {@link Object} object.
+        * @throws IOException
+        *             if an IO error occurred
         */
        protected void printSectionHeader(String pattern, Object... arguments)
                        throws IOException {
@@ -259,9 +259,10 @@ class Status extends TextBuiltin {
         * Print String list
         *
         * @param list
-        *            a {@link java.util.Collection} object.
-        * @return a int.
-        * @throws java.io.IOException
+        *            a {@link Collection} object.
+        * @return size of the list
+        * @throws IOException
+        *             if an IO error occurred
         */
        protected int printList(Collection<String> list) throws IOException {
                if (!list.isEmpty()) {
@@ -281,21 +282,22 @@ class Status extends TextBuiltin {
         * Print String list
         *
         * @param status1
-        *            a {@link java.lang.String} object.
+        *            a {@link String} object.
         * @param status2
-        *            a {@link java.lang.String} object.
+        *            a {@link String} object.
         * @param status3
-        *            a {@link java.lang.String} object.
+        *            a {@link String} object.
         * @param list
-        *            a {@link java.util.Collection} object.
+        *            a {@link Collection} object.
         * @param set1
-        *            a {@link java.util.Collection} object.
+        *            a {@link Collection} object.
         * @param set2
-        *            a {@link java.util.Collection} object.
+        *            a {@link Collection} object.
         * @param set3
-        *            a {@link java.util.Collection} object.
+        *            a {@link Collection} object.
         * @return a int.
-        * @throws java.io.IOException
+        * @throws IOException
+        *             if an IO error occurred
         */
        protected int printList(String status1, String status2, String status3,
                        Collection<String> list, Collection<String> set1,
index 0603de18ac925e2a162c37129fec01d9319a7086..4ea67ab92c729961a7a241c8424fee0f2f9bef6f 100644 (file)
@@ -88,7 +88,6 @@ class Tag extends TextBuiltin {
        @Argument(index = 1, metaVar = "metaVar_object")
        private ObjectId object;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try (Git git = new Git(db)) {
index 6cfe93d850f9a98952839e12234eaf10f784bf6f..c572e3bc7d7a8a672c6aa87382857881cecf6243 100644 (file)
@@ -249,6 +249,7 @@ public abstract class TextBuiltin {
         * @param args
         *            the arguments supplied on the command line, if any.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected void parseArguments(String[] args) throws IOException {
                final CmdLineParser clp = new CmdLineParser(this);
@@ -277,6 +278,7 @@ public abstract class TextBuiltin {
         * @param clp
         *            a {@link org.eclipse.jgit.pgm.opt.CmdLineParser} object.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void printUsageAndExit(CmdLineParser clp) throws IOException {
                printUsageAndExit("", clp); //$NON-NLS-1$
@@ -290,6 +292,7 @@ public abstract class TextBuiltin {
         * @param clp
         *            a {@link org.eclipse.jgit.pgm.opt.CmdLineParser} object.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void printUsageAndExit(String message, CmdLineParser clp) throws IOException {
                printUsage(message, clp);
@@ -304,6 +307,7 @@ public abstract class TextBuiltin {
         * @param clp
         *            parser used to print options
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        protected void printUsage(String message, CmdLineParser clp)
index ac51643b6e6971444fe82ff58b2b928a24cf6074..db2c393b9ab99dcda8bb8b96420e180f44fc4d9e 100644 (file)
@@ -30,13 +30,11 @@ class UploadPack extends TextBuiltin {
        @Argument(index = 0, required = true, metaVar = "metaVar_directory", usage = "usage_RepositoryToReadFrom")
        File srcGitdir;
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                try {
index d06f1e2fbfb61bfcd0ee63cebbba751f7c3dabe6..8546094ac211010688cdcfa0899667afa4e9862d 100644 (file)
@@ -22,7 +22,6 @@ import org.eclipse.jgit.pgm.internal.CLIText;
 
 @Command(common = true, usage = "usage_DisplayTheVersionOfJgit")
 class Version extends TextBuiltin {
-       /** {@inheritDoc} */
        @Override
        protected void run() {
                // read the Implementation-Version from Manifest
@@ -48,7 +47,6 @@ class Version extends TextBuiltin {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean requiresRepository() {
                return false;
index f23f4cf0eaf00d0c4e1b5bb02ba9a23481507e73..f156b8cf4c63eafc6a2873e0c74a3ea34755c842 100644 (file)
@@ -70,7 +70,6 @@ class BenchmarkReftable extends TextBuiltin {
        @Argument(index = 1)
        private String reftablePath;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                switch (test) {
index a63387c24ca4a73e86931bfe7c2bd1113a32a2d8..67300dcc6a1a179b88987bea961328e40b03e06e 100644 (file)
@@ -96,13 +96,11 @@ class DiffAlgorithms extends TextBuiltin {
 
        private ThreadMXBean mxBean;
 
-       /** {@inheritDoc} */
        @Override
        protected boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                mxBean = ManagementFactory.getThreadMXBean();
index 9c0ced5c1eddd2565656cc0588ed01469f5bda8c..653530d11aca754d80c1186e7e6557341a90fb9d 100644 (file)
@@ -181,13 +181,11 @@ class LfsStore extends TextBuiltin {
 
        String secretKey;
 
-       /** {@inheritDoc} */
        @Override
        protected boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                AppServer server = new AppServer(port);
index 63897a38915d5144b3be0f1fa569de92d4d9bc00..51883368900cff5234fa78c5c1caa033d95c26b4 100644 (file)
@@ -24,7 +24,6 @@ import org.eclipse.jgit.pgm.internal.CLIText;
 
 @Command(usage = "usage_MakeCacheTree")
 class MakeCacheTree extends TextBuiltin {
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                final DirCache cache = db.readDirCache();
index 33d1059911e22007a6db81cb2a6de67a934ea887..6e0f915ff2aef04bff823f72da09118284138ad2 100644 (file)
@@ -21,7 +21,6 @@ import org.eclipse.jgit.pgm.internal.CLIText;
 
 @Command(usage = "usage_ReadDirCache")
 class ReadDirCache extends TextBuiltin {
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                final int cnt = 100;
index 6dace841ea61fef50eec7e0339a829259773d92a..a2443d315fecc75eed753049802522eeec3e4425 100644 (file)
@@ -30,7 +30,6 @@ class ReadReftable extends TextBuiltin {
        @Argument(index = 1, required = false)
        private String ref;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                try (FileInputStream in = new FileInputStream(input);
index 8d884c12db1f402b128cecd5be2e938aeaf7eec3..2f96ef7d57a5e0946f0ac01cff9d126d6735e7ad 100644 (file)
@@ -81,7 +81,6 @@ class RebuildCommitGraph extends TextBuiltin {
 
        private Map<ObjectId, ObjectId> rewrites = new HashMap<>();
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                if (!really && db.getRefDatabase().hasRefs()) {
index 28a8d8634a2aae1fb09a6ea27f647e8a412d01b1..057d20b8d670cbc6649a702fd89f16267b69f6cd 100644 (file)
@@ -24,7 +24,6 @@ import org.eclipse.jgit.pgm.internal.CLIText;
 
 @Command(usage = "usage_ShowCacheTree")
 class ShowCacheTree extends TextBuiltin {
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                final DirCache cache = db.readDirCache();
index 9e61357da8901f454299acb46d1bed0840210a16..daea1fbe83d075bb3a52f06e961009dd313e27ea 100644 (file)
@@ -26,7 +26,6 @@ class ShowCommands extends TextBuiltin {
        @Option(name = "--pretty", metaVar = "metaVar_commandDetail", usage = "usage_alterTheDetailShown")
        private Format pretty = Format.USAGE;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                final CommandRef[] list = CommandCatalog.all();
index 1f4733f792d37179fcc22bfdf321ee7ea04e2c2f..3633d880d73a95b9ca7ac9385133a8d7f5575edd 100644 (file)
@@ -33,7 +33,6 @@ class ShowDirCache extends TextBuiltin {
        @Option(name = "--millis", aliases = { "-m" }, usage = "usage_showTimeInMilliseconds")
        private boolean millis = false;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                final DateTimeFormatter fmt = DateTimeFormatter
index 49f7ada457f5809e1316cecbc9353cbf2942db92..c95f1384e883a12fb2c58d6c29cda30d142f1c8d 100644 (file)
@@ -39,7 +39,6 @@ class ShowPackDelta extends TextBuiltin {
        @Argument(index = 0)
        private ObjectId objectId;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                ObjectReader reader = db.newObjectReader();
index 1ca3034f4f166f0c83052a8511bc62837b4b7116..d7d31bd4b23e691a6d8e0e89bbd3d4c92e2953ce 100644 (file)
@@ -228,13 +228,11 @@ class TextHashFunctions extends TextBuiltin {
        @Option(name = "--repository", aliases = { "-r" }, metaVar = "GIT_DIR", usage = "Repository to scan")
        List<File> gitDirs = new ArrayList<>();
 
-       /** {@inheritDoc} */
        @Override
        protected boolean requiresRepository() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                if (gitDirs.isEmpty()) {
index 16a4c9f333341342df79164bd6ff958867f0627a..aa1b81f2b6a544cd458f90feca9ed67a9a9390aa 100644 (file)
@@ -42,7 +42,6 @@ class VerifyReftable extends TextBuiltin {
        @Argument(index = 1)
        private String reftablePath;
 
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                List<Ref> refs = WriteReftable.readRefs(lsRemotePath);
index 44836ec0dcf76b6e214cc254ab73b9c8eb718706..d367f024978e381711511f86d50313f795ef2b01 100644 (file)
@@ -18,7 +18,6 @@ import org.eclipse.jgit.pgm.internal.CLIText;
 
 @Command(usage = "usage_WriteDirCache")
 class WriteDirCache extends TextBuiltin {
-       /** {@inheritDoc} */
        @Override
        protected void run() throws Exception {
                final DirCache cache = db.readDirCache();
index 80d2f763f10b8b50fe145c6bc30226bc1a2c5b38..faa2bceb7490224515d82100c565e58d97df38a9 100644 (file)
@@ -71,7 +71,6 @@ class WriteReftable extends TextBuiltin {
        @Argument(index = 1)
        private String out;
 
-       /** {@inheritDoc} */
        @SuppressWarnings({ "nls", "boxing" })
        @Override
        protected void run() throws Exception {
index d8604726ab67a9c49fb34909e200e54a5350d47f..cea2309f7fd3c2f4075a6e8c11f4e657af6c20de 100644 (file)
@@ -63,7 +63,6 @@ public class AbstractTreeIteratorHandler extends
                clp = (org.eclipse.jgit.pgm.opt.CmdLineParser) parser;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                final String name = params.getParameter(0);
@@ -115,7 +114,6 @@ public class AbstractTreeIteratorHandler extends
                return 1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_treeish;
index df0b39b52a289f418225d8d4cebb59a3dfb094d2..463213dc4fb9ce328c5c866eb3c023030507df43 100644 (file)
@@ -110,7 +110,6 @@ public class CmdLineParser extends org.kohsuke.args4j.CmdLineParser {
                this.db = repo;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void parseArgument(String... args) throws CmdLineException {
                final ArrayList<String> tmp = new ArrayList<>(args.length);
@@ -265,7 +264,6 @@ public class CmdLineParser extends org.kohsuke.args4j.CmdLineParser {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected OptionHandler createOptionHandler(OptionDef o, Setter setter) {
                if (o instanceof NamedOptionDef) {
@@ -275,7 +273,6 @@ public class CmdLineParser extends org.kohsuke.args4j.CmdLineParser {
 
        }
 
-       /** {@inheritDoc} */
        @Override
        public void printSingleLineUsage(Writer w, ResourceBundle rb) {
                List<OptionHandler> options = getOptions();
index af90b83d17c7f5108e12aca72003d51123251acb..56423ada41a24b95d706bd697ded309af096fd31 100644 (file)
@@ -53,7 +53,6 @@ public class GpgSignHandler extends StringOptionHandler {
                super(parser, option, setter);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                String alias = params.getParameter(-1);
index feee78e9b6e1bf95d58602d2dfc1508eb6d42364..9c541698882e75f98e2a56d1f9cb0cf1013441f4 100644 (file)
@@ -44,7 +44,6 @@ public class InstantHandler extends OptionHandler<Instant> {
                super(parser, option, setter);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                Instant instant = Instant.parse(params.getParameter(0));
@@ -52,7 +51,6 @@ public class InstantHandler extends OptionHandler<Instant> {
                return 1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_instant;
index 6cd36c3d989aed3adbe3b2ea441ffeae35f82a17..b50df90788629b3af522f1137c67d55df95c11ce 100644 (file)
@@ -49,7 +49,6 @@ public class ObjectIdHandler extends OptionHandler<ObjectId> {
                clp = (org.eclipse.jgit.pgm.opt.CmdLineParser) parser;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                final String name = params.getParameter(0);
@@ -68,7 +67,6 @@ public class ObjectIdHandler extends OptionHandler<ObjectId> {
                                CLIText.format(CLIText.get().notAnObject), name);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_object;
index 7d7c8065072c6c68c46f93133efddf249f22d527..7bb2766fe0e886a585a55ce57060e66b00f509ce 100644 (file)
@@ -33,7 +33,6 @@ public class OptionWithValuesListHandler extends OptionHandler<List<?>> {
                super(parser, option, setter);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                final List<String> list = new ArrayList<>();
@@ -50,7 +49,6 @@ public class OptionWithValuesListHandler extends OptionHandler<List<?>> {
                return list.size();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_values;
index 653511947fa34c80a0eef1db3bc0f6d85bed6dbe..f215040499ef08720d5a59cbb95cc10dedf9c898 100644 (file)
@@ -49,7 +49,6 @@ public class PathTreeFilterHandler extends OptionHandler<TreeFilter> {
                super(parser, option, setter);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                final List<PathFilter> filters = new ArrayList<>();
@@ -73,7 +72,6 @@ public class PathTreeFilterHandler extends OptionHandler<TreeFilter> {
                return filters.size();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_paths;
index effa22a6974a4c15aa91b5bb50b7106ad06c2347..049144587994f263b2ec2ecdf0fe2fea80ac3f2d 100644 (file)
@@ -43,14 +43,12 @@ public class RefSpecHandler extends OptionHandler<RefSpec> {
                super(parser, option, setter);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                setter.addValue(new RefSpec(params.getParameter(0)));
                return 1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_refspec;
index 8b2bed36a76e881ffdc3ff4d138a550873ddb718..a095a28af8739ade66dc190999434ad9b287dc45 100644 (file)
@@ -53,7 +53,6 @@ public class RevCommitHandler extends OptionHandler<RevCommit> {
                clp = (org.eclipse.jgit.pgm.opt.CmdLineParser) parser;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                String name = params.getParameter(0);
@@ -116,7 +115,6 @@ public class RevCommitHandler extends OptionHandler<RevCommit> {
                setter.addValue(c);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_commitish;
index 357886d0fa107c8502f675a5d0728000d94bc325..08f1d2839234d723fa36ce7586187303fb65a8ac 100644 (file)
@@ -52,7 +52,6 @@ public class RevTreeHandler extends OptionHandler<RevTree> {
                clp = (org.eclipse.jgit.pgm.opt.CmdLineParser) parser;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                final String name = params.getParameter(0);
@@ -83,7 +82,6 @@ public class RevTreeHandler extends OptionHandler<RevTree> {
                return 1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_treeish;
index e0962031e82ba2cd9ecfcf3baea69b0665a54e0e..e71ba90e4b39dee09f648b36fd5a5704c5435641 100644 (file)
@@ -49,7 +49,6 @@ public class SubcommandHandler extends OptionHandler<TextBuiltin> {
                clp = (org.eclipse.jgit.pgm.opt.CmdLineParser) parser;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                final String name = params.getParameter(0);
@@ -67,7 +66,6 @@ public class SubcommandHandler extends OptionHandler<TextBuiltin> {
                return 1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getDefaultMetaVariable() {
                return CLIText.get().metaVar_command;
index 3562754a00fb342e552115aad4c731ffa1fd4aa6..2f99cff768951a9eb63fb3f6a70b6eebdad65cae 100644 (file)
@@ -52,7 +52,6 @@ public class UntrackedFilesHandler extends StringOptionHandler {
                super(parser, option, setter);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int parseArguments(Parameters params) throws CmdLineException {
                String alias = params.getParameter(-1);
index d1f54bbe65c24289e522dc34d1788648d2c197f8..d5c0e6c7e0e8c3e0fde785849f2237caf7467e3d 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 6f8153d00013d8d9ea99d2387d6359e6c2e69e59..54e4e2a5a8df33aef2324b2e560ba6188c165e19 100644 (file)
@@ -67,6 +67,7 @@ interface UnixSockets extends LibCAPI, Library {
         *            set it
         * @return -1 on error, otherwise a value >= 0
         * @throws LastErrorException
+        *             represents non-zero error code for the last error
         */
        int fcntl(int fd, int command, int flag) throws LastErrorException;
 
index d1f54bbe65c24289e522dc34d1788648d2c197f8..d5c0e6c7e0e8c3e0fde785849f2237caf7467e3d 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 5100bc9e544e846ffd40d35918024c478195a078..76175cc5b85e97132db344dcc9a1c98cc1419811 100644 (file)
@@ -88,8 +88,11 @@ public class JGitClientSession extends ClientSessionImpl {
 
        /**
         * @param manager
+        *            client factory manager
         * @param session
+        *            the session
         * @throws Exception
+        *             an error occurred
         */
        public JGitClientSession(ClientFactoryManager manager, IoSession session)
                        throws Exception {
index 7931c76c1915fd2ba972890b397963273731dc48..a00e5d96ac96adb77a24722d7fa945bfb9f36b0c 100644 (file)
@@ -34,9 +34,9 @@ import org.slf4j.LoggerFactory;
 
 /**
  * Apache MINA sshd 2.0.0 KnownHostEntry cannot read a host entry line like
- * "host:port ssh-rsa <key>"; it complains about an illegal character in the
- * host name (correct would be "[host]:port"). The default known_hosts reader
- * also aborts reading on the first error.
+ * "host:port ssh-rsa &lt;key&gt;"; it complains about an illegal character in
+ * the host name (correct would be "[host]:port"). The default known_hosts
+ * reader also aborts reading on the first error.
  * <p>
  * This reader is a bit more robust and tries to handle this case if there is
  * only one colon (otherwise it might be an IPv6 address (without port)), and it
index d8bf449acf028c6f104263564d77db2a26243c80..65ba5be0c5ac63b5ecdd66d23ef4ce35fbd8e374 100644 (file)
@@ -74,7 +74,6 @@ import org.slf4j.LoggerFactory;
  * ignored.
  * <p>
  * {@code StrictHostKeyChecking} accepts the following values:
- * </p>
  * <dl>
  * <dt>ask</dt>
  * <dd>Ask the user whether new or changed keys shall be accepted and be added
@@ -91,7 +90,6 @@ import org.slf4j.LoggerFactory;
  * <p>
  * If {@code StrictHostKeyChecking} is not set, or set to any other value, the
  * default value <b>ask</b> is active.
- * </p>
  * <p>
  * This implementation relies on the {@link ClientSession} being a
  * {@link JGitClientSession}. By default Apache MINA sshd does not forward the
@@ -100,23 +98,19 @@ import org.slf4j.LoggerFactory;
  * used. If used with some other session type, the implementation assumes
  * "<b>ask</b>".
  * <p>
- * <p>
  * Asking the user is done via a {@link CredentialsProvider} obtained from the
  * session. If none is set, the implementation falls back to strict host key
  * checking ("<b>yes</b>").
- * </p>
  * <p>
  * Note that adding a key to the known hosts file may create the file. You can
  * specify in the constructor whether the user shall be asked about that, too.
  * If the user declines updating the file, but the key was otherwise
  * accepted (user confirmed for "<b>ask</b>", or "no" or "accept-new" are
  * active), the key is accepted for this session only.
- * </p>
  * <p>
  * If several known hosts files are specified, a new key is always added to the
  * first file (even if it doesn't exist yet; see the note about file creation
  * above).
- * </p>
  *
  * @see <a href="http://man.openbsd.org/OpenBSD-current/man5/ssh_config.5">man
  *      ssh-config</a>
index 807bda89bc3441bad58a24b5cc5146dc97dcf413..23f46d8d6c15f93f370f7b59254f57644aeb84ae 100644 (file)
@@ -247,7 +247,9 @@ public class IdentityPasswordProvider implements KeyPasswordProvider {
         *            the attempt result - {@code null} for success
         * @return how to proceed in case of error
         * @throws IOException
+        *             if an IO error occurred
         * @throws GeneralSecurityException
+        *             something went wrong
         */
        protected boolean keyLoaded(URIish uri,
                        State state, char[] password, Exception err)
index ed9fe37d5cba0ba39b24255fb2d36f4419ecc06e..a80a5d166d4f315cf3646dfc3135ef0371e23dd4 100644 (file)
@@ -77,7 +77,9 @@ public interface KeyPasswordProvider {
         *         {@code error} exception; Ignored if the key was loaded
         *         successfully, i.e., if {@code error == null}.
         * @throws IOException
+        *             if an IO error occurred
         * @throws GeneralSecurityException
+        *             something went wrong
         */
        boolean keyLoaded(URIish uri, int attempt, Exception error)
                        throws IOException, GeneralSecurityException;
index 7798b80f18fda4baf7c9b6a4fb6ed3640224dbc3..a99847aa91607ecb425a4acfbe00309802e3e693 100644 (file)
@@ -471,6 +471,7 @@ public class SshdSessionFactory extends SshSessionFactory implements Closeable {
         * {@code UserKnownHostsFile} overrides this default.
         *
         * @param sshDir
+        *            directory containing ssh configurations
         * @return the possibly empty list of default known host file paths.
         */
        @NonNull
index d8dfbfc94d4d42668c00891aeb2b60a43bca1635..b391cf4884650dbcfb856bc0bec35b197fb2d426 100644 (file)
@@ -26,7 +26,7 @@ public interface Connector extends Closeable {
         * connected just returns {@code true}.
         *
         * @return {@code true} if an SSH agent is available and connected,
-        *         {@false} if no SSH agent is available
+        *         {@code false} if no SSH agent is available
         * @throws IOException
         *             if connecting to the SSH agent failed
         */
index d1f54bbe65c24289e522dc34d1788648d2c197f8..d5c0e6c7e0e8c3e0fde785849f2237caf7467e3d 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 5053493005bd4f5555b6bb493ef831cbf71221fa..b40ff5a0b4a7dd427850cbf232d15bbb4d343dcd 100644 (file)
@@ -59,19 +59,16 @@ public class CredentialsProviderUserInfo implements UserInfo,
                return uri;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getPassword() {
                return password;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getPassphrase() {
                return passphrase;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean promptPassphrase(String msg) {
                CredentialItem.StringType v = newPrompt(msg);
@@ -83,7 +80,6 @@ public class CredentialsProviderUserInfo implements UserInfo,
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean promptPassword(String msg) {
                CredentialItem.Password p = new CredentialItem.Password(msg);
@@ -99,20 +95,17 @@ public class CredentialsProviderUserInfo implements UserInfo,
                return new CredentialItem.StringType(msg, true);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean promptYesNo(String msg) {
                CredentialItem.YesNoType v = new CredentialItem.YesNoType(msg);
                return provider.get(uri, v) && v.getValue();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void showMessage(String msg) {
                provider.get(uri, new CredentialItem.InformationalMessage(msg));
        }
 
-       /** {@inheritDoc} */
        @Override
        public String[] promptKeyboardInteractive(String destination, String name,
                        String instruction, String[] prompt, boolean[] echo) {
index 77b68bb034f9c58473ba31f8010e72330bfa9a42..325d0549a559ea667186ee67ff365f6a22881800 100644 (file)
@@ -92,7 +92,6 @@ public class JschConfigSessionFactory extends SshSessionFactory {
 
        private OpenSshConfig config;
 
-       /** {@inheritDoc} */
        @Override
        public synchronized RemoteSession getSession(URIish uri,
                        CredentialsProvider credentialsProvider, FS fs, int tms)
@@ -189,14 +188,22 @@ public class JschConfigSessionFactory extends SshSessionFactory {
         * Use for tests only
         *
         * @param credentialsProvider
+        *            credentials provide
         * @param fs
+        *            FS object to use
         * @param user
+        *            user
         * @param pass
+        *            password
         * @param host
+        *            host name
         * @param port
+        *            port number
         * @param hc
-        * @return session
+        *            host config
+        * @return session the session
         * @throws JSchException
+        *             jsch failed
         */
        public Session createSession(CredentialsProvider credentialsProvider,
                        FS fs, String user, final String pass, String host, int port,
index 02cdf708120bc9f9eab609822d380ff0f3ee5fc3..5f36dadc04c7852d82b60a83ba15890d22eabe2a 100644 (file)
@@ -68,20 +68,17 @@ public class JschSession implements RemoteSession2 {
                this.uri = uri;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Process exec(String command, int timeout) throws IOException {
                return exec(command, Collections.emptyMap(), timeout);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Process exec(String command, Map<String, String> environment,
                        int timeout) throws IOException {
                return new JschProcess(command, environment, timeout);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void disconnect() {
                if (sock.isConnected())
index 2873307e07cb28ec9f8791cddd338cdcd7649101..087e546f2208291711e375f43501644060e15881 100644 (file)
@@ -353,7 +353,6 @@ public class OpenSshConfig implements ConfigRepository {
                return host.getConfig();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "OpenSshConfig [configFile=" + configFile + ']'; //$NON-NLS-1$
index ff5f8b76ccbc61d2eae6ec061b58b08ae76739e3..70e990dedff73fa9d332b7bc55b52212bc936bd1 100644 (file)
@@ -941,7 +941,7 @@ public class PushCommandTest extends RepositoryTestCase {
        }
 
        /**
-        * Check that branch.<name>.pushRemote overrides anything else.
+        * Check that branch.&lt;name&gt;.pushRemote overrides anything else.
         *
         * @throws Exception
         */
@@ -980,7 +980,7 @@ public class PushCommandTest extends RepositoryTestCase {
        }
 
        /**
-        * Check that remote.pushDefault overrides branch.<name>.remote
+        * Check that remote.pushDefault overrides branch.&lt;name&gt;.remote
         *
         * @throws Exception
         */
index 37ff40bdf7e6c04cab7838fe7849a82bda9dc2cb..0e73588c662db1040d8a67f49df77cc6d5f47649 100644 (file)
@@ -51,7 +51,6 @@ public abstract class ObjectReachabilityTestCase
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        @Before
        public void setUp() throws Exception {
index 7679c1109855da18b9ab92ea97739bdbc055d346..eeb13cc8b93548fc41d1602e7ba012339dce5a03 100644 (file)
@@ -32,7 +32,6 @@ public abstract class ReachabilityCheckerTestCase
 
        TestRepository<FileRepository> repo;
 
-       /** {@inheritDoc} */
        @Override
        @Before
        public void setUp() throws Exception {
index 100bd32ad8d6d15bf2c91c8ef4d330a4c90f85fb..ed5a6990ac99decd01e236c618e0eae791402613 100644 (file)
@@ -18,7 +18,6 @@ import org.eclipse.jgit.util.SystemReader;
 import org.junit.Before;
 
 public class FileRepositoryBuilderAfterOpenConfigTest extends FileRepositoryBuilderTest {
-       /** {@inheritDoc} */
        @Before
        @Override
        public void setUp() throws Exception {
index 42304e2253e18f74ed0c20e4b3ec181b9e7f1e42..3ea4a167cb8e19a9224f44718a8d49e8f43c658c 100644 (file)
@@ -17,7 +17,6 @@ import org.eclipse.jgit.lib.StoredConfig;
 import org.eclipse.jgit.util.SystemReader;
 
 public class RefDirectoryAfterOpenConfigTest extends RefDirectoryTest {
-       /** {@inheritDoc} */
        @Override
        public void refDirectorySetup() throws Exception {
                StoredConfig userConfig = SystemReader.getInstance().getUserConfig();
index c3dafe4aa21240f9a5b365dc8eb84f7af7cf57ee..90a2aa601e87b13c2f0cd52b55437a1628dff46b 100644 (file)
@@ -23,7 +23,6 @@ import static org.junit.Assert.assertEquals;
 public class SnapshottingRefDirectoryTest extends RefDirectoryTest {
        private RefDirectory originalRefDirectory;
 
-       /** {@inheritDoc} */
        @Before
        @Override
        public void setUp() throws Exception {
index 9755ed1b69cc9e6630931d68b2514d367f7db974..f9687f9f8252ff98d7c2339a8815eb0138797dda 100644 (file)
@@ -2168,12 +2168,12 @@ public class UploadPackTest {
        /**
         * <pre>
         * remote:
-        *    foo <- foofoo <-- branchFoo
-        *    bar <- barbar <-- branchBar
+        *    foo &lt;- foofoo &lt;-- branchFoo
+        *    bar &lt;- barbar &lt;-- branchBar
         *
         * client:
-        *    foo <-- branchFoo
-        *    bar <-- branchBar
+        *    foo &lt;-- branchFoo
+        *    bar &lt;-- branchBar
         *
         * fetch(branchFoo) should send exactly 1 have (i.e. foo) from branchFoo
         * </pre>
index 0857bc15f2983842faf9d7097b69104b3ffcbe7c..3a92f0c4346a8005f52f3189e2aa1a6f4266755b 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index 56655b3b6d9bccb2a16289984400ba972097130e..2b078c11ff9cebd315e2dd6398a165a264ca856e 100644 (file)
@@ -36,7 +36,6 @@ public class AwtAuthenticator extends CachedAuthenticator {
                setDefault(new AwtAuthenticator());
        }
 
-       /** {@inheritDoc} */
        @Override
        protected PasswordAuthentication promptPasswordAuthentication() {
                final GridBagConstraints gbc = new GridBagConstraints(0, 0, 1, 1, 1, 1,
index 0403957d66dfde9fc4e089b5c763d6e97ecb7e9e..729f4cb26398b9a5249f00f4b7529093439e4309 100644 (file)
@@ -43,13 +43,11 @@ public class AwtCredentialsProvider extends CredentialsProvider {
                CredentialsProvider.setDefault(cp);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isInteractive() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean supports(CredentialItem... items) {
                for (CredentialItem i : items) {
@@ -71,7 +69,6 @@ public class AwtCredentialsProvider extends CredentialsProvider {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean get(URIish uri, CredentialItem... items)
                        throws UnsupportedCredentialItem {
index dcf3c1d31452c0af7eea63b9b20a95ab243fb29f..a266a2fc27972c2b8827d408f5b4bfbedcb8b513 100644 (file)
@@ -80,7 +80,6 @@ public class CommitGraphPane extends JTable {
                return allCommits;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setModel(TableModel dataModel) {
                if (dataModel != null && !(dataModel instanceof CommitTableModel))
@@ -88,7 +87,6 @@ public class CommitGraphPane extends JTable {
                super.setModel(dataModel);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected TableModel createDefaultDataModel() {
                return new CommitTableModel();
index 2abe9529d324e4f4bac31f77f60da3f4452cc153..b27b6c3c7d54a1497d829f0090e455e387089dba 100644 (file)
@@ -52,7 +52,7 @@ org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocComments=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
index ceb17fbe25eaba08829a9ad06801a8831abad056..8805ea235370f29e661533fd7dff74e7aa3e915d 100644 (file)
@@ -51,7 +51,6 @@ public class AddNoteCommand extends GitCommand<Note> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Note call() throws GitAPIException {
                checkCallable();
index e6129247712be3798ebfc4fa3abbaba3478d9dff..df0f616256551ba3591c5b2d3e73d3388f0b9dd8 100644 (file)
@@ -37,11 +37,12 @@ public class ApplyCommand extends GitCommand<ApplyResult> {
        /**
         * Constructs the command.
         *
-        * @param local
+        * @param repo
+        *            the repository this command will be used on
         */
-       ApplyCommand(Repository local) {
-               super(local);
-               if (local == null) {
+       ApplyCommand(Repository repo) {
+               super(repo);
+               if (repo == null) {
                        throw new NullPointerException(JGitText.get().repositoryIsRequired);
                }
        }
index fdf8b80cd441652998426a9b5670e4c097edef83..4efc6a7a46f5ba4fc7ea5f98277aa00a92efe47d 100644 (file)
@@ -389,7 +389,6 @@ public class ArchiveCommand extends GitCommand<OutputStream> {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public OutputStream call() throws GitAPIException {
                checkCallable();
index 7319ff4b2f0d646a3f0584730a36ceb48830dd24..7e06a568889804c3969c217c91b731e6598a3e77 100644 (file)
@@ -167,7 +167,6 @@ public class CheckoutCommand extends GitCommand<Ref> {
                this.paths = new LinkedList<>();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref call() throws GitAPIException, RefAlreadyExistsException,
                        RefNotFoundException, InvalidRefNameException,
@@ -407,7 +406,9 @@ public class CheckoutCommand extends GitCommand<Ref> {
         *
         * @return this instance
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.api.errors.RefNotFoundException
+        *             if {@code Ref} couldn't be resolved
         */
        protected CheckoutCommand checkoutPaths() throws IOException,
                        RefNotFoundException {
index 5f8c2b728a77771e882e2ecaf62438372f888e19..38e795b0eba746c68f268c8da90f63e7c8e8f6fc 100644 (file)
@@ -399,7 +399,6 @@ public class CherryPickCommand extends GitCommand<CherryPickResult> {
                return headName;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 36ca97d694700b887903cc4003dc6b36c344ca7b..a4a0c49f45321c64ea639c3d7e04b298653cde46 100644 (file)
@@ -113,24 +113,25 @@ public class CleanCommand extends GitCommand<Set<String>> {
        }
 
        /**
-        * When dryRun is false, deletes the specified path from disk. If dryRun
-        * is true, no paths are actually deleted. In both cases, the paths that
-        * would have been deleted are added to inFiles and returned.
+        * When dryRun is false, deletes the specified path from disk. If dryRun is
+        * true, no paths are actually deleted. In both cases, the paths that would
+        * have been deleted are added to inFiles and returned.
         *
         * Paths that are directories are recursively deleted when
-        * {@link #directories} is true.
-        * Paths that are git repositories are recursively deleted when
-        * {@link #directories} and {@link #force} are both true.
+        * {@link #directories} is true. Paths that are git repositories are
+        * recursively deleted when {@link #directories} and {@link #force} are both
+        * true.
         *
         * @param path
-        *                      The path to be cleaned
+        *            The path to be cleaned
         * @param inFiles
-        *                      A set of strings representing the files that have been cleaned
-        *                      already, the path to be cleaned will be added to this set
-        *                      before being returned.
+        *            A set of strings representing the files that have been cleaned
+        *            already, the path to be cleaned will be added to this set
+        *            before being returned.
         *
         * @return a set of strings with the cleaned path added to it
         * @throws IOException
+        *             if an IO error occurred
         */
        private Set<String> cleanPath(String path, Set<String> inFiles)
                        throws IOException {
index 9e77dd7348bc034298ae89dc74ab7be34c0167c8..e1efb86cdcfb7995f24298430193858d2682c306 100644 (file)
@@ -82,7 +82,6 @@ public class CreateBranchCommand extends GitCommand<Ref> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref call() throws GitAPIException, RefAlreadyExistsException,
                        RefNotFoundException, InvalidRefNameException {
index 3d3ee63568e78faefe91a2c73e148f370d840d59..f1b5d62349604588c857a050f0cf3a37499fc748 100644 (file)
@@ -61,7 +61,6 @@ public class DeleteBranchCommand extends GitCommand<List<String>> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<String> call() throws GitAPIException,
                        NotMergedException, CannotDeleteCurrentBranchException {
index 64d0d94171ddd15d00f5cf64610121c41b1b68c3..92d88aad7d8ef7a8fcd9dd6da16e1b9f05bd7f98 100644 (file)
@@ -48,7 +48,6 @@ public class DeleteTagCommand extends GitCommand<List<String>> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<String> call() throws GitAPIException {
                checkCallable();
index 584d2bc394ffd9b33fe61a3ead6d1d5d5e5c0456..1196359c0fe8711cc6a650dd79b55d32f8a4f099 100644 (file)
@@ -163,7 +163,6 @@ public class GarbageCollectCommand extends GitCommand<Properties> {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Properties call() throws GitAPIException {
                checkCallable();
index 3b3e10e7b2c1057918f507e13f959179f25a69a6..3dc53ec2486a6e2a7445ede26ace7d2afa7ccf80 100644 (file)
@@ -68,6 +68,7 @@ public class Git implements AutoCloseable {
         * @return a {@link org.eclipse.jgit.api.Git} object for the existing git
         *         repository
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static Git open(File dir) throws IOException {
                return open(dir, FS.DETECTED);
@@ -84,6 +85,7 @@ public class Git implements AutoCloseable {
         * @return a {@link org.eclipse.jgit.api.Git} object for the existing git
         *         repository. Closing this instance will close the repo.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static Git open(File dir, FS fs) throws IOException {
                RepositoryCache.FileKey key;
@@ -792,7 +794,6 @@ public class Git implements AutoCloseable {
                return repo;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "Git[" + repo + "]"; //$NON-NLS-1$//$NON-NLS-2$
index 4b7445fc953b4e87409b5d0e54ea035ec4c99b4c..e3c3c89bcba2c3be4c46da9e09d4e8eb4973db86 100644 (file)
@@ -73,7 +73,6 @@ public class ListBranchCommand extends GitCommand<List<Ref>> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> call() throws GitAPIException {
                checkCallable();
index 34955e86f9c4630aa121214369751f5a50a6a521..9eb52866dc51dd5dae2bb3cafece9b77cd2c6e3a 100644 (file)
@@ -44,7 +44,6 @@ public class ListNotesCommand extends GitCommand<List<Note>> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Note> call() throws GitAPIException {
                checkCallable();
index 27a5288429671ddf9495ff2c5546732381008373..9a4a822b59a561a51088757781570a360b57306c 100644 (file)
@@ -54,8 +54,11 @@ public class ListTagCommand extends GitCommand<List<Ref>> {
         *            the specified commit
         * @return this command
         * @throws IOException
+        *             if an IO error occurred
         * @throws IncorrectObjectTypeException
+        *             if commit has an incorrect object type
         * @throws MissingObjectException
+        *             if the commit is missing
         *
         * @since 6.6
         */
@@ -67,7 +70,6 @@ public class ListTagCommand extends GitCommand<List<Ref>> {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> call() throws GitAPIException {
                checkCallable();
index fa40d93e52e551f028bd0abf557f342b9618784c..555e351d3215c09fd77cf0b54ad5aa6d8847555c 100644 (file)
@@ -53,13 +53,11 @@ import org.eclipse.jgit.treewalk.filter.TreeFilter;
  * </pre>
  * <p>
  *
- * <p>
  * Get commits only for a specific file:
  *
  * <pre>
  * git.log().add(head).addPath(&quot;dir/filename.txt&quot;).call();
  * </pre>
- * <p>
  *
  * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-log.html"
  *      >Git documentation about Log</a>
index 7347f63889e92f18ab6e4ba1278526c2b1f4ac44..ecc3b40fb70077f8e22653173eb58716a0686176 100644 (file)
@@ -364,7 +364,6 @@ public class MergeResult {
                return base;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index e6ab1e6588731467a765618f281d2da96bf485a8..cd7c4e9b391281ae927e6e3a76f5c21255a5a4df 100644 (file)
@@ -102,7 +102,6 @@ public class NameRevCommand extends GitCommand<Map<ObjectId, String>> {
                };
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<ObjectId, String> call() throws GitAPIException {
                try {
index cbb9cc2f782ddaceaa8dced40f374f9f4e6025a0..fdc7f3f333dc2fa84a3d8b2b9f092295cb55141c 100644 (file)
@@ -89,7 +89,6 @@ public class PullResult {
                return true;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 19fd3bb2c4aa7e05ed107353615e6513f412693b..859bf938417aaaec618e0b352dc0ab0e31a9387f 100644 (file)
@@ -86,7 +86,6 @@ import org.eclipse.jgit.util.RawParseUtils;
  * supported options and arguments of this command and a {@link #call()} method
  * to finally execute the command. Each instance of this class should only be
  * used for one invocation of the command (means: one call to {@link #call()})
- * <p>
  *
  * @see <a
  *      href="http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html"
@@ -1000,7 +999,9 @@ public class RebaseCommand extends GitCommand<RebaseResult> {
        /**
         * @return the commit if we had to do a commit, otherwise null
         * @throws GitAPIException
+        *             if JGit API failed
         * @throws IOException
+        *             if an IO error occurred
         */
        private RevCommit continueRebase() throws GitAPIException, IOException {
                // if there are still conflicts, we throw a specific Exception
@@ -1102,7 +1103,9 @@ public class RebaseCommand extends GitCommand<RebaseResult> {
         * that can not be parsed as steps
         *
         * @param numSteps
+        *            number of steps to remove
         * @throws IOException
+        *             if an IO error occurred
         */
        private void popSteps(int numSteps) throws IOException {
                if (numSteps == 0)
@@ -1297,7 +1300,9 @@ public class RebaseCommand extends GitCommand<RebaseResult> {
         *            if we can fast-forward to.
         * @return the new head, or null
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.api.errors.GitAPIException
+        *             if a JGit API exception occurred
         */
        public RevCommit tryFastForward(RevCommit newCommit) throws IOException,
                        GitAPIException {
@@ -1548,6 +1553,7 @@ public class RebaseCommand extends GitCommand<RebaseResult> {
         *            the name of the upstream branch
         * @return {@code this}
         * @throws org.eclipse.jgit.api.errors.RefNotFoundException
+        *             if {@code upstream} Ref couldn't be resolved
         */
        public RebaseCommand setUpstream(String upstream)
                        throws RefNotFoundException {
index 826ea518e42a0e83e3d67564550f89a0eaf97b14..83c0dc2ef29b8fbf3eafb7550f15bab1ab7d7f68 100644 (file)
@@ -194,6 +194,7 @@ public class RebaseResult {
         * Create <code>RebaseResult</code>
         *
         * @param status
+        *            the overall rebase status
         * @param commit
         *            current commit
         * @return the RebaseResult
index f4b60adedb149de890790ad5d3b69a5af4397f7a..c65cbf160f13b75855b93a6739ac908586f00acd 100644 (file)
@@ -47,7 +47,6 @@ public class RemoveNoteCommand extends GitCommand<Note> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Note call() throws GitAPIException {
                checkCallable();
index 922cb531dec34b6f8b6b7b53ab43efd69c4cf312..029f9d02d633b2420d42ad44306e4767c6054c2e 100644 (file)
@@ -55,7 +55,6 @@ public class RenameBranchCommand extends GitCommand<Ref> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref call() throws GitAPIException, RefNotFoundException, InvalidRefNameException,
                        RefAlreadyExistsException, DetachedHeadException {
index 87b4acb14c2328e2ba9c53f75c73fee4014a92c9..225c9996cfcb8720ee33699ba791868865266545 100644 (file)
@@ -436,7 +436,6 @@ public class ResetCommand extends GitCommand<Ref> {
                repo.writeMergeCommitMsg(null);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index f64cb6b83185d5d48b97e43925c60fdd628a480d..7bb9de0ef4867f4146c02713671ae880ef7a22de 100644 (file)
@@ -44,7 +44,6 @@ public class ShowNoteCommand extends GitCommand<Note> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Note call() throws GitAPIException {
                checkCallable();
index 8171c4c3aeb2b580619c3c5f5b64686cad514993..828a3020f81a5e784602ca002e2975fe5a2fcbc6 100644 (file)
@@ -43,7 +43,6 @@ public class StashListCommand extends GitCommand<Collection<RevCommit>> {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<RevCommit> call() throws GitAPIException,
                        InvalidRefNameException {
index 606d5673938840340ee0744c4aeaeebf44e58a8b..8fb5d60b8582d4afd2002d3a297f7e608fa11f67 100644 (file)
@@ -66,6 +66,7 @@ public class SubmoduleAddCommand extends
         * Set the submodule name
         *
         * @param name
+        *            name of the submodule
         * @return this command
         * @since 5.1
         */
@@ -117,6 +118,7 @@ public class SubmoduleAddCommand extends
         *
         * @return true if submodule exists in index, false otherwise
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected boolean submoduleExists() throws IOException {
                TreeFilter filter = PathFilter.create(path);
index f4b8ac2e075adf02e72f687e770d693573ec27d1..0aa151533405349b291b1edb9f6b50bfe4a09ea9 100644 (file)
@@ -61,6 +61,7 @@ public class SubmoduleDeinitCommand
         * Constructor of SubmoduleDeinitCommand
         *
         * @param repo
+        *            repository this command works on
         */
        public SubmoduleDeinitCommand(Repository repo) {
                super(repo);
@@ -69,7 +70,6 @@ public class SubmoduleDeinitCommand
 
        /**
         * {@inheritDoc}
-        * <p>
         *
         * @return the set of repositories successfully deinitialized.
         * @throws NoSuchSubmoduleException
@@ -135,6 +135,7 @@ public class SubmoduleDeinitCommand
         * @param path
         *            the path to clean
         * @throws IOException
+        *             if an IO error occurred
         */
        private void deinit(String path) throws IOException {
                File dir = new File(repo.getWorkTree(), path);
@@ -157,10 +158,14 @@ public class SubmoduleDeinitCommand
         * the parent repo's index or HEAD.
         *
         * @param revWalk
+        *            used to walk commit graph
         * @param path
+        *            path of the submodule
         * @return status of the command
         * @throws GitAPIException
+        *             if JGit API failed
         * @throws IOException
+        *             if an IO error occurred
         */
        private SubmoduleDeinitStatus checkDirty(RevWalk revWalk, String path)
                        throws GitAPIException, IOException {
@@ -216,6 +221,7 @@ public class SubmoduleDeinitCommand
         * @return {@code true} if path exists and is a submodule in index,
         *         {@code false} otherwise
         * @throws IOException
+        *             if an IO error occurred
         */
        private boolean submoduleExists(String path) throws IOException {
                TreeFilter filter = PathFilter.create(path);
@@ -241,6 +247,7 @@ public class SubmoduleDeinitCommand
         * else it will refuse to do so.
         *
         * @param force
+        *            execute the command forcefully if there are local modifications
         * @return {@code this}
         */
        public SubmoduleDeinitCommand setForce(boolean force) {
index 8129be4a716d3945e3ee3aed3c6b923dcc3bcfc3..b7d7b66333f9ed8390e9305963b7969c2e7811ac 100644 (file)
@@ -25,6 +25,7 @@ public class SubmoduleDeinitResult {
         * @param path
         *            path of the submodule
         * @param status
+        *            effect of a SubmoduleDeinitCommand's execution
         */
        public SubmoduleDeinitResult(String path,
                        SubmoduleDeinitCommand.SubmoduleDeinitStatus status) {
index bdceabad379f1fcec703630286cdf25fddc5a587..03b4a000ad404dbea56deedef102234787b5f437 100644 (file)
@@ -61,7 +61,6 @@ public class SubmoduleInitCommand extends GitCommand<Collection<String>> {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<String> call() throws GitAPIException {
                checkCallable();
index 196ef7b2a95b846e133f90ef8acad335d590ea28..d5bc0dda98a11fc0a0328be715257110397c7a09 100644 (file)
@@ -61,7 +61,6 @@ public class SubmoduleStatusCommand extends
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, SubmoduleStatus> call() throws GitAPIException {
                checkCallable();
index b319a1b478a820f533e1d349c06182b65d933e6f..4f3e8512c3517153ddb5dbb6db8040b1ecf7202c 100644 (file)
@@ -70,6 +70,7 @@ public class SubmoduleSyncCommand extends GitCommand<Map<String, String>> {
         *            a {@link org.eclipse.jgit.lib.Repository} object.
         * @return shortened branch name, null on failures
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected String getHeadBranch(Repository subRepo) throws IOException {
                Ref head = subRepo.exactRef(Constants.HEAD);
@@ -79,7 +80,6 @@ public class SubmoduleSyncCommand extends GitCommand<Map<String, String>> {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, String> call() throws GitAPIException {
                checkCallable();
index 58c18b38d10b78f22257ac4a74d760003d25fc0c..dd4ba10388a9a4bfda0573043ad0fc357434092f 100644 (file)
@@ -51,13 +51,11 @@ import org.eclipse.jgit.transport.CredentialsProvider;
  * </pre>
  * <p>
  *
- * <p>
  * Create a new unannotated tag for the current commit:
  *
  * <pre>
  * git.tag().setName(&quot;v1.0&quot;).setAnnotated(false).call();
  * </pre>
- * <p>
  *
  * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-tag.html"
  *      >Git documentation about Tag</a>
index 1af880d792bcc71b37c961e1c3dfd6487e62d5cb..30f1bc9cc6915d8d3374d77493dddc6fd7a00f33 100644 (file)
@@ -22,7 +22,9 @@ import org.eclipse.jgit.transport.Transport;
  * {@link org.eclipse.jgit.api.TransportConfigCallback}.
  *
  * @param <C>
+ *            concrete type of this {@code GitCommand}
  * @param <T>
+ *            the return type of the {@code GitCommand}'s {@code call()} method
  */
 public abstract class TransportCommand<C extends GitCommand, T> extends
                GitCommand<T> {
index 3b71373b6ede91291201f34312cb93783805ee3a..0224b3dbb35622f7425d59e1a12cd65a85f22dfa 100644 (file)
@@ -94,6 +94,7 @@ public class CheckoutConflictException extends GitAPIException {
         * Adds a new conflicting path
         *
         * @param conflictingPath
+        *            the new conflicting path
         * @return {@code this}
         */
        CheckoutConflictException addConflictingPath(String conflictingPath) {
index 470a92eaf57872247e981e26cb13f7ec3818c5f6..fe3e22a21f795fdbcd79e2db2b68f5f3114a6e98 100644 (file)
@@ -97,7 +97,6 @@ public final class Attribute {
                this(key, State.CUSTOM, value);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object obj) {
                if (this == obj)
@@ -144,7 +143,6 @@ public final class Attribute {
                return value;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                final int prime = 31;
@@ -155,7 +153,6 @@ public final class Attribute {
                return result;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                switch (state) {
index 125ee5961a371e4c9b3d305fceeb4d08c8f10c35..08bc1da61eb7268f1332ff697b92cdfd3865bbf8 100644 (file)
@@ -231,7 +231,6 @@ public final class Attributes {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder buf = new StringBuilder();
@@ -246,13 +245,11 @@ public final class Attributes {
                return buf.toString();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return map.hashCode();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object obj) {
                if (this == obj)
index 7ec78597fa284cb2d482c7d3a223c99f87a83b7a..d8857f5192ce4ba53a805e9e7ffa40dcd29aa74a 100644 (file)
@@ -69,6 +69,7 @@ public class AttributesHandler {
         * @param treeWalk
         *            a {@link org.eclipse.jgit.treewalk.TreeWalk}
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @deprecated since 6.1, use {@link #AttributesHandler(TreeWalk, Supplier)}
         *             instead
         */
@@ -87,6 +88,7 @@ public class AttributesHandler {
         * @param attributesTree
         *            the tree to read .gitattributes from
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 6.1
         */
        public AttributesHandler(TreeWalk treeWalk,
@@ -128,6 +130,7 @@ public class AttributesHandler {
         *         current path represented by the
         *         {@link org.eclipse.jgit.treewalk.TreeWalk}
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public Attributes getAttributes() throws IOException {
                String entryPath = treeWalk.getPathString();
@@ -206,12 +209,16 @@ public class AttributesHandler {
         * @param isDirectory
         *            true if the target item is a directory.
         * @param workingTreeIterator
+        *            the working tree iterator
         * @param dirCacheIterator
+        *            the dircache iterator
         * @param otherTree
+        *            another tree
         * @param result
         *            that will hold the attributes matching this entry path. This
         *            method will NOT override any existing entry in attributes.
         * @throws IOException
+        *             if an IO error occurred
         */
        private void mergePerDirectoryEntryAttributes(String entryPath,
                        int nameRoot, boolean isDirectory,
@@ -357,9 +364,13 @@ public class AttributesHandler {
         * </p>
         *
         * @param treeWalk
+        *            used to walk trees
         * @param workingTreeIterator
+        *            used to walk the working tree
         * @param dirCacheIterator
+        *            used to walk the dircache
         * @param otherTree
+        *            another tree
         * @return a {@link AttributesNode} of the current entry,
         *         {@link NullPointerException} otherwise.
         * @throws IOException
index 73fd587a14e7cf5016e43a18031a9005d125c585..2039191b8c5f5167b13a50771f2312008c8b602b 100644 (file)
@@ -187,7 +187,6 @@ public class AttributesRule {
                return match;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder sb = new StringBuilder();
index 1c9e9d7f7103d7efb1e244373b89ec86d090b3ce..bbbb437fd2309cfc4d7ffc61ec437882f956b3bf 100644 (file)
@@ -41,8 +41,8 @@ public class FilterCommandRegistry {
         *            the factory responsible for creating
         *            {@link org.eclipse.jgit.attributes.FilterCommand}s for the
         *            specified name
-        * @return the previous factory associated with <tt>commandName</tt>, or
-        *         <tt>null</tt> if there was no mapping for <tt>commandName</tt>
+        * @return the previous factory associated with {@code commandName}, or
+        *         {@code null} if there was no mapping for {@code commandName}
         */
        public static FilterCommandFactory register(String filterCommandName,
                        FilterCommandFactory factory) {
@@ -55,8 +55,8 @@ public class FilterCommandRegistry {
         *
         * @param filterCommandName
         *            the FilterCommandFactory's filter command name
-        * @return the previous factory associated with <tt>filterCommandName</tt>,
-        *         or <tt>null</tt> if there was no mapping for <tt>commandName</tt>
+        * @return the previous factory associated with {@code filterCommandName},
+        *         or {@code null} if there was no mapping for {@code commandName}
         */
        public static FilterCommandFactory unregister(String filterCommandName) {
                return filterCommandRegistry.remove(filterCommandName);
@@ -69,7 +69,7 @@ public class FilterCommandRegistry {
         *
         * @param filterCommandName
         *            the name for which the registry should be checked
-        * @return <code>true</code> if any factory was registered for the name
+        * @return {@code true} if any factory was registered for the name
         */
        public static boolean isRegistered(String filterCommandName) {
                return filterCommandRegistry.containsKey(filterCommandName);
@@ -107,6 +107,7 @@ public class FilterCommandRegistry {
         * @return the command if a command could be created or <code>null</code> if
         *         there was no factory registered for that name
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static FilterCommand createFilterCommand(String filterCommandName,
                        Repository db, InputStream in, OutputStream out)
index c854b37b849939f7caace0d860071089951e68f5..5e2746cc7cd02a2aaad111b4431e8835ebb89020 100644 (file)
@@ -303,7 +303,6 @@ public class BlameResult {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder r = new StringBuilder();
index ccf99ff5b5c9539ee250b3efc4c9bf7b26320cba..8e2aaecf9484b72f00d467e3c45223be965a0c28 100644 (file)
@@ -305,7 +305,6 @@ class Candidate {
                }
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 2236eecbfed291c6d437da7f449e1aa8a24b4a87..c481eb1927ef03e009350c78b979bfaa7592341c 100644 (file)
@@ -83,7 +83,6 @@ class Region {
                return head;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder buf = new StringBuilder();
index e8f3f38adbd00af25a9495c0980125ee475a58a4..fafc4fb1eccca039794401e07516ef45efa06ae3 100644 (file)
@@ -24,7 +24,6 @@ final class ReverseWalk extends RevWalk {
                super(repo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ReverseCommit next() throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
@@ -36,7 +35,6 @@ final class ReverseWalk extends RevWalk {
                return c;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected RevCommit createCommit(AnyObjectId id) {
                return new ReverseCommit(id);
index 2526cbfae42bcc7671bd7b60aba7fce6593178ef..7821efd2a6d6ae6056880ff031a59656e06118d8 100644 (file)
@@ -58,6 +58,8 @@ public abstract class DiffAlgorithm {
        /**
         * Compare two sequences and identify a list of edits between them.
         *
+        * @param <S>
+        *            type of sequence being compared.
         * @param cmp
         *            the comparator supplying the element equivalence function.
         * @param a
@@ -217,6 +219,8 @@ public abstract class DiffAlgorithm {
         * method, which invokes this method using
         * {@link org.eclipse.jgit.diff.Subsequence}s.
         *
+        * @param <S>
+        *            type of sequence being compared.
         * @param cmp
         *            the comparator supplying the element equivalence function.
         * @param a
index f0ce121f73033177145f572d59aa2677f4369980..717d8989ec21b585e8d9d824b204f652e8181b6f 100644 (file)
@@ -457,7 +457,6 @@ public class DiffEntry {
        /**
         * Whether the mark tree filter with the specified index matched during scan
         * or not, see {@link #scan(TreeWalk, boolean, TreeFilter...)}. Example:
-        * <p>
         *
         * <pre>
         * TreeFilter filterA = ...;
@@ -506,7 +505,6 @@ public class DiffEntry {
                return side == Side.OLD ? getOldId() : getNewId();
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 1a5f74f98a4a13db870fd886a71ebb228e0e46b9..2f472b5c0aee2c91e9cff8ab83102cfc15eb6aa5 100644 (file)
@@ -777,6 +777,7 @@ public class DiffFormatter implements AutoCloseable {
         * @param b
         *            the text B which was compared
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void format(EditList edits, RawText a, RawText b)
                        throws IOException {
@@ -825,6 +826,7 @@ public class DiffFormatter implements AutoCloseable {
         * @param line
         *            the line number within text
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected void writeContextLine(RawText text, int line)
                        throws IOException {
@@ -843,6 +845,7 @@ public class DiffFormatter implements AutoCloseable {
         * @param line
         *            the line number within text
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected void writeAddedLine(RawText text, int line)
                        throws IOException {
@@ -857,6 +860,7 @@ public class DiffFormatter implements AutoCloseable {
         * @param line
         *            the line number within text
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected void writeRemovedLine(RawText text, int line)
                        throws IOException {
@@ -875,6 +879,7 @@ public class DiffFormatter implements AutoCloseable {
         * @param bEndLine
         *            within second source
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected void writeHunkHeader(int aStartLine, int aEndLine,
                        int bStartLine, int bEndLine) throws IOException {
index 219a187e27cc359ce45a207e5f65f6d88440ac10..2968dbaa8f321c374fd2e271905399e54a48446f 100644 (file)
@@ -238,13 +238,11 @@ public class Edit {
                endB = sEnd;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return beginA ^ endA;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object o) {
                if (o instanceof Edit) {
@@ -255,7 +253,6 @@ public class Edit {
                return false;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index d40a64099a3f3873f5ddf0101b14c6ef5fae6c9a..85e23e9a92c11e7e21d42a47bfb7a993edb831a8 100644 (file)
@@ -49,7 +49,6 @@ public class EditList extends ArrayList<Edit> {
                super(capacity);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "EditList" + super.toString(); //$NON-NLS-1$
index 9cb8e7364be24487cea27a3e39bfa9e2b1a43d35..82ab21c11e0b649fd642e0036635d6cf163278a1 100644 (file)
@@ -34,7 +34,6 @@ public final class HashedSequence<S extends Sequence> extends Sequence {
                this.hashes = hashes;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int size() {
                return base.size();
index 0380208565295fec45005e26d498a8eeb5e2ed31..c7dfd9a18f77771c07c8d496cafd3b35d83c8178 100644 (file)
@@ -33,7 +33,6 @@ public final class HashedSequenceComparator<S extends Sequence> extends
                this.cmp = cmp;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(HashedSequence<S> a, int ai, //
                        HashedSequence<S> b, int bi) {
@@ -41,7 +40,6 @@ public final class HashedSequenceComparator<S extends Sequence> extends
                                && cmp.equals(a.base, ai, b.base, bi);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hash(HashedSequence<S> seq, int ptr) {
                return seq.hashes[ptr];
index 4035a1e48ecc4c845bb5b1ef11dbc552ecb1ba42..bb72e1faedb3edfba058ec1ed5fdd09e2fd4ab36 100644 (file)
@@ -98,7 +98,6 @@ public class HistogramDiff extends LowLevelDiffAlgorithm {
                maxChainLength = maxLen;
        }
 
-       /** {@inheritDoc} */
        @Override
        public <S extends Sequence> void diffNonCommon(EditList edits,
                        HashedSequenceComparator<S> cmp, HashedSequence<S> a,
index 7f3c2518647f80dacfaaa23b7a1697c97eaaa2b9..39be43d12d62a0e60a5aa2ff329794ea87e1a8e0 100644 (file)
@@ -14,7 +14,6 @@ package org.eclipse.jgit.diff;
  * Compares two sequences primarily based upon hash codes.
  */
 public abstract class LowLevelDiffAlgorithm extends DiffAlgorithm {
-       /** {@inheritDoc} */
        @Override
        public <S extends Sequence> EditList diffNonCommon(
                        SequenceComparator<? super S> cmp, S a, S b) {
@@ -40,6 +39,8 @@ public abstract class LowLevelDiffAlgorithm extends DiffAlgorithm {
         * method, which invokes this method using
         * {@link org.eclipse.jgit.diff.Subsequence}s.
         *
+        * @param <S>
+        *            type of Sequence compared
         * @param edits
         *            result list to append the region's edits onto.
         * @param cmp
index 53cd2ea5d7b8423c74e2ce6476b42591302dc314..4343642f9a291282b7a1f559a6ea3d8c35ea7e8a 100644 (file)
@@ -43,14 +43,12 @@ public class PatchIdDiffFormatter extends DiffFormatter {
                return ObjectId.fromRaw(digest.digest());
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void writeHunkHeader(int aStartLine, int aEndLine,
                        int bStartLine, int bEndLine) throws IOException {
                // The hunk header is not taken into account for patch id calculation
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void formatIndexLine(OutputStream o, DiffEntry ent)
                        throws IOException {
index b52803513d4eb7d0d551e3a4990fd057b1616f3f..7835582437903b860f22643cebf3fafad31a6381 100644 (file)
@@ -114,7 +114,6 @@ public class RawText extends Sequence {
        }
 
        /** @return total number of items in the sequence. */
-       /** {@inheritDoc} */
        @Override
        public int size() {
                // The line map is always 2 entries larger than the number of lines in
index 0c41b8598b43579757bfc2d737e066468b871efe..e06e2f8290a3037482a4da1c8d9eb3c4bce75585 100644 (file)
@@ -227,7 +227,6 @@ public abstract class RawTextComparator extends SequenceComparator<RawText> {
                return hashRegion(seq.content, begin, end);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Edit reduceCommonStartEnd(RawText a, RawText b, Edit e) {
                // This is a faster exact match based form that tries to improve
index c33f53addeefcae73eddc4dceffa7f71e8e2d831..fd84bc6c87899399fa8cfffdc512075434338930 100644 (file)
@@ -713,15 +713,16 @@ public class RenameDetector {
 
        /**
         * Find the best match by file path for a given DiffEntry from a list of
-        * DiffEntrys. The returned DiffEntry will be of the same type as <src>. If
-        * no DiffEntry can be found that has the same type, this method will return
-        * null.
+        * DiffEntrys. The returned DiffEntry will be of the same type as
+        * &lt;src&gt;. If no DiffEntry can be found that has the same type, this
+        * method will return null.
         *
         * @param src
         *            the DiffEntry to try to find a match for
         * @param list
         *            a list of DiffEntrys to search through
-        * @return the DiffEntry from <list> who's file path best matches <src>
+        * @return the DiffEntry from &lt;list&gt; who's file path best matches
+        *         &lt;src&gt;
         */
        private static DiffEntry bestPathMatch(DiffEntry src, List<DiffEntry> list) {
                DiffEntry best = null;
index 61f133ca551b388199a015d15dbbe1fcbf4c22fd..878c66b30f2e074ebcd3166694cea87a23950ccc 100644 (file)
@@ -25,6 +25,8 @@ public final class Subsequence<S extends Sequence> extends Sequence {
        /**
         * Construct a subsequence around the A region/base sequence.
         *
+        * @param <S>
+        *            type of returned Sequence
         * @param a
         *            the A sequence.
         * @param region
@@ -38,6 +40,8 @@ public final class Subsequence<S extends Sequence> extends Sequence {
        /**
         * Construct a subsequence around the B region/base sequence.
         *
+        * @param <S>
+        *            type of returned Sequence
         * @param b
         *            the B sequence.
         * @param region
@@ -51,6 +55,8 @@ public final class Subsequence<S extends Sequence> extends Sequence {
        /**
         * Adjust the Edit to reflect positions in the base sequence.
         *
+        * @param <S>
+        *            type of returned Sequence
         * @param e
         *            edit to adjust in-place. Prior to invocation the indexes are
         *            in terms of the two subsequences; after invocation the indexes
@@ -72,6 +78,8 @@ public final class Subsequence<S extends Sequence> extends Sequence {
        /**
         * Adjust the Edits to reflect positions in the base sequence.
         *
+        * @param <S>
+        *            type of returned Sequence
         * @param edits
         *            edits to adjust in-place. Prior to invocation the indexes are
         *            in terms of the two subsequences; after invocation the indexes
@@ -116,7 +124,6 @@ public final class Subsequence<S extends Sequence> extends Sequence {
                this.size = end - begin;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int size() {
                return size;
index c60945361f287e64be17e5d45f85459810e69d54..707df59259ad6bc4d73335f2b36d4a0b228e7d9a 100644 (file)
@@ -36,13 +36,11 @@ public final class SubsequenceComparator<S extends Sequence> extends
                this.cmp = cmp;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Subsequence<S> a, int ai, Subsequence<S> b, int bi) {
                return cmp.equals(a.base, ai + a.begin, b.base, bi + b.begin);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hash(Subsequence<S> seq, int ptr) {
                return cmp.hash(seq.base, ptr + seq.begin);
index 86e60e5b73ca129eb84a46254d8876cf49bb4589..68296ef3304b983ae9c938c79ab31afe4daa1a57 100644 (file)
@@ -25,9 +25,11 @@ import org.eclipse.jgit.errors.DirCacheNameConflictException;
  * services to applications.
  */
 abstract class BaseDirCacheEditor {
+       @SuppressWarnings("doclint:missing")
        /** The cache instance this editor updates during {@link #finish()}. */
        protected DirCache cache;
 
+       @SuppressWarnings("doclint:missing")
        /**
         * Entry table this builder will eventually replace into {@link #cache}.
         * <p>
@@ -40,7 +42,7 @@ abstract class BaseDirCacheEditor {
         */
        protected DirCacheEntry[] entries;
 
-       /** Total number of valid entries in {@link #entries}. */
+       /** Total number of valid entries in {@link BaseDirCacheEditor#entries}. */
        protected int entryCnt;
 
        /**
@@ -137,7 +139,8 @@ abstract class BaseDirCacheEditor {
        public abstract void finish();
 
        /**
-        * Update the DirCache with the contents of {@link #entries}.
+        * Update the DirCache with the contents of
+        * {@link BaseDirCacheEditor#entries}.
         * <p>
         * This method should be invoked only during an implementation of
         * {@link #finish()}, and only after {@link #entries} is sorted.
index e56061223c9105c1ff7967ae3d98a34f3d455da4..34dba0b5be49d418a4f6814e56596645850ef3eb 100644 (file)
@@ -429,6 +429,7 @@ public class DirCache {
         *
         * @return {@code true} if the memory state differs from the index file
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public boolean isOutdated() throws IOException {
                if (liveFile == null || !liveFile.exists())
@@ -1001,6 +1002,7 @@ public class DirCache {
         * Update any smudged entries with information from the working tree.
         *
         * @throws IOException
+        *             if an IO error occurred
         */
        private void updateSmudgedEntries() throws IOException {
                List<String> paths = new ArrayList<>(128);
index f6e4d360a65c1002995f33a918a769dc13073a54..befd8067abf1fbb01cb41cbdb6ab7d659ffd9e81 100644 (file)
@@ -74,7 +74,6 @@ public class DirCacheBuildIterator extends DirCacheIterator {
                builder = p.builder;
        }
 
-       /** {@inheritDoc} */
        @Override
        public AbstractTreeIterator createSubtreeIterator(ObjectReader reader)
                        throws IncorrectObjectTypeException, IOException {
@@ -84,7 +83,6 @@ public class DirCacheBuildIterator extends DirCacheIterator {
                return new DirCacheBuildIterator(this, currentSubtree);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void skip() throws CorruptObjectException {
                if (currentSubtree != null)
@@ -94,7 +92,6 @@ public class DirCacheBuildIterator extends DirCacheIterator {
                next(1);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void stopWalk() {
                final int cur = ptr;
@@ -103,7 +100,6 @@ public class DirCacheBuildIterator extends DirCacheIterator {
                        builder.keep(cur, cnt - cur);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean needsStopWalk() {
                return ptr < cache.getEntryCount();
index 9fe77f36e86cef7f0c3f99a9a2c63e1d9072686b..28d2502005dbca090d93d4e9be86846e02c75e80 100644 (file)
@@ -186,7 +186,6 @@ public class DirCacheBuilder extends BaseDirCacheEditor {
                return e;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void finish() {
                if (!sorted)
index 1fb81b71e9381dec1a152284468ba8269d0a2b10..20b27375bd1fc31a5ac65ad0f958c9fe5d83e0e5 100644 (file)
@@ -100,7 +100,9 @@ public class DirCacheCheckout {
 
                /**
                 * @param eolStreamType
+                *            how to convert EOL characters during stream conversion
                 * @param smudgeFilterCommand
+                *            command used as smudge filter during checkout
                 */
                public CheckoutMetadata(EolStreamType eolStreamType,
                                String smudgeFilterCommand) {
@@ -206,6 +208,7 @@ public class DirCacheCheckout {
         * @param workingTree
         *            an iterator over the repositories Working Tree
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public DirCacheCheckout(Repository repo, ObjectId headCommitTree, DirCache dc,
                        ObjectId mergeCommitTree, WorkingTreeIterator workingTree)
@@ -233,6 +236,7 @@ public class DirCacheCheckout {
         * @param mergeCommitTree
         *            the id of the tree we want to fast-forward to
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public DirCacheCheckout(Repository repo, ObjectId headCommitTree,
                        DirCache dc, ObjectId mergeCommitTree) throws IOException {
@@ -252,6 +256,7 @@ public class DirCacheCheckout {
         * @param workingTree
         *            an iterator over the repositories Working Tree
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public DirCacheCheckout(Repository repo, DirCache dc,
                        ObjectId mergeCommitTree, WorkingTreeIterator workingTree)
@@ -271,6 +276,7 @@ public class DirCacheCheckout {
         * @param mergeCommitTree
         *            the id of the tree of the
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public DirCacheCheckout(Repository repo, DirCache dc,
                        ObjectId mergeCommitTree) throws IOException {
@@ -294,7 +300,9 @@ public class DirCacheCheckout {
         * operations.
         *
         * @throws org.eclipse.jgit.errors.CorruptObjectException
+        *             if a corrupt object was found
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void preScanTwoTrees() throws CorruptObjectException, IOException {
                removed.clear();
@@ -324,9 +332,13 @@ public class DirCacheCheckout {
         * there is no head yet.
         *
         * @throws org.eclipse.jgit.errors.MissingObjectException
+        *             if an object was found missing
         * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
+        *             if an object didn't have the expected type
         * @throws org.eclipse.jgit.errors.CorruptObjectException
+        *             if an object is corrupt
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void prescanOneTree()
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -372,6 +384,7 @@ public class DirCacheCheckout {
         * @param f
         *            the working tree
         * @throws IOException
+        *             if an IO error occurred
         */
        void processEntry(CanonicalTreeParser m, DirCacheBuildIterator i,
                        WorkingTreeIterator f) throws IOException {
@@ -465,6 +478,7 @@ public class DirCacheCheckout {
         *         successful and the working tree was updated for all other files.
         *         <code>true</code> is returned when no such problem occurred
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public boolean checkout() throws IOException {
                try {
@@ -684,9 +698,13 @@ public class DirCacheCheckout {
         * Compares whether two pairs of ObjectId and FileMode are equal.
         *
         * @param id1
+        *            id of first object
         * @param mode1
+        *            mode of first object
         * @param id2
+        *            id of second object
         * @param mode2
+        *            mode of second object
         * @return <code>true</code> if FileModes and ObjectIds are equal.
         *         <code>false</code> otherwise
         */
@@ -712,6 +730,7 @@ public class DirCacheCheckout {
         * @param f
         *            the file in the working tree
         * @throws IOException
+        *             if an IO error occurred
         */
 
        void processEntry(CanonicalTreeParser h, CanonicalTreeParser m,
@@ -1295,6 +1314,7 @@ public class DirCacheCheckout {
         * {@link #failOnConflict} is false
         *
         * @throws CheckoutConflictException
+        *             if a conflict occurred during merge checkout
         */
        private void cleanUpConflicts() throws CheckoutConflictException {
                // TODO: couldn't we delete unsaved worktree content here?
@@ -1308,13 +1328,16 @@ public class DirCacheCheckout {
        }
 
        /**
-        * Checks whether the subtree starting at a given path differs between Index and
-        * workingtree.
+        * Checks whether the subtree starting at a given path differs between Index
+        * and workingtree.
         *
         * @param path
+        *            given subtree path
         * @return true if the subtrees differ
         * @throws CorruptObjectException
+        *             if a corrupt object was found
         * @throws IOException
+        *             if an IO error occurred
         */
        private boolean isModifiedSubtree_IndexWorkingtree(String path)
                        throws CorruptObjectException, IOException {
@@ -1355,15 +1378,18 @@ public class DirCacheCheckout {
        }
 
        /**
-        * Checks whether the subtree starting at a given path differs between Index and
-        * some tree.
+        * Checks whether the subtree starting at a given path differs between Index
+        * and some tree.
         *
         * @param path
+        *            given path
         * @param tree
         *            the tree to compare
         * @return true if the subtrees differ
         * @throws CorruptObjectException
+        *             if a corrupt object was found
         * @throws IOException
+        *             if an IO error occurred
         */
        private boolean isModifiedSubtree_IndexTree(String path, ObjectId tree)
                        throws CorruptObjectException, IOException {
@@ -1408,6 +1434,7 @@ public class DirCacheCheckout {
         * @param or
         *            object reader to use for checkout
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.6
         * @deprecated since 5.1, use
         *             {@link #checkoutEntry(Repository, DirCacheEntry, ObjectReader, boolean, CheckoutMetadata, WorkingTreeOptions)}
@@ -1449,6 +1476,7 @@ public class DirCacheCheckout {
         *            <li>eolStreamType used for stream conversion</li>
         *            </ul>
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         * @deprecated since 6.3, use
         *             {@link #checkoutEntry(Repository, DirCacheEntry, ObjectReader, boolean, CheckoutMetadata, WorkingTreeOptions)}
@@ -1493,6 +1521,7 @@ public class DirCacheCheckout {
         *            {@link WorkingTreeOptions} that are effective; if {@code null}
         *            they are loaded from the repository config
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 6.3
         */
        public static void checkoutEntry(Repository repo, DirCacheEntry entry,
@@ -1599,6 +1628,7 @@ public class DirCacheCheckout {
         *            the output stream the filtered content is written to. The
         *            caller is responsible to close the stream.
         * @throws IOException
+        *             if an IO error occurred
         *
         * @since 5.7
         */
@@ -1654,6 +1684,7 @@ public class DirCacheCheckout {
         *            the output stream the filtered content is written to. The
         *            caller is responsible to close the stream.
         * @throws IOException
+        *             if an IO error occurred
         * @since 6.3
         */
        public static void getContent(Repository repo, String path,
index 8c342e267d9f84d0f2b1c89605973b7b12f7a260..b1f4e7db214f75109a042ae29a7e54939a9bb82c 100644 (file)
@@ -37,7 +37,6 @@ import org.eclipse.jgit.util.Paths;
  * have the editor compute the proper entry indexes necessary to perform an
  * efficient in-order update of the index records. This can be easier to use
  * than {@link org.eclipse.jgit.dircache.DirCacheBuilder}.
- * <p>
  *
  * @see DirCacheBuilder
  */
@@ -80,7 +79,6 @@ public class DirCacheEditor extends BaseDirCacheEditor {
                edits.add(edit);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean commit() throws IOException {
                if (edits.isEmpty()) {
@@ -92,7 +90,6 @@ public class DirCacheEditor extends BaseDirCacheEditor {
                return super.commit();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void finish() {
                if (!edits.isEmpty()) {
index aed1c341f26112e6694bc717b8e9e7020956c77b..9cc34a0f11986f13ce533bf9f952c5fab28653cc 100644 (file)
@@ -104,7 +104,6 @@ public class DirCacheIterator extends AbstractTreeIterator {
                parseEntry();
        }
 
-       /** {@inheritDoc} */
        @Override
        public AbstractTreeIterator createSubtreeIterator(ObjectReader reader)
                        throws IncorrectObjectTypeException, IOException {
@@ -114,7 +113,6 @@ public class DirCacheIterator extends AbstractTreeIterator {
                return new DirCacheIterator(this, currentSubtree);
        }
 
-       /** {@inheritDoc} */
        @Override
        public EmptyTreeIterator createEmptyTreeIterator() {
                final byte[] n = new byte[Math.max(pathLen + 1, DEFAULT_PATH_SIZE)];
@@ -123,7 +121,6 @@ public class DirCacheIterator extends AbstractTreeIterator {
                return new EmptyTreeIterator(this, n, pathLen + 1);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasId() {
                if (currentSubtree != null)
@@ -131,7 +128,6 @@ public class DirCacheIterator extends AbstractTreeIterator {
                return currentEntry != null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public byte[] idBuffer() {
                if (currentSubtree != null)
@@ -141,7 +137,6 @@ public class DirCacheIterator extends AbstractTreeIterator {
                return zeroid;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int idOffset() {
                if (currentSubtree != null)
@@ -151,7 +146,6 @@ public class DirCacheIterator extends AbstractTreeIterator {
                return 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void reset() {
                if (!first()) {
@@ -164,19 +158,16 @@ public class DirCacheIterator extends AbstractTreeIterator {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean first() {
                return ptr == treeStart;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean eof() {
                return ptr == treeEnd;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void next(int delta) {
                while (--delta >= 0) {
@@ -190,7 +181,6 @@ public class DirCacheIterator extends AbstractTreeIterator {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void back(int delta) {
                while (--delta >= 0) {
@@ -271,6 +261,7 @@ public class DirCacheIterator extends AbstractTreeIterator {
         * @return {@link org.eclipse.jgit.attributes.AttributesNode} for the
         *         current entry.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.7
         */
        public AttributesNode getEntryAttributesNode(ObjectReader reader)
index e0c1e93918ae112ca3a67a1df1c60af94f3b2a30..2561ae999ba5b61c9a57770c8ffdc23d4519c4f8 100644 (file)
@@ -534,7 +534,6 @@ public class DirCacheTree {
                return -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return getNameString();
index 4a535619d7fe5e05cb9886418a14721b56bd8000..40aa1c3b7c1745afc0c83a98d27ee114afd770b1 100644 (file)
@@ -84,7 +84,6 @@ public class LargeObjectException extends RuntimeException {
                        objectId = id.copy();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getMessage() {
                return MessageFormat.format(JGitText.get().largeObjectException,
index 084d67c02bd5efc54fda68384d580dd8d39c547d..83876ef03cdf358fbade4029a0565401533f9ed8 100644 (file)
@@ -44,7 +44,6 @@ public class RevisionSyntaxException extends IllegalArgumentException {
                this.revstr = revstr;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return super.toString() + ":" + revstr; //$NON-NLS-1$
index e6342542d0105370ce1924f352505043611558da..0c2aa46aa094eb0ed22739ac5f97895baf95cdd2 100644 (file)
@@ -14,13 +14,11 @@ package org.eclipse.jgit.events;
  * Describes a change to one or more keys in the configuration.
  */
 public class ConfigChangedEvent extends RepositoryEvent<ConfigChangedListener> {
-       /** {@inheritDoc} */
        @Override
        public Class<ConfigChangedListener> getListenerType() {
                return ConfigChangedListener.class;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void dispatch(ConfigChangedListener listener) {
                listener.onConfigChanged(this);
index f5a6d64b16ba7d08e6fccde683556cb5fc4b3775..64d285aca1fa996207d7292b0dc01c3b3a1d0a25 100644 (file)
@@ -36,13 +36,11 @@ public class IndexChangedEvent extends RepositoryEvent<IndexChangedListener> {
                return internal;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Class<IndexChangedListener> getListenerType() {
                return IndexChangedListener.class;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void dispatch(IndexChangedListener listener) {
                listener.onIndexChanged(this);
index 44897605db42852fbdf9b88bba20eab3563c2786..94d49fd93ea85472373dc01e58795a00e3082168 100644 (file)
@@ -35,7 +35,6 @@ public class ListenerHandle {
                parent.remove(this);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 476c37c1c397e8257792d80a067318a102a77151..92a227750fc09812f0a588a0e2b6697e2c758461 100644 (file)
@@ -71,6 +71,8 @@ public class ListenerList {
        /**
         * Add a listener to the list.
         *
+        * @param <T>
+        *            type of {@code RepositoryListener}
         * @param type
         *            type of listener being registered.
         * @param listener
index 6f1e8d5d663c483d6acf82315a466e272e4700dc..9bd1ef06539c4b81b2cb9acefb2c044cef0cd49f 100644 (file)
@@ -14,13 +14,11 @@ package org.eclipse.jgit.events;
  * Describes a change to one or more references of a repository.
  */
 public class RefsChangedEvent extends RepositoryEvent<RefsChangedListener> {
-       /** {@inheritDoc} */
        @Override
        public Class<RefsChangedListener> getListenerType() {
                return RefsChangedListener.class;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void dispatch(RefsChangedListener listener) {
                listener.onRefsChanged(this);
index 81f2e73de2b8a2928c2c0a770fd0b47888144535..288074e15f92c0e5a03ef8849ae62c62c007befc 100644 (file)
@@ -61,7 +61,6 @@ public abstract class RepositoryEvent<T extends RepositoryListener> {
         */
        public abstract void dispatch(T listener);
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index f9888eae3469468baaadf833290c3118c8e09f5d..c3275153eaae7468341530417ec864ec23a66d1f 100644 (file)
@@ -87,13 +87,11 @@ public class WorkingTreeModifiedEvent
                return result;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Class<WorkingTreeModifiedListener> getListenerType() {
                return WorkingTreeModifiedListener.class;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void dispatch(WorkingTreeModifiedListener listener) {
                listener.onWorkingTreeModified(this);
index d54bf65a27253d5e332a43b3a7953f59fad03d5b..8668ea9c0e459121016300a95320c8b7963d60b2 100644 (file)
@@ -45,7 +45,6 @@ abstract class AbstractHead implements Head {
                this.newHeads = newHeads;
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Head> getNextHeads(char c) {
                if (matches(c)) {
index faf4ee66c99e6c108ee9b772bb8c8bc106714b28..92fee621889f4b537effd42b47d6c97874ca60c3 100644 (file)
@@ -24,13 +24,11 @@ final class CharacterHead extends AbstractHead {
                this.expectedCharacter = expectedCharacter;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean matches(char c) {
                return c == expectedCharacter;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return String.valueOf(expectedCharacter);
index 5ffcafc41ea5bfa939e829faa5ff746b73073f1a..3b240c3b745c20a397328e4e5f72daca6555a3aa 100644 (file)
@@ -96,7 +96,6 @@ final class GroupHead extends AbstractHead {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean matches(char c) {
                for (CharacterPattern pattern : characterClasses) {
index 6aac3faab3bc77727d1d572b42ff2c5267ddf339..d4cc850a12820d588e8586001616573dd0036751 100644 (file)
@@ -22,7 +22,6 @@ final class LastHead implements Head {
                // defined because of javadoc and visibility modifier.
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Head> getNextHeads(char c) {
                return FileNameMatcher.EMPTY_HEAD_LIST;
index 14b6038c44af36692e2196e63599902b1122bc12..6b4526f82537abfd78c9d951fa034eb6f688c91f 100644 (file)
@@ -18,13 +18,11 @@ final class RestrictedWildCardHead extends AbstractHead {
                this.excludedCharacter = excludedCharacter;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean matches(char c) {
                return c != excludedCharacter;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return isStar() ? "*" : "?"; //$NON-NLS-1$ //$NON-NLS-2$
index 3665a70476a4ba1be5c15126135f7fbb6eb36839..62b6f42c524cb9e49a7c10eff5ecbe8ac9d5651e 100644 (file)
@@ -15,7 +15,6 @@ final class WildCardHead extends AbstractHead {
                super(star);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected final boolean matches(char c) {
                return true;
index aa69a05112fe45840f17cc1cb49cd968c336682d..957b3869f21f53d0135877e3e6e03aca7620ea44 100644 (file)
@@ -75,7 +75,9 @@ public class ManifestParser extends DefaultHandler {
                 *            The relative path to the file to read
                 * @return the {@code InputStream} of the file.
                 * @throws GitAPIException
+                *             a JGit API exception
                 * @throws IOException
+                *             if an IO error occurred
                 */
                public InputStream readIncludeFile(String path)
                                throws GitAPIException, IOException;
@@ -134,6 +136,7 @@ public class ManifestParser extends DefaultHandler {
         * @param inputStream
         *            a {@link java.io.InputStream} object.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void read(InputStream inputStream) throws IOException {
                xmlInRead++;
@@ -151,7 +154,6 @@ public class ManifestParser extends DefaultHandler {
                }
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public void startElement(
@@ -239,7 +241,6 @@ public class ManifestParser extends DefaultHandler {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void endElement(
                        String uri,
@@ -251,7 +252,6 @@ public class ManifestParser extends DefaultHandler {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void endDocument() throws SAXException {
                xmlInRead--;
index 6e943e5d3622abf0759106c36e669270432130a1..1ca3ce4501125652ec3ed68fc23375920ddfb05e 100644 (file)
@@ -105,6 +105,7 @@ public class RepoCommand extends GitCommand<RevCommit> {
                 * @return the sha1 of the remote repository, or null if the ref does
                 *         not exist.
                 * @throws GitAPIException
+                *             a JGit API exception
                 */
                @Nullable
                public ObjectId sha1(String uri, String ref) throws GitAPIException;
@@ -120,7 +121,10 @@ public class RepoCommand extends GitCommand<RevCommit> {
                 *            The relative path (inside the repo) to the file to read
                 * @return the file content.
                 * @throws GitAPIException
+                *             If the ref have an invalid or ambiguous name, or it does
+                *             not exist in the repository,
                 * @throws IOException
+                *             If the object does not exist or is too large
                 * @since 3.5
                 *
                 * @deprecated Use {@link #readFileWithMode(String, String, String)}
@@ -528,7 +532,6 @@ public class RepoCommand extends GitCommand<RevCommit> {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevCommit call() throws GitAPIException {
                checkCallable();
index c5ead0952377970641ec18601ae8793a4432ffa3..ad9538a90624dcb817f703460de849c9115f58f1 100644 (file)
@@ -93,6 +93,7 @@ public class RepoProject implements Comparable<RepoProject> {
                 * Do the copy file action.
                 *
                 * @throws IOException
+                *             if an IO error occurred
                 */
                public void copy() throws IOException {
                        File srcFile = new File(repo.getWorkTree(),
@@ -418,7 +419,6 @@ public class RepoProject implements Comparable<RepoProject> {
                return thatPath.startsWith(getPathWithSlash());
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object o) {
                if (o instanceof RepoProject) {
@@ -428,13 +428,11 @@ public class RepoProject implements Comparable<RepoProject> {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return this.getPathWithSlash().hashCode();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int compareTo(RepoProject that) {
                return this.getPathWithSlash().compareTo(that.getPathWithSlash());
index 023aef1c1ffe10214c1dd2cc1d97279031fa22ed..17fdd7e7cbc2735ca56b52c847dadf49fbd51935 100644 (file)
@@ -71,7 +71,6 @@ public class CommitMsgHook extends GitHook<String> {
                super(repo, outputStream, errorStream);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String call() throws IOException, AbortedByHookException {
                if (commitMessage == null) {
@@ -94,7 +93,6 @@ public class CommitMsgHook extends GitHook<String> {
                return getCommitEditMessageFilePath() != null && commitMessage != null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getHookName() {
                return NAME;
index b9dafcca3191578f98c1f56322cca72a369330c5..3988ee06ca14e483c7546e9a46a46ae5e237f517 100644 (file)
@@ -61,14 +61,12 @@ public class PostCommitHook extends GitHook<Void> {
                super(repo, outputStream, errorStream);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Void call() throws IOException, AbortedByHookException {
                doRun();
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getHookName() {
                return NAME;
index 321f4766207487b290770e6f5a2986f0590ab93d..b12ea83b995bef9b7c4fe903e74b113c66c2290b 100644 (file)
@@ -60,14 +60,12 @@ public class PreCommitHook extends GitHook<Void> {
                super(repo, outputStream, errorStream);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Void call() throws IOException, AbortedByHookException {
                doRun();
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getHookName() {
                return NAME;
index 43dbc37f4f36688da901497abd17501b682c8e63..e36312b3da1f4a4fcb481b978044e40db0126915 100644 (file)
@@ -74,13 +74,11 @@ public class PrePushHook extends GitHook<String> {
                super(repo, outputStream, errorStream);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected String getStdinArgs() {
                return refs;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String call() throws IOException, AbortedByHookException {
                if (canRun()) {
@@ -96,7 +94,6 @@ public class PrePushHook extends GitHook<String> {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getHookName() {
                return NAME;
index 9dd565ff0ac59ebae4fb6454aa33f4c761b6d999..b041729e2868a31c73fb0dd2666e5c4467675927 100644 (file)
@@ -208,7 +208,6 @@ public class FastIgnoreRule {
                return matcher == NO_MATCH;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder sb = new StringBuilder();
@@ -221,7 +220,6 @@ public class FastIgnoreRule {
 
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                final int prime = 31;
@@ -232,7 +230,6 @@ public class FastIgnoreRule {
                return result;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object obj) {
                if (this == obj)
index 4e7f126a60ade4e4f5dd1c9872f3e124e17d9b19..33dceb0717702053d84622c1713ed48cc487c186 100644 (file)
@@ -190,7 +190,6 @@ public class IgnoreNode {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return rules.toString();
index 0737ed88787320e6af68c935637cd4db3f517088..a3f365ea0eb785a24e200e7f9e67c9e9aa96be77 100644 (file)
@@ -33,19 +33,16 @@ public abstract class AbstractMatcher implements IMatcher {
                this.dirOnly = dirOnly;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return pattern;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return pattern.hashCode();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object obj) {
                if (this == obj)
index 73e2ad39773f2e1678428befd92fe853d9dfcd4e..84376be53ee3a829dbd6583481d8bc029307e13b 100644 (file)
@@ -22,7 +22,6 @@ public class LeadingAsteriskMatcher extends NameMatcher {
                                        "Pattern must have leading asterisk: " + pattern); //$NON-NLS-1$
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean matches(String segment, int startIncl, int endExcl) {
                // faster local access, same as in string.indexOf()
index 39fa74f6ea815297ade609490eb0e41ff788ff6c..4f8e149b4b60e65e0867e198b754f86627f17d41 100644 (file)
@@ -38,7 +38,6 @@ public class NameMatcher extends AbstractMatcher {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean matches(String path, boolean assumeDirectory,
                        boolean pathMatch) {
@@ -88,7 +87,6 @@ public class NameMatcher extends AbstractMatcher {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean matches(String segment, int startIncl, int endExcl) {
                // faster local access, same as in string.indexOf()
index ba77b3dd879e7b08be0e4ee2739a8fe021ff5088..a40568de08dbc1141bfe1d0acf077dd2efaf122c 100644 (file)
@@ -91,6 +91,7 @@ public class PathMatcher extends AbstractMatcher {
         *            a boolean.
         * @return never null
         * @throws org.eclipse.jgit.errors.InvalidPatternException
+        *             if pattern is invalid
         */
        public static IMatcher createPathMatcher(String pattern,
                        Character pathSeparator, boolean dirOnly)
@@ -149,7 +150,6 @@ public class PathMatcher extends AbstractMatcher {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean matches(String path, boolean assumeDirectory,
                        boolean pathMatch) {
@@ -192,7 +192,6 @@ public class PathMatcher extends AbstractMatcher {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean matches(String segment, int startIncl, int endExcl) {
                throw new UnsupportedOperationException(
index fbce08adf4872eea919c6ea4307adbea966ef840..3305a74af15dc754ef7a0d2022bccc411e104c95 100644 (file)
@@ -232,16 +232,19 @@ public class Strings {
                        .compile("\\[\\[[.=]\\w+[.=]\\]\\]"); //$NON-NLS-1$
 
        /**
-        * Conversion from glob to Java regex following two sources: <li>
-        * http://man7.org/linux/man-pages/man7/glob.7.html <li>
-        * org.eclipse.jgit.fnmatch.FileNameMatcher.java Seems that there are
+        * Conversion from glob to Java regex following two sources:
+        * <ul>
+        * <li>http://man7.org/linux/man-pages/man7/glob.7.html
+        * <li>org.eclipse.jgit.fnmatch.FileNameMatcher.java Seems that there are
         * various ways to define what "glob" can be.
+        * </ul>
         *
         * @param pattern
         *            non null pattern
         *
         * @return Java regex pattern corresponding to given glob pattern
         * @throws InvalidPatternException
+        *             if pattern is invalid
         */
        static Pattern convertGlob(String pattern) throws InvalidPatternException {
                if (UNSUPPORTED.matcher(pattern).find())
@@ -419,6 +422,7 @@ public class Strings {
 
        /**
         * @param buffer
+        *            buffer
         * @return zero of the buffer is empty, otherwise the last character from
         *         buffer
         */
@@ -427,10 +431,13 @@ public class Strings {
        }
 
        /**
+        * Lookahead next character after given index in pattern
+        *
         * @param pattern
+        *            the pattern
         * @param i
         *            current pointer in the pattern
-        * @return zero of the index is out of range, otherwise the next character
+        * @return zero if the index is out of range, otherwise the next character
         *         from given position
         */
        private static char lookAhead(String pattern, int i) {
index 7fa076b85527fe1499a0c9d61adf5f4f6defa45a..1f1c2232700165f4a8d79313a11d20cb4d37c7db 100644 (file)
@@ -22,7 +22,6 @@ public class TrailingAsteriskMatcher extends NameMatcher {
                                        "Pattern must have trailing asterisk: " + pattern); //$NON-NLS-1$
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean matches(String segment, int startIncl, int endExcl) {
                // faster local access, same as in string.indexOf()
index 76a88641c9e81da6cce4f9232b332cc8a89d94e7..d976f6ea5b4d671e7ee56c6791ba43feedb7aee5 100644 (file)
@@ -31,7 +31,6 @@ public class WildCardMatcher extends NameMatcher {
                p = convertGlob(subPattern);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean matches(String segment, int startIncl, int endExcl) {
                return p.matcher(segment.substring(startIncl, endExcl)).matches();
index 1baa9abf19a584a47e46555b36a3fc4379a10d33..606b585cdf264ea910d68ab257bd2b291d480391 100644 (file)
@@ -26,7 +26,6 @@ public final class WildMatcher extends AbstractMatcher {
                super(WILDMATCH, dirOnly);
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean matches(String path, boolean assumeDirectory,
                        boolean pathMatch) {
@@ -34,7 +33,6 @@ public final class WildMatcher extends AbstractMatcher {
                                || (!pathMatch && isSubdirectory(path));
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean matches(String segment, int startIncl, int endExcl) {
                return true;
index d65624fc6a9f29924202cc117886108d4cdf4833..ec4049a63eecbbb27f2a1b38f59b24f78650ef8d 100644 (file)
@@ -54,6 +54,7 @@ public class FilteredRenameDetector {
         *            Filter out changes that didn't affect this path.
         * @return The subset of changes that affect only the filtered path.
         * @throws IOException
+        *             if an IO error occurred
         */
        public List<DiffEntry> compute(List<DiffEntry> diffs,
                        PathFilter pathFilter) throws IOException {
@@ -73,6 +74,7 @@ public class FilteredRenameDetector {
         *            Filter out changes that didn't affect these paths.
         * @return The subset of changes that affect only the filtered paths.
         * @throws IOException
+        *             if an IO error occurred
         * @see RenameDetector#compute()
         */
        public List<DiffEntry> compute(List<DiffEntry> changes,
index ebef5247e658ee96923b628b588d844e3abc8353..3a729fb95f0dad146115274e9e909eb7b1f5bb24 100644 (file)
@@ -62,8 +62,11 @@ public class CommandExecutor {
         *            the environment
         * @return the execution result
         * @throws ToolException
+        *             if a tool raised an error
         * @throws InterruptedException
+        *             if thread was interrupted
         * @throws IOException
+        *             if an IO error occurred
         */
        public ExecutionResult run(String command, File workingDir,
                        Map<String, String> env)
@@ -109,8 +112,11 @@ public class CommandExecutor {
         *            the environment
         * @return the execution result
         * @throws ToolException
+        *             if a tool raised an error
         * @throws InterruptedException
+        *             if thread was interrupted
         * @throws IOException
+        *             if an IO error occurred
         */
        public boolean checkExecutable(String path, File workingDir,
                        Map<String, String> env)
index d0034df3bc432b0bc3da236432c13212b820b717..6a67bf3a1aee4b5fd25ffd4008f0103ee3755430 100644 (file)
@@ -172,6 +172,7 @@ public class DiffTools {
         *            the "trust exit code" option
         * @return the execution result from tool
         * @throws ToolException
+        *             when the tool fails
         */
        public ExecutionResult compare(FileElement localFile,
                        FileElement remoteFile, ExternalDiffTool tool,
@@ -244,6 +245,7 @@ public class DiffTools {
         *            path to the node in repository to parse git attributes for
         * @return name of the difftool if set
         * @throws ToolException
+        *             when the tool failed
         */
        public Optional<String> getExternalToolFromAttributes(final String path)
                        throws ToolException {
index b2dd846d70d42032c5382dd12807506d8189ab95..367107d0e802e373335e7782cd98075d184d98c0 100644 (file)
@@ -57,6 +57,7 @@ public class ExternalToolUtils {
         *            the base file (can be null)
         * @return the prepared (with replaced variables) command string
         * @throws IOException
+        *             if an IO error occurred
         */
        public static String prepareCommand(String command, FileElement localFile,
                        FileElement remoteFile, FileElement mergedFile,
@@ -91,6 +92,7 @@ public class ExternalToolUtils {
         *            the base file (can be null)
         * @return the environment map with variables and values (file paths)
         * @throws IOException
+        *             if an IO error occurred
         */
        public static Map<String, String> prepareEnvironment(File gitDir,
                        FileElement localFile, FileElement remoteFile,
@@ -209,6 +211,7 @@ public class ExternalToolUtils {
         *            config key name for the tool
         * @return attribute value for the given tool key if set
         * @throws ToolException
+        *             if the tool failed
         */
        public static Optional<String> getExternalToolFromAttributes(
                        final Repository repository, final String path,
index ba8ca54c58f46d5ea8137581b79a587da1c6cadb..0061e3f87824e7992b5bf0c7351d9152f6292043 100644 (file)
@@ -138,6 +138,7 @@ public class FileElement {
         *
         * @return the object stream
         * @throws IOException
+        *             if an IO error occurred
         */
        public File getFile() throws IOException {
                // if we have already temp file and no stream
@@ -179,6 +180,7 @@ public class FileElement {
         *            temporary directory is used
         * @return temporary file in directory or in the system temporary directory
         * @throws IOException
+        *             if an IO error occurred
         */
        public File createTempFile(File directory) throws IOException {
                if (tempFile == null) {
@@ -204,6 +206,7 @@ public class FileElement {
         *            the input string
         * @return the replaced input string
         * @throws IOException
+        *             if an IO error occurred
         */
        public String replaceVariable(String input) throws IOException {
                return input.replace("$" + type.name(), getFile().getPath()); //$NON-NLS-1$
@@ -215,6 +218,7 @@ public class FileElement {
         * @param env
         *            the environment where this element should be added
         * @throws IOException
+        *             if an IO error occurred
         */
        public void addToEnv(Map<String, String> env) throws IOException {
                env.put(type.name(), getFile().getPath());
index b903201264566b185e97a4e0b427feff2dc28edb..0da58e4a422a855ee48147b4a169227ce0201763 100644 (file)
@@ -184,6 +184,7 @@ public class MergeTools {
         *            the selected tool
         * @return the execution result from tool
         * @throws ToolException
+        *             if the tool failed
         */
        public ExecutionResult merge(FileElement localFile, FileElement remoteFile,
                        FileElement mergedFile, FileElement baseFile, File tempDir,
@@ -254,6 +255,7 @@ public class MergeTools {
         * @return the created temporary directory if (mergetol.writeToTemp == true)
         *         or null if not configured or false.
         * @throws IOException
+        *             if an IO error occurred
         */
        public File createTempDirectory() throws IOException {
                return config.isWriteToTemp()
@@ -305,6 +307,7 @@ public class MergeTools {
         *            path to the node in repository to parse git attributes for
         * @return name of the difftool if set
         * @throws ToolException
+        *             if the tool failed
         */
        public Optional<String> getExternalToolFromAttributes(final String path)
                        throws ToolException {
index e1169a2d60cff3b0e94082366a6300b66cb0c8de..c1d69b4f119e7b147940573de9bd114f8551aaa8 100644 (file)
@@ -43,6 +43,7 @@ public class PreDefinedDiffTool extends UserDefinedDiffTool {
 
        /**
         * @param path
+        *            path string
         */
        @Override
        public void setPath(String path) {
index 1dd2f0d7938d81f9494d2654a5a52ccf56334940..17d5b0b673bcd0c7a4d6bb8a8bcd47aa062e2001 100644 (file)
@@ -59,7 +59,7 @@ public class UserDefinedMergeTool extends UserDefinedDiffTool
        /**
         * @param withBase
         *            not used, because user-defined merge tool can only define one
-        *            cmd -> it must handle with and without base present (empty)
+        *            cmd -&gt; it must handle with and without base present (empty)
         * @return the tool command
         */
        @Override
index 3b94984561064f7ca400828ebd5e041c9e527aff..795f4404e8a615a9d3362233ae798469d6832897 100644 (file)
@@ -66,7 +66,6 @@ public class FsckPackParser extends PackParser {
                this.blockSize = channel.blockSize() > 0 ? channel.blockSize() : 65536;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onPackHeader(long objCnt) throws IOException {
                if (expectedObjectCount >= 0) {
@@ -78,48 +77,41 @@ public class FsckPackParser extends PackParser {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginWholeObject(long streamPosition, int type,
                        long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onObjectHeader(Source src, byte[] raw, int pos, int len)
                        throws IOException {
                crc.update(raw, pos, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onObjectData(Source src, byte[] raw, int pos, int len)
                        throws IOException {
                crc.update(raw, pos, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndWholeObject(PackedObjectInfo info) throws IOException {
                info.setCRC((int) crc.getValue());
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginOfsDelta(long deltaStreamPosition,
                        long baseStreamPosition, long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginRefDelta(long deltaStreamPosition, AnyObjectId baseId,
                        long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected UnresolvedDelta onEndDelta() throws IOException {
                UnresolvedDelta delta = new UnresolvedDelta();
@@ -127,14 +119,12 @@ public class FsckPackParser extends PackParser {
                return delta;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onInflatedObjectData(PackedObjectInfo obj, int typeCode,
                        byte[] data) throws IOException {
                // FsckPackParser ignores this event.
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void verifySafeObject(final AnyObjectId id, final int type,
                        final byte[] data) {
@@ -146,13 +136,11 @@ public class FsckPackParser extends PackParser {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onPackFooter(byte[] hash) throws IOException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean onAppendBase(int typeCode, byte[] data,
                        PackedObjectInfo info) throws IOException {
@@ -160,13 +148,11 @@ public class FsckPackParser extends PackParser {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndThinPack() throws IOException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        protected ObjectTypeAndSize seekDatabase(PackedObjectInfo obj,
                        ObjectTypeAndSize info) throws IOException {
@@ -175,7 +161,6 @@ public class FsckPackParser extends PackParser {
                return readObjectHeader(info);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected ObjectTypeAndSize seekDatabase(UnresolvedDelta delta,
                        ObjectTypeAndSize info) throws IOException {
@@ -184,7 +169,6 @@ public class FsckPackParser extends PackParser {
                return readObjectHeader(info);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected int readDatabase(byte[] dst, int pos, int cnt)
                        throws IOException {
@@ -229,13 +213,11 @@ public class FsckPackParser extends PackParser {
                return buf.array();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean checkCRC(int oldCRC) {
                return oldCRC == (int) crc.getValue();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onStoreStream(byte[] raw, int pos, int len)
                        throws IOException {
index 86d4722000e25170f2c63d8edbd42499f51b4155..84f1cb968a3dd15ba31a6cc121afed4a8543fa80 100644 (file)
@@ -40,7 +40,6 @@ public class AddToBitmapFilter extends RevFilter {
                this.bitmap = bitmap;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean include(RevWalk walker, RevCommit cmit) {
                Bitmap visitedBitmap;
@@ -61,13 +60,11 @@ public class AddToBitmapFilter extends RevFilter {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final RevFilter clone() {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean requiresCommitBody() {
                return false;
index d7ccadfbe7db8cd18887a092572c06af26b48b22..a95432ce73f6160df198a766844763e8a1c5574f 100644 (file)
@@ -53,7 +53,6 @@ public class AddToBitmapWithCacheFilter extends RevFilter {
                this.bitmap = bitmap;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean include(RevWalk rw, RevCommit c) {
                Bitmap visitedBitmap;
@@ -76,13 +75,11 @@ public class AddToBitmapWithCacheFilter extends RevFilter {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final RevFilter clone() {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean requiresCommitBody() {
                return false;
index da9f9d031ebb6e84dba5403412c18ccd83ecde3a..5ac267e789b08fb3637e1f727ec7bca9ec17f641 100644 (file)
@@ -48,7 +48,6 @@ public class AddUnseenToBitmapFilter extends RevFilter {
                this.bitmap = bitmap;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean include(RevWalk walker, RevCommit cmit) {
                Bitmap visitedBitmap;
@@ -69,13 +68,11 @@ public class AddUnseenToBitmapFilter extends RevFilter {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final RevFilter clone() {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean requiresCommitBody() {
                return false;
index 37721ad1ea43a1e18d09053bd4eb3fc7f46c6e4d..f5f51e48306d26251e8427a7c3bc11de3b0a76d0 100644 (file)
@@ -119,7 +119,6 @@ public class BitmappedReachabilityChecker implements ReachabilityChecker {
                        this.reached = repoBitmaps.newBitmapBuilder();
                }
 
-               /** {@inheritDoc} */
                @Override
                public final boolean include(RevWalk walker, RevCommit cmit) {
                        Bitmap commitBitmap;
@@ -149,13 +148,11 @@ public class BitmappedReachabilityChecker implements ReachabilityChecker {
                        }
                }
 
-               /** {@inheritDoc} */
                @Override
                public final RevFilter clone() {
                        throw new UnsupportedOperationException();
                }
 
-               /** {@inheritDoc} */
                @Override
                public final boolean requiresCommitBody() {
                        return false;
index 0796293f5286f79986abbb49ed0bb5afc259e2f3..7fb5956f97fca0f0e821a25de6424396e2b7fa3c 100644 (file)
@@ -32,25 +32,21 @@ public interface CommitGraph {
 
        /** Empty {@link CommitGraph} with no results. */
        CommitGraph EMPTY = new CommitGraph() {
-               /** {@inheritDoc} */
                @Override
                public int findGraphPosition(AnyObjectId commit) {
                        return -1;
                }
 
-               /** {@inheritDoc} */
                @Override
                public CommitData getCommitData(int graphPos) {
                        return null;
                }
 
-               /** {@inheritDoc} */
                @Override
                public ObjectId getObjectId(int graphPos) {
                        return null;
                }
 
-               /** {@inheritDoc} */
                @Override
                public long getCommitCnt() {
                        return 0;
index a074833fa5c71cd32db7d63c64d5e4ad678c8eb6..422d3be728d01fd769be8dd3dcc1b658b0a1de92 100644 (file)
@@ -41,15 +41,15 @@ class CommitGraphConstants {
        /** Mask to make the last edgeValue into position */
        static final int GRAPH_EDGE_LAST_MASK = 0x7fffffff;
 
-       /** EdgeValue & GRAPH_LAST_EDGE != 0 means it is the last edgeValue */
+       /** EdgeValue &amp; GRAPH_LAST_EDGE != 0 means it is the last edgeValue */
        static final int GRAPH_LAST_EDGE = 0x80000000;
 
        /** EdgeValue == GRAPH_NO_PARENT means it has no parents */
        static final int GRAPH_NO_PARENT = 0x70000000;
 
        /**
-        * EdgeValue & GRAPH_EXTRA_EDGES_NEEDED != 0 means its other parents are in
-        * Chunk Extra Edge List
+        * EdgeValue &amp; GRAPH_EXTRA_EDGES_NEEDED != 0 means its other parents are
+        * in Chunk Extra Edge List
         */
        static final int GRAPH_EXTRA_EDGES_NEEDED = 0x80000000;
 }
index da172192e45542d34b28997a21c5b4806f456c2a..d520139bce02c3988aad95f840703678fd02c05c 100644 (file)
@@ -29,13 +29,11 @@ class CommitGraphV1 implements CommitGraph {
                this.commitData = commitData;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int findGraphPosition(AnyObjectId commit) {
                return idx.findGraphPosition(commit);
        }
 
-       /** {@inheritDoc} */
        @Override
        public CommitData getCommitData(int graphPos) {
                if (graphPos < 0 || graphPos >= getCommitCnt()) {
@@ -44,13 +42,11 @@ class CommitGraphV1 implements CommitGraph {
                return commitData.getCommitData(graphPos);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getObjectId(int graphPos) {
                return idx.getObjectId(graphPos);
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getCommitCnt() {
                return idx.getCommitCnt();
index a58a9eb6329b0080dee46440b4c54baef040fef5..9a57f38a7d1dfa1cc127cc055f2317be055204d0 100644 (file)
@@ -81,6 +81,7 @@ public class CommitGraphWriter {
         *            buffered by the caller. The caller is responsible for closing
         *            the stream.
         * @throws IOException
+        *             if an error occurred
         */
        public void write(@NonNull ProgressMonitor monitor,
                        @NonNull OutputStream commitGraphStream) throws IOException {
index ccf6d0e66ae31a321fe775ded5b5de666c0606ce..a9a603ff57dab5af75c8c4651d875453f1135771 100644 (file)
@@ -56,6 +56,7 @@ public class GraphCommits implements Iterable<RevCommit> {
         * @return the commits' collection which are used by the commit-graph
         *         writer. Never null.
         * @throws IOException
+        *             if an error occurred
         */
        public static GraphCommits fromWalk(ProgressMonitor pm,
                        @NonNull Set<? extends ObjectId> wants, @NonNull RevWalk walk)
@@ -124,7 +125,6 @@ public class GraphCommits implements Iterable<RevCommit> {
                return sortedCommits.size();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<RevCommit> iterator() {
                return sortedCommits.iterator();
index cdfd3e9592b9d840d7c1c2d2f573b0b7e9ee7d73..68fc296d3e5209a65d1caa4f80d2ad347bd0ea68 100644 (file)
@@ -41,13 +41,11 @@ public class BeforeDfsPackIndexLoadedEvent
                return pack;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Class<BeforeDfsPackIndexLoadedListener> getListenerType() {
                return BeforeDfsPackIndexLoadedListener.class;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void dispatch(BeforeDfsPackIndexLoadedListener listener) {
                listener.onBeforeDfsPackIndexLoaded(this);
index 0a02180d7d5fbcd9d16ba64a865238ce4c81bbb5..99b9d556ad846156377ca27daed36d33d657a2c1 100644 (file)
@@ -847,6 +847,7 @@ public final class DfsBlockCache {
                /**
                 * @return ReadableChannel
                 * @throws IOException
+                *             if an IO error occurred
                 */
                ReadableChannel get() throws IOException;
        }
index 22959e9f6ba309807b4bfb7c820025184ebe622b..d6d3fbfd30cf132aea626676c0054af5f6ee0f53 100644 (file)
@@ -43,19 +43,16 @@ public class DfsCachedPack extends CachedPack {
                return pack.getPackDescription();
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getObjectCount() throws IOException {
                return getPackDescription().getObjectCount();
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getDeltaCount() throws IOException {
                return getPackDescription().getDeltaCount();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasObject(ObjectToPack obj, StoredObjectRepresentation rep) {
                return ((DfsObjectRepresentation) rep).pack == pack;
index 2ee23f8627d158add1e0b3c8573f7ae713e4f75e..4f0e4a55d464c0e6d961161cddddf4c09543bbec 100644 (file)
@@ -22,13 +22,11 @@ import org.eclipse.jgit.lib.StoredConfig;
  * simply clears the config, and saving does nothing.
  */
 public final class DfsConfig extends StoredConfig {
-       /** {@inheritDoc} */
        @Override
        public void load() throws IOException, ConfigInvalidException {
                clear();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void save() throws IOException {
                // TODO actually store this configuration.
index a2fb67ff0b17bdaec24019ddda30359104c24a6a..ceb1769dec82d79098341a6201dee9369f21b496 100644 (file)
@@ -106,19 +106,16 @@ public class DfsInserter extends ObjectInserter {
                this.compression = compression;
        }
 
-       /** {@inheritDoc} */
        @Override
        public DfsPackParser newPackParser(InputStream in) throws IOException {
                return new DfsPackParser(db, this, in);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectReader newReader() {
                return new Reader();
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId insert(int type, byte[] data, int off, int len)
                        throws IOException {
@@ -135,7 +132,6 @@ public class DfsInserter extends ObjectInserter {
                return endObject(id, offset);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId insert(int type, long len, InputStream in)
                        throws IOException {
@@ -178,7 +174,6 @@ public class DfsInserter extends ObjectInserter {
                return buf;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                if (packDsc == null)
@@ -206,7 +201,6 @@ public class DfsInserter extends ObjectInserter {
                clear();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                if (packOut != null) {
index 46ec87df54c5b5ef5051b4ed2b6614a2a9c41953..faeafceec079d25df4c49b76c5f6d647634910ce 100644 (file)
@@ -241,13 +241,11 @@ public abstract class DfsObjDatabase extends ObjectDatabase {
                this.packComparator = packComparator;
        }
 
-       /** {@inheritDoc} */
        @Override
        public DfsReader newReader() {
                return new DfsReader(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectInserter newInserter() {
                return new DfsInserter(this);
@@ -657,7 +655,6 @@ public abstract class DfsObjDatabase extends ObjectDatabase {
                packList.set(NO_PACKS);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                packList.set(NO_PACKS);
index 8e124e3c20f8680b93105a6260b9cd214b12e5fe..885582fae2372e7f50f50c227e6e8b38ca03fc3e 100644 (file)
@@ -24,25 +24,21 @@ class DfsObjectRepresentation extends StoredObjectRepresentation {
                this.pack = pack;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getFormat() {
                return format;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getWeight() {
                return (int) Math.min(length, Integer.MAX_VALUE);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getDeltaBase() {
                return baseId;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean wasDeltaAttempted() {
                switch (pack.getPackDescription().getPackSource()) {
index 10fa2365bdb74627673c30a11ef14c3d45b67919..c2feab8cd3274ee8be5a582902a33dfbe0419e50 100644 (file)
@@ -39,14 +39,12 @@ class DfsObjectToPack extends ObjectToPack {
                setExtendedFlag(FLAG_FOUND);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void clearReuseAsIs() {
                super.clearReuseAsIs();
                pack = null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void select(StoredObjectRepresentation ref) {
                DfsObjectRepresentation ptr = (DfsObjectRepresentation) ref;
index 7cf91a48824c51a985bac56b43dc7d3b0ddbbb56..c74a1e1d7df3ca27a5ba52124b4db6fb01ba6da1 100644 (file)
@@ -39,13 +39,11 @@ public abstract class DfsOutputStream extends OutputStream {
                return 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                write(new byte[] { (byte) b });
        }
 
-       /** {@inheritDoc} */
        @Override
        public abstract void write(byte[] buf, int off, int len) throws IOException;
 
index 4f418ab4dbcec839fdb9296a06ef88bd11765035..f012b8bca5f6c081cea6b9d73368aa5a0667a5a4 100644 (file)
@@ -512,13 +512,11 @@ public class DfsPackDescription {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return packName.hashCode();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object b) {
                if (b instanceof DfsPackDescription) {
@@ -539,7 +537,6 @@ public class DfsPackDescription {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return getFileName(PackExt.PACK);
index d8e191c4e0009b068c90d9be1fd9f051b924b832..1a438e415cb5af90c6f60ec5229bb219f3c37bbe 100644 (file)
@@ -101,7 +101,6 @@ public class DfsPackParser extends PackParser {
                this.packDigest = Constants.newMessageDigest();
        }
 
-       /** {@inheritDoc} */
        @Override
        public PackLock parse(ProgressMonitor receiving, ProgressMonitor resolving)
                        throws IOException {
@@ -172,7 +171,6 @@ public class DfsPackParser extends PackParser {
                return packDsc;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onPackHeader(long objectCount) throws IOException {
                if (objectCount == 0) {
@@ -194,34 +192,29 @@ public class DfsPackParser extends PackParser {
                currBuf = new byte[blockSize];
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginWholeObject(long streamPosition, int type,
                        long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndWholeObject(PackedObjectInfo info) throws IOException {
                info.setCRC((int) crc.getValue());
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginOfsDelta(long streamPosition,
                        long baseStreamPosition, long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginRefDelta(long streamPosition, AnyObjectId baseId,
                        long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected UnresolvedDelta onEndDelta() throws IOException {
                UnresolvedDelta delta = new UnresolvedDelta();
@@ -229,28 +222,24 @@ public class DfsPackParser extends PackParser {
                return delta;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onInflatedObjectData(PackedObjectInfo obj, int typeCode,
                        byte[] data) throws IOException {
                // DfsPackParser ignores this event.
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onObjectHeader(Source src, byte[] raw, int pos, int len)
                        throws IOException {
                crc.update(raw, pos, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onObjectData(Source src, byte[] raw, int pos, int len)
                        throws IOException {
                crc.update(raw, pos, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onStoreStream(byte[] raw, int pos, int len)
                        throws IOException {
@@ -297,7 +286,6 @@ public class DfsPackParser extends PackParser {
                return v;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onPackFooter(byte[] hash) throws IOException {
                // The base class will validate the original hash matches
@@ -307,7 +295,6 @@ public class DfsPackParser extends PackParser {
                packHash = hash;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected ObjectTypeAndSize seekDatabase(PackedObjectInfo obj,
                        ObjectTypeAndSize info) throws IOException {
@@ -316,7 +303,6 @@ public class DfsPackParser extends PackParser {
                return readObjectHeader(info);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected ObjectTypeAndSize seekDatabase(UnresolvedDelta delta,
                        ObjectTypeAndSize info) throws IOException {
@@ -325,7 +311,6 @@ public class DfsPackParser extends PackParser {
                return readObjectHeader(info);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected int readDatabase(byte[] dst, int pos, int cnt) throws IOException {
                if (cnt == 0)
@@ -381,13 +366,11 @@ public class DfsPackParser extends PackParser {
                return (pos / blockSize) * blockSize;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean checkCRC(int oldCRC) {
                return oldCRC == (int) crc.getValue();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean onAppendBase(final int typeCode, final byte[] data,
                        final PackedObjectInfo info) throws IOException {
@@ -427,7 +410,6 @@ public class DfsPackParser extends PackParser {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndThinPack() throws IOException {
                // Normally when a thin pack is closed the pack header gets
index 750c118268c5b0b4a0188eaaf84ec237ca4cd79d..f4e863d02da629d26de62dab866aec152445e5dd 100644 (file)
@@ -18,13 +18,11 @@ import org.eclipse.jgit.events.RepositoryEvent;
  */
 public class DfsPacksChangedEvent
                extends RepositoryEvent<DfsPacksChangedListener> {
-       /** {@inheritDoc} */
        @Override
        public Class<DfsPacksChangedListener> getListenerType() {
                return DfsPacksChangedListener.class;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void dispatch(DfsPacksChangedListener listener) {
                listener.onPacksChanged(this);
index 8d8a766b0f39aa20e5961a6b649f36735021345b..56fe5d50879adf225d8b2fa9b32b4aa1a658eca4 100644 (file)
@@ -100,19 +100,16 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return baseCache;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectReader newReader() {
                return db.newReader();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setAvoidUnreachableObjects(boolean avoid) {
                avoidUnreachable = avoid;
        }
 
-       /** {@inheritDoc} */
        @Override
        public BitmapIndex getBitmapIndex() throws IOException {
                for (DfsPackFile pack : db.getPacks()) {
@@ -123,7 +120,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Optional<CommitGraph> getCommitGraph() throws IOException {
                for (DfsPackFile pack : db.getPacks()) {
@@ -135,7 +131,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return Optional.empty();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<CachedPack> getCachedPacksAndUpdate(
                BitmapBuilder needBitmap) throws IOException {
@@ -148,7 +143,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return Collections.emptyList();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<ObjectId> resolve(AbbreviatedObjectId id)
                        throws IOException {
@@ -177,7 +171,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean has(AnyObjectId objectId) throws IOException {
                if (last != null
@@ -207,7 +200,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectLoader open(AnyObjectId objectId, int typeHint)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -262,7 +254,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Set<ObjectId> getShallowCommits() {
                return Collections.emptySet();
@@ -370,7 +361,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return avoidUnreachable && pack.isGarbage();
        }
 
-       /** {@inheritDoc} */
        @Override
        public <T extends ObjectId> AsyncObjectLoaderQueue<T> open(
                        Iterable<T> objectIds, final boolean reportMissing) {
@@ -430,7 +420,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                };
        }
 
-       /** {@inheritDoc} */
        @Override
        public <T extends ObjectId> AsyncObjectSizeQueue<T> getObjectSize(
                        Iterable<T> objectIds, final boolean reportMissing) {
@@ -492,7 +481,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                };
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getObjectSize(AnyObjectId objectId, int typeHint)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -538,7 +526,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public DfsObjectToPack newObjectToPack(AnyObjectId objectId, int type) {
                return new DfsObjectToPack(objectId, type);
@@ -642,7 +629,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                return tmp;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void copyObjectAsIs(PackOutputStream out, ObjectToPack otp,
                        boolean validate) throws IOException,
@@ -651,7 +637,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                src.pack.copyAsIs(out, src, validate, this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeObjects(PackOutputStream out, List<ObjectToPack> list)
                        throws IOException {
@@ -659,7 +644,6 @@ public class DfsReader extends ObjectReader implements ObjectReuseAsIs {
                        out.writeObject(otp);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void copyPackAsIs(PackOutputStream out, CachedPack pack)
                        throws IOException {
index ae656707ac2ffecac8e6a98e312cdb9e30b60737..b52456225c5604123c17bb27f9956d05db8e7cf5 100644 (file)
@@ -65,7 +65,6 @@ public abstract class DfsRefDatabase extends RefDatabase {
                return 0 < read().size();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref exactRef(String name) throws IOException {
                RefCache curr = read();
@@ -73,13 +72,11 @@ public abstract class DfsRefDatabase extends RefDatabase {
                return ref != null ? resolve(ref, 0, curr.ids) : null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> getAdditionalRefs() {
                return Collections.emptyList();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, Ref> getRefs(String prefix) throws IOException {
                RefCache curr = read();
@@ -126,7 +123,6 @@ public abstract class DfsRefDatabase extends RefDatabase {
                return new SymbolicRef(ref.getName(), dst);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref peel(Ref ref) throws IOException {
                final Ref oldLeaf = ref.getLeaf();
@@ -176,7 +172,6 @@ public abstract class DfsRefDatabase extends RefDatabase {
                return leaf;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefUpdate newUpdate(String refName, boolean detach)
                        throws IOException {
@@ -193,7 +188,6 @@ public abstract class DfsRefDatabase extends RefDatabase {
                return update;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefRename newRename(String fromName, String toName)
                        throws IOException {
@@ -202,7 +196,6 @@ public abstract class DfsRefDatabase extends RefDatabase {
                return new DfsRefRename(src, dst);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isNameConflicting(String refName) throws IOException {
                RefList<Ref> all = read().ids;
@@ -224,19 +217,16 @@ public abstract class DfsRefDatabase extends RefDatabase {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void create() {
                // Nothing to do.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void refresh() {
                clearCache();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                clearCache();
index 569803575dfd13860ab3a7dc3251e8b48b9b5462..e76b0bc142d1ed7bcadfb0f8676e44590b7ff11d 100644 (file)
@@ -22,7 +22,6 @@ final class DfsRefRename extends RefRename {
                super(src, dst);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Result doRename() throws IOException {
                // TODO Correctly handle renaming foo/bar to foo.
index 28331a08e626feb870754831aee734b07e3f121f..f32703412309a4d8b768613dc13eba82f4c98754 100644 (file)
@@ -33,19 +33,16 @@ final class DfsRefUpdate extends RefUpdate {
                this.refdb = refdb;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected DfsRefDatabase getRefDatabase() {
                return refdb;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected DfsRepository getRepository() {
                return refdb.getRepository();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean tryLock(boolean deref) throws IOException {
                dstRef = getRef();
@@ -60,13 +57,11 @@ final class DfsRefUpdate extends RefUpdate {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void unlock() {
                // No state is held while "locked".
        }
 
-       /** {@inheritDoc} */
        @Override
        public Result update(RevWalk walk) throws IOException {
                try {
@@ -77,7 +72,6 @@ final class DfsRefUpdate extends RefUpdate {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Result doUpdate(Result desiredResult) throws IOException {
                ObjectIdRef newRef;
@@ -102,7 +96,6 @@ final class DfsRefUpdate extends RefUpdate {
                return Result.LOCK_FAILURE;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Result doDelete(Result desiredResult) throws IOException {
                if (getRefDatabase().compareAndRemove(dstRef)) {
@@ -112,7 +105,6 @@ final class DfsRefUpdate extends RefUpdate {
                return Result.LOCK_FAILURE;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Result doLink(String target) throws IOException {
                final SymbolicRef newRef = new SymbolicRef(
index 6c3b056efda3c82aa76c1f020587d1350ce1cc6d..3ba74b26fc0c84f44eb1b1559a5089a3be2296e0 100644 (file)
@@ -75,19 +75,16 @@ public class DfsReftableDatabase extends DfsRefDatabase {
                stack = null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasVersioning() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean performsAtomicTransactions() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public BatchRefUpdate newBatchUpdate() {
                DfsObjDatabase odb = getRepository().getObjectDatabase();
@@ -151,13 +148,11 @@ public class DfsReftableDatabase extends DfsRefDatabase {
                return reftableDatabase.isNameConflicting(refName, new TreeSet<>(), new HashSet<>());
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref exactRef(String name) throws IOException {
                return reftableDatabase.exactRef(name);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, Ref> getRefs(String prefix) throws IOException {
                List<Ref> refs = reftableDatabase.getRefsByPrefix(prefix);
@@ -169,21 +164,18 @@ public class DfsReftableDatabase extends DfsRefDatabase {
                        RefList.emptyList());
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> getRefsByPrefix(String prefix) throws IOException {
 
                return reftableDatabase.getRefsByPrefix(prefix);
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> getRefsByPrefixWithExclusions(String include, Set<String> excludes)
                        throws IOException {
                return reftableDatabase.getRefsByPrefixWithExclusions(include, excludes);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Set<Ref> getTipsWithSha1(ObjectId id) throws IOException {
                if (!getReftableConfig().isIndexObjects()) {
@@ -192,13 +184,11 @@ public class DfsReftableDatabase extends DfsRefDatabase {
                return reftableDatabase.getTipsWithSha1(id);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasFastTipsWithSha1() throws IOException {
                return reftableDatabase.hasFastTipsWithSha1();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref peel(Ref ref) throws IOException {
                Ref oldLeaf = ref.getLeaf();
@@ -233,7 +223,6 @@ public class DfsReftableDatabase extends DfsRefDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean compareAndPut(Ref oldRef, @Nullable Ref newRef)
                        throws IOException {
@@ -254,13 +243,11 @@ public class DfsReftableDatabase extends DfsRefDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean compareAndRemove(Ref oldRef) throws IOException {
                return compareAndPut(oldRef, null);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected RefCache scanAllRefs() throws IOException {
                throw new UnsupportedOperationException();
@@ -276,7 +263,6 @@ public class DfsReftableDatabase extends DfsRefDatabase {
                // Unnecessary; DfsReftableBatchRefUpdate calls clearCache().
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void cachePeeledState(Ref oldLeaf, Ref newLeaf) {
                // Do not cache peeled state in reftable.
index 27b03299e49e6bad691b2f70a15d4e692a04b916..97ba4d52ebaf36a1a14819c5268f02f83af4a514 100644 (file)
@@ -80,7 +80,6 @@ public class DfsReftableStack implements AutoCloseable {
                return Collections.unmodifiableList(tables);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                for (ReftableReader t : tables) {
index 32c0ccdf4f81d1f7e4159decdfb95e0c13455dba..218f1e95525a84ec8e93376bab628cb00ee89004 100644 (file)
@@ -45,7 +45,6 @@ public abstract class DfsRepository extends Repository {
                this.description = builder.getRepositoryDescription();
        }
 
-       /** {@inheritDoc} */
        @Override
        public abstract DfsObjDatabase getObjectDatabase();
 
@@ -72,7 +71,6 @@ public abstract class DfsRepository extends Repository {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void create(boolean bare) throws IOException {
                if (exists())
@@ -85,39 +83,33 @@ public abstract class DfsRepository extends Repository {
                        throw new IOException(result.name());
        }
 
-       /** {@inheritDoc} */
        @Override
        public StoredConfig getConfig() {
                return config;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getIdentifier() {
                return getDescription().getRepositoryName();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void scanForRepoChanges() throws IOException {
                getRefDatabase().refresh();
                getObjectDatabase().clearCache();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void notifyIndexChanged(boolean internal) {
                // Do not send notifications.
                // There is no index, as there is no working tree.
        }
 
-       /** {@inheritDoc} */
        @Override
        public ReflogReader getReflogReader(String refName) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public AttributesNodeProvider createAttributesNodeProvider() {
                // TODO Check if the implementation used in FileRepository can be used
index 943d92684b0cf2f90b130e99f65d2d34b71f7d1f..ab5f7fe75eb597fcb152ec8285a8b648d3bfd150 100644 (file)
@@ -72,7 +72,6 @@ public abstract class DfsRepositoryBuilder<B extends DfsRepositoryBuilder, R ext
                return self();
        }
 
-       /** {@inheritDoc} */
        @Override
        public B setup() throws IllegalArgumentException, IOException {
                super.setup();
@@ -97,7 +96,6 @@ public abstract class DfsRepositoryBuilder<B extends DfsRepositoryBuilder, R ext
 
        // We don't support local file IO and thus shouldn't permit these to set.
 
-       /** {@inheritDoc} */
        @Override
        public B setGitDir(File gitDir) {
                if (gitDir != null)
@@ -105,7 +103,6 @@ public abstract class DfsRepositoryBuilder<B extends DfsRepositoryBuilder, R ext
                return self();
        }
 
-       /** {@inheritDoc} */
        @Override
        public B setObjectDirectory(File objectDirectory) {
                if (objectDirectory != null)
@@ -113,14 +110,12 @@ public abstract class DfsRepositoryBuilder<B extends DfsRepositoryBuilder, R ext
                return self();
        }
 
-       /** {@inheritDoc} */
        @Override
        public B addAlternateObjectDirectory(File other) {
                throw new UnsupportedOperationException(
                                JGitText.get().unsupportedAlternates);
        }
 
-       /** {@inheritDoc} */
        @Override
        public B setWorkTree(File workTree) {
                if (workTree != null)
@@ -128,7 +123,6 @@ public abstract class DfsRepositoryBuilder<B extends DfsRepositoryBuilder, R ext
                return self();
        }
 
-       /** {@inheritDoc} */
        @Override
        public B setIndexFile(File indexFile) {
                if (indexFile != null)
index 069956b5860b150f103fd0a1f5b7c12f100605f4..e949085819e4d48df58ab1e707f7e78bac350cdf 100644 (file)
@@ -42,7 +42,6 @@ public class DfsRepositoryDescription {
                return repositoryName;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                if (getRepositoryName() != null)
@@ -50,7 +49,6 @@ public class DfsRepositoryDescription {
                return System.identityHashCode(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object b) {
                if (b instanceof DfsRepositoryDescription){
@@ -61,7 +59,6 @@ public class DfsRepositoryDescription {
                return false;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index f3f30914f6af8c5db61768f1a59c9bd2c976021c..8983c2d2ebf8de593d4e765a61ed8013e1c77cfc 100644 (file)
@@ -56,17 +56,14 @@ public abstract class DfsStreamKey {
                this.packExtPos = ext == null ? 0 : ext.getPosition();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return hash;
        }
 
-       /** {@inheritDoc} */
        @Override
        public abstract boolean equals(Object o);
 
-       /** {@inheritDoc} */
        @SuppressWarnings("boxing")
        @Override
        public String toString() {
index 583b8b3f6b7a14829bc57fcfc173993be9b5203f..734a5fca3d05352dd292605e869151961a75d1ab 100644 (file)
@@ -78,13 +78,11 @@ public class InMemoryRepository extends DfsRepository {
                return new MemRefDatabase();
        }
 
-       /** {@inheritDoc} */
        @Override
        public MemObjDatabase getObjectDatabase() {
                return objdb;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefDatabase getRefDatabase() {
                return refdb;
@@ -102,14 +100,12 @@ public class InMemoryRepository extends DfsRepository {
                refdb.performsAtomicTransactions = atomic;
        }
 
-       /** {@inheritDoc} */
        @Override
        @Nullable
        public String getGitwebDescription() {
                return gitwebDescription;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setGitwebDescription(@Nullable String d) {
                gitwebDescription = d;
index cd4f168d8680bdad22c8f2baabe18418b7322a32..89a3afbd9bfde8bed968ff750768f904c41a70ae 100644 (file)
@@ -44,31 +44,26 @@ final class LargePackedWholeObject extends ObjectLoader {
                this.db = db;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getType() {
                return type;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getSize() {
                return size;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isLarge() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public byte[] getCachedBytes() throws LargeObjectException {
                throw new LargeObjectException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectStream openStream() throws MissingObjectException, IOException {
                PackInputStream packIn;
index 6ff81646cf93aeb7cd42bbf768ea0a7bc8166517..3d07660a60b37da358ec42078e60e727ae494876 100644 (file)
@@ -31,7 +31,6 @@ final class PackInputStream extends InputStream {
                ctx.pin(pack, pos);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] b, int off, int len) throws IOException {
                int n = ctx.copy(pack, pos, b, off, len);
@@ -39,7 +38,6 @@ final class PackInputStream extends InputStream {
                return n;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                byte[] buf = new byte[1];
@@ -47,7 +45,6 @@ final class PackInputStream extends InputStream {
                return n == 1 ? buf[0] & 0xff : -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                ctx.close();
index ec53818b4eb3bf9ed8929176c6718fa24cc282b6..53e36956c8d8e1fdfe6c859c7ac4464052ce6eb7 100644 (file)
@@ -25,7 +25,6 @@ abstract class BasePackBitmapIndex extends PackBitmapIndex {
                this.bitmaps = bitmaps;
        }
 
-       /** {@inheritDoc} */
        @Override
        public EWAHCompressedBitmap getBitmap(AnyObjectId objectId) {
                StoredBitmap sb = bitmaps.get(objectId);
index 9aa14171c726b0d3698d485f30dd079bb2742443..55c05ef78d9255b037149ed9960afd735440f19c 100644 (file)
@@ -54,7 +54,6 @@ public class BitmapIndexImpl implements BitmapIndex {
                return packIndex;
        }
 
-       /** {@inheritDoc} */
        @Override
        public CompressedBitmap getBitmap(AnyObjectId objectId) {
                EWAHCompressedBitmap compressed = packIndex.getBitmap(objectId);
@@ -63,7 +62,6 @@ public class BitmapIndexImpl implements BitmapIndex {
                return new CompressedBitmap(compressed, this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public CompressedBitmapBuilder newBitmapBuilder() {
                return new CompressedBitmapBuilder(this);
@@ -291,7 +289,9 @@ public class BitmapIndexImpl implements BitmapIndex {
                 * Construct compressed bitmap for given bitmap and bitmap index
                 *
                 * @param bitmap
+                *            the bitmap
                 * @param bitmapIndex
+                *            the bitmap index
                 */
                public CompressedBitmap(EWAHCompressedBitmap bitmap, BitmapIndexImpl bitmapIndex) {
                        this.bitmap = bitmap;
index 103653542344960bdf1789b77b76d74e8c1cee07..ef1392e6e0506c77c52c00b5b96be05dd2a762bb 100644 (file)
@@ -30,7 +30,6 @@ final class ByteArrayWindow extends ByteWindow {
                array = b;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected int copy(int p, byte[] b, int o, int n) {
                n = Math.min(array.length - p, n);
@@ -38,7 +37,6 @@ final class ByteArrayWindow extends ByteWindow {
                return n;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected int setInput(int pos, Inflater inf)
                        throws DataFormatException {
index b6877578c9e196b34c54bc399703f107135d40b2..4094f130f6deb3a565b5431b2eb98b936a316e9c 100644 (file)
@@ -32,7 +32,6 @@ final class ByteBufferWindow extends ByteWindow {
                buffer = b;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected int copy(int p, byte[] b, int o, int n) {
                final ByteBuffer s = buffer.slice();
@@ -57,7 +56,6 @@ final class ByteBufferWindow extends ByteWindow {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected int setInput(int pos, Inflater inf)
                        throws DataFormatException {
index 2e19580f5f91d904e668fa8abb99e9ef92f9d391..129d2e0894347b786e06076ed56296a78b3c6c0a 100644 (file)
@@ -86,13 +86,11 @@ class CachedObjectDirectory extends FileObjectDatabase {
                return m;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                // Don't close anything.
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectDatabase newCachedDatabase() {
                return this;
@@ -153,7 +151,6 @@ class CachedObjectDirectory extends FileObjectDatabase {
                wrapped.resolve(matches, id);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean has(AnyObjectId objectId) throws IOException {
                return has(objectId, null);
@@ -261,7 +258,6 @@ class CachedObjectDirectory extends FileObjectDatabase {
                return wrapped.getPacks();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Optional<CommitGraph> getCommitGraph() {
                return wrapped.getCommitGraph();
index 2b8779f6dfcabef18f33199024e8b127b8dc182f..d641da59e144bb3a6a98c53591316fa226a82a5c 100644 (file)
@@ -32,13 +32,11 @@ public class CheckoutEntryImpl implements CheckoutEntry {
                to = comment.substring(p2 + " to ".length(), p3); //$NON-NLS-1$
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getFromBranch() {
                return from;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getToBranch() {
                return to;
index aa578d31baa6839ae0ce796acfdf2c9bd34b95d8..e8f532fe24e29c82680edd995d61b809314954b0 100644 (file)
@@ -33,13 +33,11 @@ abstract class FileObjectDatabase extends ObjectDatabase {
                INSERTED, EXISTS_PACKED, EXISTS_LOOSE, FAILURE;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectReader newReader() {
                return new WindowCursor(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectDirectoryInserter newInserter() {
                return new ObjectDirectoryInserter(this, getConfig());
index e9e17c0ec5f44e6f4cdc904281d38e29532b1615..3abd71aee61e4a8d8706d939d1528ec6e08e0157 100644 (file)
@@ -93,13 +93,13 @@ public class FileReftableDatabase extends RefDatabase {
 
        /**
         * @param repoDir
+        *            the repository's metadata directory
         * @return whether the given repo uses reftable for refdb storage.
         */
        public static boolean isReftable(File repoDir) {
                return new File(repoDir, Constants.REFTABLE).isDirectory();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasFastTipsWithSha1() throws IOException {
                return reftableDatabase.hasFastTipsWithSha1();
@@ -124,20 +124,17 @@ public class FileReftableDatabase extends RefDatabase {
                return reftableDatabase.getLock();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean performsAtomicTransactions() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @NonNull
        @Override
        public BatchRefUpdate newBatchUpdate() {
                return new FileReftableBatchRefUpdate(this, fileRepository);
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefUpdate newUpdate(String refName, boolean detach)
                        throws IOException {
@@ -157,19 +154,16 @@ public class FileReftableDatabase extends RefDatabase {
                return update;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref exactRef(String name) throws IOException {
                return reftableDatabase.exactRef(name);
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> getRefs() throws IOException {
                return super.getRefs();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, Ref> getRefs(String prefix) throws IOException {
                List<Ref> refs = reftableDatabase.getRefsByPrefix(prefix);
@@ -181,20 +175,17 @@ public class FileReftableDatabase extends RefDatabase {
                                RefList.emptyList());
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> getRefsByPrefixWithExclusions(String include, Set<String> excludes)
                        throws IOException {
                return reftableDatabase.getRefsByPrefixWithExclusions(include, excludes);
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> getAdditionalRefs() throws IOException {
                return Collections.emptyList();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref peel(Ref ref) throws IOException {
                Ref oldLeaf = ref.getLeaf();
@@ -303,7 +294,6 @@ public class FileReftableDatabase extends RefDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefRename newRename(String fromName, String toName)
                        throws IOException {
@@ -312,20 +302,17 @@ public class FileReftableDatabase extends RefDatabase {
                return new FileRefRename(src, dst);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isNameConflicting(String name) throws IOException {
                return reftableDatabase.isNameConflicting(name, new TreeSet<>(),
                                new HashSet<>());
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                reftableStack.close();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void create() throws IOException {
                FileUtils.mkdir(
index 5152367d23ab2b539cba0a14fd556a3efbedc399..c74a298429799e3141c54197bc60a1ed3943589b 100644 (file)
@@ -264,6 +264,7 @@ public class FileReftableStack implements AutoCloseable {
                 * @param w
                 *            writer to use
                 * @throws IOException
+                *             if an IO error occurred
                 */
                void call(ReftableWriter w) throws IOException;
        }
@@ -559,6 +560,7 @@ public class FileReftableStack implements AutoCloseable {
         * Calculate an approximate log2.
         *
         * @param sz
+        *            the number to compute an approximate log2 for
         * @return log2
         */
        static int log(long sz) {
@@ -688,6 +690,7 @@ public class FileReftableStack implements AutoCloseable {
         * shape.
         *
         * @throws IOException
+        *             if an IO error occurred
         */
        private void autoCompact() throws IOException {
                Optional<Segment> cand = autoCompactCandidate(tableSizes());
index 3e92cddacda72c24b554be407024f1a24eda8e10..e5a00d39258cd0a7fb0d480e11787da78085309f 100644 (file)
@@ -321,19 +321,16 @@ public class FileRepository extends Repository {
                return objectDatabase.getDirectory();
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectDirectory getObjectDatabase() {
                return objectDatabase;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefDatabase getRefDatabase() {
                return refs;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getIdentifier() {
                File directory = getDirectory();
@@ -343,7 +340,6 @@ public class FileRepository extends Repository {
                throw new IllegalStateException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public FileBasedConfig getConfig() {
                try {
@@ -357,7 +353,6 @@ public class FileRepository extends Repository {
                return repoConfig;
        }
 
-       /** {@inheritDoc} */
        @Override
        @Nullable
        public String getGitwebDescription() throws IOException {
@@ -376,7 +371,6 @@ public class FileRepository extends Repository {
                return d;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setGitwebDescription(@Nullable String description)
                        throws IOException {
@@ -423,6 +417,7 @@ public class FileRepository extends Repository {
         * client trying to push changes avoid pushing more than it needs to.
         *
         * @throws IOException
+        *             if an IO error occurred
         */
        @Override
        public Set<ObjectId> getAdditionalHaves() throws IOException {
@@ -478,7 +473,6 @@ public class FileRepository extends Repository {
                objectDatabase.openPack(pack);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void scanForRepoChanges() throws IOException {
                getRefDatabase().getRefs(); // This will look for changes to refs
@@ -504,7 +498,6 @@ public class FileRepository extends Repository {
                notifyIndexChanged(false);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void notifyIndexChanged(boolean internal) {
                synchronized (snapshotLock) {
@@ -513,7 +506,6 @@ public class FileRepository extends Repository {
                fireEvent(new IndexChangedEvent(internal));
        }
 
-       /** {@inheritDoc} */
        @Override
        public ReflogReader getReflogReader(String refName) throws IOException {
                if (refs instanceof FileReftableDatabase) {
@@ -537,7 +529,6 @@ public class FileRepository extends Repository {
                return new ReflogReaderImpl(this, ref.getName());
        }
 
-       /** {@inheritDoc} */
        @Override
        public AttributesNodeProvider createAttributesNodeProvider() {
                return new AttributesNodeProviderImpl(this);
@@ -600,7 +591,6 @@ public class FileRepository extends Repository {
                                ConfigConstants.CONFIG_KEY_AUTODETACH, true);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("FutureReturnValueIgnored")
        @Override
        public void autoGC(ProgressMonitor monitor) {
index 6088c152a101905db7e362a3a5c5b21d77727e0c..9a85752062e3a8f42a6e8f6fed02fd393c585430 100644 (file)
@@ -404,7 +404,6 @@ public class FileSnapshot {
                                && Objects.equals(fileKey, other.fileKey);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object obj) {
                if (this == obj) {
@@ -420,7 +419,6 @@ public class FileSnapshot {
                return equals(other);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return Objects.hash(lastModified, Long.valueOf(size), fileKey);
@@ -474,7 +472,6 @@ public class FileSnapshot {
                return racyThreshold;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings({ "nls", "ReferenceEquality" })
        @Override
        public String toString() {
index 10b53b6661944eb25b4a084cc8d9e06a87563cf5..46f265f506f8c0e8a998ec0e68118651df516740 100644 (file)
@@ -222,9 +222,10 @@ public class GC {
         * gc.log.
         *
         * @return the collection of
-        *         {@link org.eclipse.jgit.internal.storage.file.Pack}'s which
-        *         are newly created
+        *         {@link org.eclipse.jgit.internal.storage.file.Pack}'s which are
+        *         newly created
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws java.text.ParseException
         *             If the configuration parameter "gc.pruneexpire" couldn't be
         *             parsed
@@ -298,10 +299,15 @@ public class GC {
         * pack files.
         *
         * @param inserter
+        *            used to insert objects
         * @param reader
+        *            used to read objects
         * @param pack
+        *            the pack file to loosen objects for
         * @param existing
+        *            existing objects
         * @throws IOException
+        *             if an IO error occurred
         */
        private void loosen(ObjectDirectoryInserter inserter, ObjectReader reader, Pack pack, HashSet<ObjectId> existing)
                        throws IOException {
@@ -327,13 +333,17 @@ public class GC {
         * directory. If an expirationDate is set then pack files which are younger
         * than the expirationDate will not be deleted nor preserved.
         * <p>
-        * If we're not immediately expiring loose objects, loosen any objects
-        * in the old pack files which aren't in the new pack files.
+        * If we're not immediately expiring loose objects, loosen any objects in
+        * the old pack files which aren't in the new pack files.
         *
         * @param oldPacks
+        *            old pack files
         * @param newPacks
+        *            new pack files
         * @throws ParseException
+        *             if an error occurred during parsing
         * @throws IOException
+        *             if an IO error occurred
         */
        private void deleteOldPacks(Collection<Pack> oldPacks,
                        Collection<Pack> newPacks) throws ParseException, IOException {
@@ -378,12 +388,15 @@ public class GC {
        }
 
        /**
-        * Deletes old pack file, unless 'preserve-oldpacks' is set, in which case it
-        * moves the pack file to the preserved directory
+        * Deletes old pack file, unless 'preserve-oldpacks' is set, in which case
+        * it moves the pack file to the preserved directory
         *
         * @param packFile
+        *            the packfile to delete
         * @param deleteOptions
+        *            delete option flags
         * @throws IOException
+        *             if an IO error occurred
         */
        private void removeOldPack(PackFile packFile, int deleteOptions)
                        throws IOException {
@@ -422,6 +435,7 @@ public class GC {
         * with a ".pack" file without a ".index" file.
         *
         * @param packFile
+        *            the pack file to prune files for
         */
        private void prunePack(PackFile packFile) {
                try {
@@ -449,6 +463,7 @@ public class GC {
         * because the filesystem delete operation fails) this is silently ignored.
         *
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void prunePacked() throws IOException {
                ObjectDirectory objdb = repo.getObjectDatabase();
@@ -507,6 +522,7 @@ public class GC {
         * @param objectsToKeep
         *            a set of objects which should explicitly not be pruned
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws java.text.ParseException
         *             If the configuration parameter "gc.pruneexpire" couldn't be
         *             parsed
@@ -714,10 +730,15 @@ public class GC {
         * by the given ObjectWalk
         *
         * @param id2File
+        *            mapping objectIds to files
         * @param w
+        *            used to walk objects
         * @throws MissingObjectException
+        *             if an object is missing
         * @throws IncorrectObjectTypeException
+        *             if an object has an unexpected tyoe
         * @throws IOException
+        *             if an IO error occurred
         */
        private void removeReferenced(Map<ObjectId, File> id2File,
                        ObjectWalk w) throws MissingObjectException,
@@ -758,6 +779,7 @@ public class GC {
         * is compacted into a single table.
         *
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void packRefs() throws IOException {
                RefDatabase refDb = repo.getRefDatabase();
@@ -927,6 +949,7 @@ public class GC {
         *            the list of wanted objects, writer walks commits starting at
         *            these. Must not be {@code null}.
         * @throws IOException
+        *             if an IO error occurred
         */
        void writeCommitGraph(@NonNull Set<? extends ObjectId> wants)
                        throws IOException {
@@ -1143,9 +1166,11 @@ public class GC {
        /**
         * @param ref
         *            the ref which log should be inspected
-        * @param minTime only reflog entries not older then this time are processed
+        * @param minTime
+        *            only reflog entries not older then this time are processed
         * @return the {@link ObjectId}s contained in the reflog
         * @throws IOException
+        *             if an IO error occurred
         */
        private Set<ObjectId> listRefLogObjects(Ref ref, long minTime) throws IOException {
                ReflogReader reflogReader = repo.getReflogReader(ref);
@@ -1177,6 +1202,7 @@ public class GC {
         *
         * @return a collection of refs pointing to live objects.
         * @throws IOException
+        *             if an IO error occurred
         */
        private Collection<Ref> getAllRefs() throws IOException {
                RefDatabase refdb = repo.getRefDatabase();
@@ -1203,8 +1229,11 @@ public class GC {
         *
         * @return a set of ObjectIds of changed objects in the index
         * @throws IOException
+        *             if an IO error occurred
         * @throws CorruptObjectException
+        *             if an object is corrupt
         * @throws NoWorkTreeException
+        *             if the repository has no working directory
         */
        private Set<ObjectId> listNonHEADIndexObjects()
                        throws CorruptObjectException, IOException {
@@ -1501,6 +1530,7 @@ public class GC {
         *
         * @return information about objects and pack files for a FileRepository
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public RepoStatistics getStatistics() throws IOException {
                RepoStatistics ret = new RepoStatistics();
index 86994a9eeb9c3b3da19e5b07c5fa8761ca45f4f1..628bf5db0c7d019f9d4bb3ddebdaf1679cd9155f 100644 (file)
@@ -132,6 +132,7 @@ class GcLog {
         * @param content
         *            The content to write
         * @throws IOException
+        *             if an IO error occurred
         */
        void write(String content) throws IOException {
                if (content.length() > 0) {
index 254557c08f6a1b0f0830345f16ea9be2301d27c1..bbb7476d650922939a13d7833c0581c48e4f83a2 100644 (file)
@@ -39,6 +39,7 @@ public class GlobalAttributesNode extends AttributesNode {
         *
         * @return the attributes node
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public AttributesNode load() throws IOException {
                AttributesNode r = new AttributesNode();
index a22cd3ffeba3c1a64fded69e7174a4d223fea4b1..11d842b246d7a04c6408597e3509395321d37951 100644 (file)
@@ -39,6 +39,7 @@ public class InfoAttributesNode extends AttributesNode {
         *
         * @return the attributes node
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public AttributesNode load() throws IOException {
                AttributesNode r = new AttributesNode();
index e2fbd7a0b43580d140266cb553a5a03d0922452f..15223ad437cecd8cb0c435bd7253377d248c891a 100644 (file)
@@ -44,25 +44,21 @@ class LargePackedWholeObject extends ObjectLoader {
                this.db = db;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getType() {
                return type;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getSize() {
                return size;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isLarge() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public byte[] getCachedBytes() throws LargeObjectException {
                try {
@@ -72,7 +68,6 @@ class LargePackedWholeObject extends ObjectLoader {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectStream openStream() throws MissingObjectException, IOException {
                WindowCursor wc = new WindowCursor(db);
index 2d73f9bd100c147076214b5e5af286c34a939bfb..d0d320bf027a8ab5fff34750e9ac2a42f9c058e0 100644 (file)
@@ -41,7 +41,6 @@ public class LazyObjectIdSetFile implements ObjectIdSet {
                this.src = src;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean contains(AnyObjectId objectId) {
                if (set == null) {
index f112947bae60be008d4fef60ca942df4734513c9..22eef9468cf05ad6372aa7c72b50f01bfd408276 100644 (file)
@@ -39,7 +39,6 @@ class LocalCachedPack extends CachedPack {
                this.packs = packs.toArray(new Pack[0]);
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getObjectCount() throws IOException {
                long cnt = 0;
@@ -54,7 +53,6 @@ class LocalCachedPack extends CachedPack {
                        pack.copyPackAsIs(out, wc);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasObject(ObjectToPack obj, StoredObjectRepresentation rep) {
                try {
index 559718af3ac8c694093ce7c5df9157883e8e4e0c..3f3d78c7345b46f6818b67057d6f80faeaa50057 100644 (file)
@@ -59,13 +59,11 @@ class LocalObjectRepresentation extends StoredObjectRepresentation {
 
        private ObjectId baseId;
 
-       /** {@inheritDoc} */
        @Override
        public int getWeight() {
                return (int) Math.min(length, Integer.MAX_VALUE);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getDeltaBase() {
                if (baseId == null && getFormat() == PACK_DELTA) {
index ac6cd212d558ba27356d17446794cb314bef0d1d..ca25212e00562c16b5d2fd6c182d55a74a6aa5b6 100644 (file)
@@ -29,14 +29,12 @@ class LocalObjectToPack extends ObjectToPack {
                super(src, type);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void clearReuseAsIs() {
                super.clearReuseAsIs();
                pack = null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void select(StoredObjectRepresentation ref) {
                LocalObjectRepresentation ptr = (LocalObjectRepresentation) ref;
index d06b5a72d191e80d3ccf73eb9bfc00e432c7dbb0..8ada0a90e1480d7570380ac34738d66a53238be5 100644 (file)
@@ -79,6 +79,7 @@ public class LockFile {
         * Get the lock file corresponding to the given file.
         *
         * @param file
+        *            given file
         * @return lock file
         */
        static File getLockFile(File file) {
@@ -575,7 +576,6 @@ public class LockFile {
                written = false;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 326c5f6457579aa1aa77fab860bbb48775303bcc..278c846ba8746713736e9cba370b01426c74c6fc 100644 (file)
@@ -90,7 +90,6 @@ class LooseObjects {
                unpackedObjectCache().clear();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "LooseObjects[" + directory + "]"; //$NON-NLS-1$ //$NON-NLS-2$
index f27daad89736d6807d58ea62bdd43d96395129b7..0ef38db3176a7aaf43325e23e46d7b0edf866d06 100644 (file)
@@ -145,7 +145,6 @@ public class ObjectDirectory extends FileObjectDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public final File getDirectory() {
                return loose.getDirectory();
@@ -169,13 +168,11 @@ public class ObjectDirectory extends FileObjectDatabase {
                return preserved.getDirectory();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean exists() {
                return fs.exists(objects);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void create() throws IOException {
                loose.create();
@@ -183,7 +180,6 @@ public class ObjectDirectory extends FileObjectDatabase {
                packed.create();
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectDirectoryInserter newInserter() {
                return new ObjectDirectoryInserter(this, config);
@@ -199,7 +195,6 @@ public class ObjectDirectory extends FileObjectDatabase {
                return new PackInserter(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                loose.close();
@@ -214,13 +209,11 @@ public class ObjectDirectory extends FileObjectDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<Pack> getPacks() {
                return packed.getPacks();
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getApproximateObjectCount() {
                long count = 0;
@@ -234,7 +227,6 @@ public class ObjectDirectory extends FileObjectDatabase {
                return count;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Optional<CommitGraph> getCommitGraph() {
                if (config.get(CoreConfig.KEY).enableCommitGraph()) {
@@ -244,7 +236,6 @@ public class ObjectDirectory extends FileObjectDatabase {
        }
 
        /**
-        * {@inheritDoc}
         * <p>
         * Add a single existing pack to the list of available pack files.
         */
@@ -273,13 +264,11 @@ public class ObjectDirectory extends FileObjectDatabase {
                return res;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "ObjectDirectory[" + getDirectory() + "]"; //$NON-NLS-1$ //$NON-NLS-2$
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean has(AnyObjectId objectId) {
                return loose.hasCached(objectId)
@@ -811,7 +800,6 @@ public class ObjectDirectory extends FileObjectDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectDatabase newCachedDatabase() {
                return newCachedFileObjectDatabase();
index e6b2cc12f48287f832960710c1ee3fe8dae46c5d..2f30a9797f51232e9b8f03fa81796794ef83cb96 100644 (file)
@@ -49,7 +49,6 @@ class ObjectDirectoryInserter extends ObjectInserter {
                config = cfg.get(WriteConfig.KEY);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId insert(int type, byte[] data, int off, int len)
                        throws IOException {
@@ -62,12 +61,19 @@ class ObjectDirectoryInserter extends ObjectInserter {
         * ODB.
         *
         * @param type
+        *            object type
         * @param data
+        *            object data
         * @param off
+        *            first position within @{code data}
         * @param len
+        *            length number of bytes to copy
         * @param createDuplicate
-        * @return ObjectId
+        *            whether to insert a duplicate if an object with this id
+        *            already exists
+        * @return ObjectId the name of the object
         * @throws IOException
+        *             if an IO error occurred
         */
        private ObjectId insert(
                        int type, byte[] data, int off, int len, boolean createDuplicate)
@@ -80,7 +86,6 @@ class ObjectDirectoryInserter extends ObjectInserter {
                return insertOneObject(tmp, id, createDuplicate);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId insert(int type, long len, InputStream is)
                        throws IOException {
@@ -93,11 +98,17 @@ class ObjectDirectoryInserter extends ObjectInserter {
         * ODB.
         *
         * @param type
+        *            object type
         * @param len
+        *            number of bytes to copy
         * @param is
+        *            input stream
         * @param createDuplicate
-        * @return ObjectId
+        *            whether to insert a duplicate if an object with this id
+        *            already exists
+        * @return ObjectId the name of the object
         * @throws IOException
+        *             if an IO error occurred
         */
        ObjectId insert(int type, long len, InputStream is, boolean createDuplicate)
                        throws IOException {
@@ -132,25 +143,21 @@ class ObjectDirectoryInserter extends ObjectInserter {
                                .format(JGitText.get().unableToCreateNewObject, dst));
        }
 
-       /** {@inheritDoc} */
        @Override
        public PackParser newPackParser(InputStream in) throws IOException {
                return new ObjectDirectoryPackParser(db, in);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectReader newReader() {
                return new WindowCursor(db, this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                // Do nothing. Loose objects are immediately visible.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                if (deflate != null) {
index 55b2646c46cd3ac4e264eb03704f8f1e1b79ecdc..9f27f4bd6e4776f04c6a1633c65b3df0b8ae95b0 100644 (file)
@@ -142,7 +142,6 @@ public class ObjectDirectoryPackParser extends PackParser {
                return newPack;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getPackSize() {
                if (newPack == null)
@@ -158,7 +157,6 @@ public class ObjectDirectoryPackParser extends PackParser {
                return size;
        }
 
-       /** {@inheritDoc} */
        @Override
        public PackLock parse(ProgressMonitor receiving, ProgressMonitor resolving)
                        throws IOException {
@@ -193,40 +191,34 @@ public class ObjectDirectoryPackParser extends PackParser {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onPackHeader(long objectCount) throws IOException {
                // Ignored, the count is not required.
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginWholeObject(long streamPosition, int type,
                        long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndWholeObject(PackedObjectInfo info) throws IOException {
                info.setCRC((int) crc.getValue());
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginOfsDelta(long streamPosition,
                        long baseStreamPosition, long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onBeginRefDelta(long streamPosition, AnyObjectId baseId,
                        long inflatedSize) throws IOException {
                crc.reset();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected UnresolvedDelta onEndDelta() throws IOException {
                UnresolvedDelta delta = new UnresolvedDelta();
@@ -234,35 +226,30 @@ public class ObjectDirectoryPackParser extends PackParser {
                return delta;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onInflatedObjectData(PackedObjectInfo obj, int typeCode,
                        byte[] data) throws IOException {
                // ObjectDirectory ignores this event.
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onObjectHeader(Source src, byte[] raw, int pos, int len)
                        throws IOException {
                crc.update(raw, pos, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onObjectData(Source src, byte[] raw, int pos, int len)
                        throws IOException {
                crc.update(raw, pos, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onStoreStream(byte[] raw, int pos, int len)
                        throws IOException {
                out.write(raw, pos, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onPackFooter(byte[] hash) throws IOException {
                packEnd = out.getFilePointer();
@@ -271,7 +258,6 @@ public class ObjectDirectoryPackParser extends PackParser {
                packHash = hash;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected ObjectTypeAndSize seekDatabase(UnresolvedDelta delta,
                        ObjectTypeAndSize info) throws IOException {
@@ -280,7 +266,6 @@ public class ObjectDirectoryPackParser extends PackParser {
                return readObjectHeader(info);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected ObjectTypeAndSize seekDatabase(PackedObjectInfo obj,
                        ObjectTypeAndSize info) throws IOException {
@@ -289,13 +274,11 @@ public class ObjectDirectoryPackParser extends PackParser {
                return readObjectHeader(info);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected int readDatabase(byte[] dst, int pos, int cnt) throws IOException {
                return out.read(dst, pos, cnt);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean checkCRC(int oldCRC) {
                return oldCRC == (int) crc.getValue();
@@ -313,7 +296,6 @@ public class ObjectDirectoryPackParser extends PackParser {
                        tmpPack.deleteOnExit();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean onAppendBase(final int typeCode, final byte[] data,
                        final PackedObjectInfo info) throws IOException {
@@ -356,7 +338,6 @@ public class ObjectDirectoryPackParser extends PackParser {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndThinPack() throws IOException {
                final byte[] buf = buffer();
index 5d401f45180e91ebe3216065785b8064159b97ce..90eb35729dcca7a3f598cd08fd558c9bb277afb5 100644 (file)
@@ -211,6 +211,7 @@ public class Pack implements Iterable<PackIndex.MutableEntry> {
         *
         * @return the index for this pack file.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public PackIndex getIndex() throws IOException {
                return idx();
index 8fb17fcf21687bbbf1fedb3c7ea82b4d2a268990..0c3e724ed8f199af50a58502320fe0c06b906e28 100644 (file)
@@ -205,6 +205,7 @@ public abstract class PackBitmapIndex {
                /**
                 * @return result
                 * @throws IOException
+                *             if an IO error occurred
                 */
                T get() throws IOException;
        }
index 5666b57609f42467169aa0c4abf16415bda01689..755bfc49c4f6737faf5bde9ad15597d764fe57e3 100644 (file)
@@ -214,7 +214,6 @@ public class PackBitmapIndexBuilder extends BasePackBitmapIndex {
                getBitmaps().add(result);
        }
 
-       /** {@inheritDoc} */
        @Override
        public EWAHCompressedBitmap ofObjectType(
                        EWAHCompressedBitmap bitmap, int type) {
@@ -231,7 +230,6 @@ public class PackBitmapIndexBuilder extends BasePackBitmapIndex {
                throw new IllegalArgumentException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int findPosition(AnyObjectId objectId) {
                PositionEntry entry = positionEntries.get(objectId);
@@ -240,7 +238,6 @@ public class PackBitmapIndexBuilder extends BasePackBitmapIndex {
                return entry.offsetPosition;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getObject(int position) throws IllegalArgumentException {
                ObjectId objectId = byOffset.get(position);
@@ -294,7 +291,6 @@ public class PackBitmapIndexBuilder extends BasePackBitmapIndex {
                return PackBitmapIndexV1.OPT_FULL;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getBitmapCount() {
                return bitmapsToWriteXorBuffer.size() + bitmapsToWrite.size();
@@ -311,7 +307,6 @@ public class PackBitmapIndexBuilder extends BasePackBitmapIndex {
                bitmapsToWrite = new ArrayList<>(size);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getObjectCount() {
                return byOffset.size();
index e1b6f780c7c8464cef9b7e3166742b8c16fe30b9..c97d9f07ef4ad928ddb9d79bbd961fcab61a2975 100644 (file)
@@ -79,32 +79,27 @@ public class PackBitmapIndexRemapper extends PackBitmapIndex
                                        oldPackIndex.getObject(pos));
        }
 
-       /** {@inheritDoc} */
        @Override
        public int findPosition(AnyObjectId objectId) {
                return newPackIndex.findPosition(objectId);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getObject(int position) throws IllegalArgumentException {
                return newPackIndex.getObject(position);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getObjectCount() {
                return newPackIndex.getObjectCount();
        }
 
-       /** {@inheritDoc} */
        @Override
        public EWAHCompressedBitmap ofObjectType(
                        EWAHCompressedBitmap bitmap, int type) {
                return newPackIndex.ofObjectType(bitmap, type);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<Entry> iterator() {
                if (oldPackIndex == null)
@@ -141,7 +136,6 @@ public class PackBitmapIndexRemapper extends PackBitmapIndex
                };
        }
 
-       /** {@inheritDoc} */
        @Override
        public EWAHCompressedBitmap getBitmap(AnyObjectId objectId) {
                EWAHCompressedBitmap bitmap = newPackIndex.getBitmap(objectId);
@@ -179,7 +173,6 @@ public class PackBitmapIndexRemapper extends PackBitmapIndex
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getBitmapCount() {
                // The count is only useful for the end index, not the remapper.
index 988dc6c4ff435868533335a771cfa0c29493e0c6..70d72330ab37b1df857ad0fdd1ff3c286fbad4b4 100644 (file)
@@ -214,7 +214,6 @@ class PackBitmapIndexV1 extends BasePackBitmapIndex {
                this.reverseIndex = computedReverseIndex;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int findPosition(AnyObjectId objectId) {
                long offset = packIndex.findOffset(objectId);
@@ -223,7 +222,6 @@ class PackBitmapIndexV1 extends BasePackBitmapIndex {
                return reverseIndex.findPosition(offset);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getObject(int position) throws IllegalArgumentException {
                ObjectId objectId = reverseIndex.findObjectByPosition(position);
@@ -232,13 +230,11 @@ class PackBitmapIndexV1 extends BasePackBitmapIndex {
                return objectId;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getObjectCount() {
                return (int) packIndex.getObjectCount();
        }
 
-       /** {@inheritDoc} */
        @Override
        public EWAHCompressedBitmap ofObjectType(
                        EWAHCompressedBitmap bitmap, int type) {
@@ -255,13 +251,11 @@ class PackBitmapIndexV1 extends BasePackBitmapIndex {
                throw new IllegalArgumentException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getBitmapCount() {
                return bitmaps.size();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object o) {
                // TODO(cranger): compare the pack checksum?
@@ -270,7 +264,6 @@ class PackBitmapIndexV1 extends BasePackBitmapIndex {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return getPackIndex().hashCode();
index 6a99cb3d83aa66b2bd4c460bbad106c3211b49b7..85b2d34a9239e1991bd75771f0836dd5b33221bf 100644 (file)
@@ -123,7 +123,6 @@ class PackDirectory {
                return Collections.unmodifiableCollection(Arrays.asList(packs));
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "PackDirectory[" + getDirectory() + "]"; //$NON-NLS-1$ //$NON-NLS-2$
@@ -350,7 +349,7 @@ class PackDirectory {
        /**
         * @param n
         *            count of consecutive failures
-        * @return @{code true} if i is a power of 2
+        * @return {@code true} if i is a power of 2
         */
        private boolean doLogExponentialBackoff(int n) {
                return (n & (n - 1)) == 0;
index a784af8c3f308618fe155f877a47750ad72bd973..dbf7d8ae5d1182480eca3c3d3618bffdde972275 100644 (file)
@@ -48,7 +48,6 @@ class PackFileSnapshot extends FileSnapshot {
                this.checksum = checksum;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isModified(File packFile) {
                if (!super.isModified(packFile)) {
index f4f62d42053450a7259eff0e6373a6daf0eafb4b..7778cb5133da103a4138631958a6693473d0721a 100644 (file)
@@ -128,7 +128,6 @@ public abstract class PackIndex
                return findOffset(id) != -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean contains(AnyObjectId id) {
                return findOffset(id) != -1;
index fff410b4cefa51637741b35113bc2ed351231058..860ebaefc2e0a3e0e232acd33996fe0840095ce6 100644 (file)
@@ -72,13 +72,11 @@ class PackIndexV1 extends PackIndex {
                IO.readFully(fd, packChecksum, 0, packChecksum.length);
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getObjectCount() {
                return objectCnt;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getOffset64Count() {
                long n64 = 0;
@@ -111,7 +109,6 @@ class PackIndexV1 extends PackIndex {
                return (int) (nthPosition - base);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getObjectId(long nthPosition) {
                final int levelOne = findLevelOne(nthPosition);
@@ -128,7 +125,6 @@ class PackIndexV1 extends PackIndex {
                return NB.decodeUInt32(idxdata[levelOne], p);
        }
 
-       /** {@inheritDoc} */
        @Override
        public long findOffset(AnyObjectId objId) {
                final int levelOne = objId.getFirstByte();
@@ -145,7 +141,6 @@ class PackIndexV1 extends PackIndex {
                return (((long) b0) << 24) | (b1 << 16) | (b2 << 8) | (b3);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int findPosition(AnyObjectId objId) {
                int levelOne = objId.getFirstByte();
@@ -193,25 +188,21 @@ class PackIndexV1 extends PackIndex {
                return -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long findCRC32(AnyObjectId objId) {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasCRC32Support() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<MutableEntry> iterator() {
                return new IndexV1Iterator();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void resolve(Set<ObjectId> matches, AbbreviatedObjectId id,
                        int matchLimit) throws IOException {
index 7a390060c7db6b936e56484591db0e96617e9e42..751b62dc40978860422508654b937f93d3e520dc 100644 (file)
@@ -131,13 +131,11 @@ class PackIndexV2 extends PackIndex {
                IO.readFully(fd, packChecksum, 0, packChecksum.length);
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getObjectCount() {
                return objectCnt;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getOffset64Count() {
                return offset64.length / 8;
@@ -165,7 +163,6 @@ class PackIndexV2 extends PackIndex {
                return (int) (nthPosition - base);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getObjectId(long nthPosition) {
                final int levelOne = findLevelOne(nthPosition);
@@ -174,7 +171,6 @@ class PackIndexV2 extends PackIndex {
                return ObjectId.fromRaw(names[levelOne], p4 + p); // p * 5
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getOffset(long nthPosition) {
                final int levelOne = findLevelOne(nthPosition);
@@ -182,7 +178,6 @@ class PackIndexV2 extends PackIndex {
                return getOffset(levelOne, levelTwo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public long findOffset(AnyObjectId objId) {
                final int levelOne = objId.getFirstByte();
@@ -192,7 +187,6 @@ class PackIndexV2 extends PackIndex {
                return getOffset(levelOne, levelTwo);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int findPosition(AnyObjectId objId) {
                int levelOne = objId.getFirstByte();
@@ -211,7 +205,6 @@ class PackIndexV2 extends PackIndex {
                return p;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long findCRC32(AnyObjectId objId) throws MissingObjectException {
                final int levelOne = objId.getFirstByte();
@@ -221,19 +214,16 @@ class PackIndexV2 extends PackIndex {
                return NB.decodeUInt32(crc32[levelOne], levelTwo << 2);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasCRC32Support() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<MutableEntry> iterator() {
                return new EntriesIteratorV2();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void resolve(Set<ObjectId> matches, AbbreviatedObjectId id,
                        int matchLimit) throws IOException {
index e1612bb57917aa38fd14ea304403094f055e2b21..7e28b5eb2b56e4a0fb2ccd5bff7ba9c661e82b9d 100644 (file)
@@ -35,7 +35,6 @@ class PackIndexWriterV1 extends PackIndexWriter {
                super(dst);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void writeImpl() throws IOException {
                writeFanOutTable();
index 7adabad708a9735cbd75d6a72f3f84c3d24bd9c1..fc5ef6191200c7eef5d9592c84f85ea7090af9e9 100644 (file)
@@ -30,7 +30,6 @@ class PackIndexWriterV2 extends PackIndexWriter {
                super(dst);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void writeImpl() throws IOException {
                writeTOC(2);
index 0bceca72eaf50421c2067ee82d4c055c21074f12..fdc2f80075d8b80e3d2c8d47f604d8874bd1f5e5 100644 (file)
@@ -31,7 +31,6 @@ class PackInputStream extends InputStream {
                wc.pin(pack, pos);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] b, int off, int len) throws IOException {
                int n = wc.copy(pack, pos, b, off, len);
@@ -39,7 +38,6 @@ class PackInputStream extends InputStream {
                return n;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                byte[] buf = new byte[1];
@@ -47,7 +45,6 @@ class PackInputStream extends InputStream {
                return n == 1 ? buf[0] & 0xff : -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                wc.close();
index d6209c4a791bb205bff1644f0679bc45f41e4842..1b092a333256cf10c03e18e74fc1d19c34409c1b 100644 (file)
@@ -150,7 +150,6 @@ public class PackInserter extends ObjectInserter {
                return buffer().length;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId insert(int type, byte[] data, int off, int len)
                        throws IOException {
@@ -169,7 +168,6 @@ public class PackInserter extends ObjectInserter {
                return endObject(id, offset);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId insert(int type, long len, InputStream in)
                        throws IOException {
@@ -243,19 +241,16 @@ public class PackInserter extends ObjectInserter {
                return 12;
        }
 
-       /** {@inheritDoc} */
        @Override
        public PackParser newPackParser(InputStream in) {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectReader newReader() {
                return new Reader();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                if (tmpPack == null) {
@@ -340,7 +335,6 @@ public class PackInserter extends ObjectInserter {
                return ObjectId.fromRaw(md.digest());
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                try {
index 65a065dd55ddbc7816c0cd0dde84d83b53c40cdf..328643688d29f581566ea4887e473b19e5477039 100644 (file)
@@ -72,11 +72,13 @@ public abstract class PackObjectSizeIndexWriter {
         *
         * Store position (in the main index) to size as parallel arrays.
         *
-        * <p>Positions in the main index fit well in unsigned 24 bits (16M) for most
+        * <p>
+        * Positions in the main index fit well in unsigned 24 bits (16M) for most
         * repositories, but some outliers have even more objects, so we need to
         * store also 32 bits positions.
         *
-        * <p>Sizes are stored as a first array parallel to positions. If a size
+        * <p>
+        * Sizes are stored as a first array parallel to positions. If a size
         * doesn't fit in an element of that array, then we encode there a position
         * on the next-size array. This "overflow" array doesn't have entries for
         * all positions.
@@ -85,30 +87,36 @@ public abstract class PackObjectSizeIndexWriter {
         *
         *      positions       [10, 500, 1000, 1001]
         *      sizes (32bits)  [15MB, -1, 6MB, -2]
-   *                          ___/  ______/
+       *                          ___/  ______/
         *                        /     /
         *      sizes (64 bits) [3GB, 6GB]
         * </pre>
         *
-        * <p>For sizes we use 32 bits as the first level and 64 for the rare objects
+        * <p>
+        * For sizes we use 32 bits as the first level and 64 for the rare objects
         * over 2GB.
         *
-        * <p>A 24/32/64 bits hierarchy of arrays saves space if we have a lot of small
-        * objects, but wastes space if we have only big ones. The min size to index is
-        * controlled by conf and in principle we want to index only rather
-        * big objects (e.g. > 10MB). We could support more dynamics read/write of sizes
+        * <p>
+        * A 24/32/64 bits hierarchy of arrays saves space if we have a lot of small
+        * objects, but wastes space if we have only big ones. The min size to index
+        * is controlled by conf and in principle we want to index only rather big
+        * objects (e.g. > 10MB). We could support more dynamics read/write of sizes
         * (e.g. 24 only if the threshold will include many of those objects) but it
-        * complicates a lot code and spec. If needed it could go for a v2 of the protocol.
-        *
-        * <p>Format:
+        * complicates a lot code and spec. If needed it could go for a v2 of the
+        * protocol.
         *
+        * <p>
+        * Format:
+        * <ul>
         * <li>A header with the magic number (4 bytes)
         * <li>The index version (1 byte)
         * <li>The minimum object size (4 bytes)
         * <li>Total count of objects indexed (C, 4 bytes)
+        * </ul>
         * (if count == 0, stop here)
-        *
+        * <p>
         * Blocks of
+        * <ul>
         * <li>Size per entry in bits (1 byte, either 24 (0x18) or 32 (0x20))
         * <li>Count of entries (4 bytes) (c, as a signed int)
         * <li>positions encoded in s bytes each (i.e s*c bytes)
@@ -120,6 +128,7 @@ public abstract class PackObjectSizeIndexWriter {
         * <li>Count of 64 bit sizes (s64) (or 0 if no more indirections)
         * <li>64 bit sizes (s64 * 8 bytes)
         * <li>0 (end)
+        * </ul>
         */
        static class PackObjectSizeWriterV1 extends PackObjectSizeIndexWriter {
 
index 106313db6310ef358c8b8c45213a444fc7407ec0..5584f13db18a51a44357592e59227a7dd14d1c4a 100644 (file)
@@ -98,7 +98,6 @@ class PackedBatchRefUpdate extends BatchRefUpdate {
          this.shouldLockLooseRefs = shouldLockLooseRefs;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void execute(RevWalk walk, ProgressMonitor monitor,
                        List<String> options) throws IOException {
index f0676d9beca523e02fd63d54840f5be12d636c52..912c89bc8b63f05c4eaaef185e296e4da61bebef 100644 (file)
@@ -247,7 +247,6 @@ public class RefDirectory extends RefDatabase {
                return new SnapshottingRefDirectory(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void create() throws IOException {
                FileUtils.mkdir(refsDir);
@@ -256,7 +255,6 @@ public class RefDirectory extends RefDatabase {
                newLogWriter(false).create();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                clearReferences();
@@ -267,14 +265,12 @@ public class RefDirectory extends RefDatabase {
                packedRefs.set(NO_PACKED_REFS);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void refresh() {
                super.refresh();
                clearReferences();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isNameConflicting(String name) throws IOException {
                // Cannot be nested within an existing reference.
@@ -312,7 +308,6 @@ public class RefDirectory extends RefDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref exactRef(String name) throws IOException {
                try {
@@ -322,7 +317,6 @@ public class RefDirectory extends RefDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public Map<String, Ref> exactRef(String... refs) throws IOException {
@@ -341,7 +335,6 @@ public class RefDirectory extends RefDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        @Nullable
        public Ref firstExactRef(String... refs) throws IOException {
@@ -359,7 +352,6 @@ public class RefDirectory extends RefDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, Ref> getRefs(String prefix) throws IOException {
                final RefList<LooseRef> oldLoose = looseRefs.get();
@@ -399,7 +391,6 @@ public class RefDirectory extends RefDatabase {
                return new RefMap(prefix, packed, upcast(loose), symbolic.toRefList());
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<Ref> getAdditionalRefs() throws IOException {
                List<Ref> ret = new LinkedList<>();
@@ -534,7 +525,6 @@ public class RefDirectory extends RefDatabase {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref peel(Ref ref) throws IOException {
                final Ref leaf = ref.getLeaf();
@@ -585,7 +575,6 @@ public class RefDirectory extends RefDatabase {
                fireRefsChanged();
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefDirectoryUpdate newUpdate(String name, boolean detach)
                        throws IOException {
@@ -609,7 +598,6 @@ public class RefDirectory extends RefDatabase {
                return new RefDirectoryUpdate(this, ref);
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefDirectoryRename newRename(String fromName, String toName)
                        throws IOException {
@@ -622,7 +610,6 @@ public class RefDirectory extends RefDatabase {
                return new RefDirectoryRename(from, to);
        }
 
-       /** {@inheritDoc} */
        @Override
        public PackedBatchRefUpdate newBatchUpdate() {
                return new PackedBatchRefUpdate(this);
@@ -643,7 +630,6 @@ public class RefDirectory extends RefDatabase {
                return new PackedBatchRefUpdate(this, shouldLockLooseRefs);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean performsAtomicTransactions() {
                return true;
@@ -724,6 +710,7 @@ public class RefDirectory extends RefDatabase {
         * @param refs
         *            the refs to be added. Must be fully qualified.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void pack(List<String> refs) throws IOException {
                pack(refs, Collections.emptyMap());
@@ -868,26 +855,29 @@ public class RefDirectory extends RefDatabase {
         * has this attributes simply return it. Otherwise create a new peeled
         * {@link ObjectIdRef} where Storage is set to PACKED.
         *
-        * @param f
+        * @param ref
+        *            given ref
         * @return a ref for Storage PACKED having the same name, id, peeledId as f
         * @throws MissingObjectException
+        *             if an object is missing
         * @throws IOException
+        *             if an IO error occurred
         */
-       private Ref peeledPackedRef(Ref f)
+       private Ref peeledPackedRef(Ref ref)
                        throws MissingObjectException, IOException {
-               if (f.getStorage().isPacked() && f.isPeeled()) {
-                       return f;
+               if (ref.getStorage().isPacked() && ref.isPeeled()) {
+                       return ref;
                }
-               if (!f.isPeeled()) {
-                       f = peel(f);
+               if (!ref.isPeeled()) {
+                       ref = peel(ref);
                }
-               ObjectId peeledObjectId = f.getPeeledObjectId();
+               ObjectId peeledObjectId = ref.getPeeledObjectId();
                if (peeledObjectId != null) {
-                       return new ObjectIdRef.PeeledTag(PACKED, f.getName(),
-                                       f.getObjectId(), peeledObjectId);
+                       return new ObjectIdRef.PeeledTag(PACKED, ref.getName(),
+                                       ref.getObjectId(), peeledObjectId);
                }
-               return new ObjectIdRef.PeeledNonTag(PACKED, f.getName(),
-                               f.getObjectId());
+               return new ObjectIdRef.PeeledNonTag(PACKED, ref.getName(),
+                               ref.getObjectId());
        }
 
        void log(boolean force, RefUpdate update, String msg, boolean deref)
@@ -1236,6 +1226,7 @@ public class RefDirectory extends RefDatabase {
         *
         * @return {@code true} if we are currently cloning a repository
         * @throws IOException
+        *             if an IO error occurred
         */
        boolean isInClone() throws IOException {
                return hasDanglingHead() && !packedRefsFile.exists() && !hasLooseRef();
index d07299e45a6d62cf4786d938d7c49069a1ea29f9..1c5c48a296f0d99bebe6a2cb289a988d30203b4a 100644 (file)
@@ -68,7 +68,6 @@ class RefDirectoryRename extends RefRename {
                return refdb;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Result doRename() throws IOException {
                if (source.getRef().isSymbolic())
index 0dcb3196c5ace831eee2ee11570003c57c51c433..1dc4e3011f55be0fc11ae8e10ab27c4c9f6d6968 100644 (file)
@@ -32,19 +32,16 @@ class RefDirectoryUpdate extends RefUpdate {
                database = r;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected RefDirectory getRefDatabase() {
                return database;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Repository getRepository() {
                return database.getRepository();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean tryLock(boolean deref) throws IOException {
                shouldDeref = deref;
@@ -61,7 +58,6 @@ class RefDirectoryUpdate extends RefUpdate {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void unlock() {
                if (lock != null) {
@@ -70,7 +66,6 @@ class RefDirectoryUpdate extends RefUpdate {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Result doUpdate(Result status) throws IOException {
                WriteConfig wc = database.getRepository().getConfig()
@@ -112,7 +107,6 @@ class RefDirectoryUpdate extends RefUpdate {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Result doDelete(Result status) throws IOException {
                if (getRef().getStorage() != Ref.Storage.NEW)
@@ -120,7 +114,6 @@ class RefDirectoryUpdate extends RefUpdate {
                return status;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected Result doLink(String target) throws IOException {
                WriteConfig wc = database.getRepository().getConfig()
index cb80043b7ea02ade8d74d6180579066213fd4dd7..6870d7686eb5208a1cbf8a87f8f88e47b3009c6b 100644 (file)
@@ -60,7 +60,6 @@ public class ReflogEntryImpl implements Serializable, ReflogEntry {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogEntry#getOldId()
         */
-       /** {@inheritDoc} */
        @Override
        public ObjectId getOldId() {
                return oldId;
@@ -69,7 +68,6 @@ public class ReflogEntryImpl implements Serializable, ReflogEntry {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogEntry#getNewId()
         */
-       /** {@inheritDoc} */
        @Override
        public ObjectId getNewId() {
                return newId;
@@ -78,7 +76,6 @@ public class ReflogEntryImpl implements Serializable, ReflogEntry {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogEntry#getWho()
         */
-       /** {@inheritDoc} */
        @Override
        public PersonIdent getWho() {
                return who;
@@ -87,13 +84,11 @@ public class ReflogEntryImpl implements Serializable, ReflogEntry {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogEntry#getComment()
         */
-       /** {@inheritDoc} */
        @Override
        public String getComment() {
                return comment;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
@@ -104,7 +99,6 @@ public class ReflogEntryImpl implements Serializable, ReflogEntry {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogEntry#parseCheckout()
         */
-       /** {@inheritDoc} */
        @Override
        public CheckoutEntry parseCheckout() {
                if (getComment().startsWith(CheckoutEntryImpl.CHECKOUT_MOVING_FROM)) {
index 99a9e0938e5fdca6e430e01ad9552c743ec9df2e..21b5a54eb7ade1d84f8f7541fed2614071ac5f05 100644 (file)
@@ -32,7 +32,9 @@ class ReflogReaderImpl implements ReflogReader {
 
        /**
         * @param db
+        *            repository to read reflogs from
         * @param refname
+        *            {@code Ref} name
         */
        ReflogReaderImpl(Repository db, String refname) {
                logName = new File(db.getDirectory(), Constants.LOGS + '/' + refname);
@@ -41,7 +43,6 @@ class ReflogReaderImpl implements ReflogReader {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogReaader#getLastEntry()
         */
-       /** {@inheritDoc} */
        @Override
        public ReflogEntry getLastEntry() throws IOException {
                return getReverseEntry(0);
@@ -50,7 +51,6 @@ class ReflogReaderImpl implements ReflogReader {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogReaader#getReverseEntries()
         */
-       /** {@inheritDoc} */
        @Override
        public List<ReflogEntry> getReverseEntries() throws IOException {
                return getReverseEntries(Integer.MAX_VALUE);
@@ -59,7 +59,6 @@ class ReflogReaderImpl implements ReflogReader {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogReaader#getReverseEntry(int)
         */
-       /** {@inheritDoc} */
        @Override
        public ReflogEntry getReverseEntry(int number) throws IOException {
                if (number < 0)
@@ -89,7 +88,6 @@ class ReflogReaderImpl implements ReflogReader {
        /* (non-Javadoc)
         * @see org.eclipse.jgit.internal.storage.file.ReflogReaader#getReverseEntries(int)
         */
-       /** {@inheritDoc} */
        @Override
        public List<ReflogEntry> getReverseEntries(int max) throws IOException {
                final byte[] log;
index 7032083a4d2937fe976c6b5d5288f4094ba684c2..b1ceb148093fee5b2a8da31ac4b5c0c01d696898 100644 (file)
@@ -91,6 +91,7 @@ public class ReflogWriter {
         * Create the log directories.
         *
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @return this writer.
         */
        public ReflogWriter create() throws IOException {
@@ -110,6 +111,7 @@ public class ReflogWriter {
         *            a {@link org.eclipse.jgit.lib.ReflogEntry} object.
         * @return this writer
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public ReflogWriter log(String refName, ReflogEntry entry)
                        throws IOException {
@@ -132,6 +134,7 @@ public class ReflogWriter {
         *            reflog message
         * @return this writer
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public ReflogWriter log(String refName, ObjectId oldId,
                        ObjectId newId, PersonIdent ident, String message) throws IOException {
@@ -150,6 +153,7 @@ public class ReflogWriter {
         *            whether to dereference symbolic refs
         * @return this writer
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public ReflogWriter log(RefUpdate update, String msg,
                        boolean deref) throws IOException {
index 6a80519d0b2fed6fa14739a0c78d651e80c5a649..7a564cc6aba2a6b52ebbcd59316a2f7dd61bbc3b 100644 (file)
@@ -31,14 +31,12 @@ class SimpleDataInput implements DataInput {
                this.fd = fd;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int readInt() throws IOException {
                readFully(buf, 0, 4);
                return NB.decodeInt32(buf, 0);
        }
 
-       /** {@inheritDoc} */
        @Override
        public long readLong() throws IOException {
                readFully(buf, 0, 8);
@@ -57,79 +55,66 @@ class SimpleDataInput implements DataInput {
                return NB.decodeUInt32(buf, 0);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void readFully(byte[] b) throws IOException {
                readFully(b, 0, b.length);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void readFully(byte[] b, int off, int len) throws IOException {
                IO.readFully(fd, b, off, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int skipBytes(int n) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean readBoolean() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public byte readByte() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int readUnsignedByte() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public short readShort() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int readUnsignedShort() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public char readChar() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public float readFloat() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public double readDouble() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String readLine() throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String readUTF() throws IOException {
                throw new UnsupportedOperationException();
index d01f6b4bdaad25708d3a51f10979ca29030c1b4e..74840889ce89192c1fdbdeedafba96dc6468ee7f 100644 (file)
@@ -31,88 +31,74 @@ class SimpleDataOutput implements DataOutput {
                this.fd = fd;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeShort(int v) throws IOException {
                NB.encodeInt16(buf, 0, v);
                fd.write(buf, 0, 2);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeInt(int v) throws IOException {
                NB.encodeInt32(buf, 0, v);
                fd.write(buf, 0, 4);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeLong(long v) throws IOException {
                NB.encodeInt64(buf, 0, v);
                fd.write(buf, 0, 8);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b, int off, int len) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeBoolean(boolean v) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeByte(int v) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeChar(int v) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeFloat(float v) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeDouble(double v) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeBytes(String s) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeChars(String s) throws IOException {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeUTF(String s) throws IOException {
                throw new UnsupportedOperationException();
index 0b9748096e846bb7da54b90c033158ec8f8a61c0..767084afa5ca61eb4753714f196d04c9d85fa0bd 100644 (file)
@@ -67,14 +67,12 @@ class SnapshottingRefDirectory extends RefDirectory {
                return packedRefs.get();
        }
 
-       /** {@inheritDoc} */
        @Override
        void delete(RefDirectoryUpdate update) throws IOException {
                refreshSnapshot();
                super.delete(update);
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefDirectoryUpdate newUpdate(String name, boolean detach)
                        throws IOException {
@@ -82,19 +80,16 @@ class SnapshottingRefDirectory extends RefDirectory {
                return super.newUpdate(name, detach);
        }
 
-       /** {@inheritDoc} */
        @Override
        public PackedBatchRefUpdate newBatchUpdate() {
                return new SnapshotPackedBatchRefUpdate(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public PackedBatchRefUpdate newBatchUpdate(boolean shouldLockLooseRefs) {
                return new SnapshotPackedBatchRefUpdate(this, shouldLockLooseRefs);
        }
 
-       /** {@inheritDoc} */
        @Override
        RefDirectoryUpdate newTemporaryUpdate() throws IOException {
                refreshSnapshot();
@@ -126,6 +121,7 @@ class SnapshottingRefDirectory extends RefDirectory {
         * threads use this snapshot.
         *
         * @throws IOException
+        *             if an IO error occurred
         */
        private synchronized void refreshSnapshot() throws IOException {
                compareAndSetPackedRefs(packedRefs.get(), refDb.getPackedRefs());
index fa743babe7fa5ee553b81d044f75ef8985a65c0f..01f514b939de0d9d579377c91ff37bfe84608db8 100644 (file)
@@ -79,13 +79,11 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                return baseCache;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectReader newReader() {
                return new WindowCursor(db);
        }
 
-       /** {@inheritDoc} */
        @Override
        public BitmapIndex getBitmapIndex() throws IOException {
                for (Pack pack : db.getPacks()) {
@@ -96,13 +94,11 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Optional<CommitGraph> getCommitGraph() {
                return db.getCommitGraph();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<CachedPack> getCachedPacksAndUpdate(
                        BitmapBuilder needBitmap) throws IOException {
@@ -115,7 +111,6 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                return Collections.emptyList();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<ObjectId> resolve(AbbreviatedObjectId id)
                        throws IOException {
@@ -126,13 +121,11 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                return matches;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean has(AnyObjectId objectId) throws IOException {
                return db.has(objectId);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectLoader open(AnyObjectId objectId, int typeHint)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -149,13 +142,11 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                return ldr;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Set<ObjectId> getShallowCommits() throws IOException {
                return db.getShallowCommits();
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getObjectSize(AnyObjectId objectId, int typeHint)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -170,13 +161,11 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                return sz;
        }
 
-       /** {@inheritDoc} */
        @Override
        public LocalObjectToPack newObjectToPack(AnyObjectId objectId, int type) {
                return new LocalObjectToPack(objectId, type);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void selectObjectRepresentation(PackWriter packer,
                        ProgressMonitor monitor, Iterable<ObjectToPack> objects)
@@ -187,7 +176,6 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void copyObjectAsIs(PackOutputStream out, ObjectToPack otp,
                        boolean validate) throws IOException,
@@ -196,7 +184,6 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                src.pack.copyAsIs(out, src, validate, this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void writeObjects(PackOutputStream out, List<ObjectToPack> list)
                        throws IOException {
@@ -240,7 +227,6 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                return cnt - need;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void copyPackAsIs(PackOutputStream out, CachedPack pack)
                        throws IOException {
@@ -336,7 +322,6 @@ final class WindowCursor extends ObjectReader implements ObjectReuseAsIs {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        @Nullable
        public ObjectInserter getCreatedFromInserter() {
index 82d07e6bde8766ed551e345b881682872935a515..58695fc9ab8c1a220d09138784440124a53925db 100644 (file)
@@ -147,7 +147,6 @@ public abstract class BlockSource implements AutoCloseable {
                // Do nothing by default.
        }
 
-       /** {@inheritDoc} */
        @Override
        public abstract void close();
 }
index ca2095feec1ab842911f78dc813c3cb8bfb3e6da..ce86eabe90c07e1a9faf482271225d715eae9e83 100644 (file)
@@ -80,7 +80,6 @@ public class CancellableDigestOutputStream extends OutputStream {
                return count;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final void write(int b) throws IOException {
                if (checkCancelAt <= count) {
@@ -95,7 +94,6 @@ public class CancellableDigestOutputStream extends OutputStream {
                count++;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final void write(byte[] b, int off, int len) throws IOException {
                while (0 < len) {
@@ -116,7 +114,6 @@ public class CancellableDigestOutputStream extends OutputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                out.flush();
index 1ac662736084eaf7d2d4157ef8d14f6f60f6f4f0..acc1c830d586d0d8ebb42e6ffc69bb54b3abddef 100644 (file)
@@ -300,6 +300,7 @@ public final class TernarySearchTree<Value> {
         * Find the key which is the longest prefix of the given query string.
         *
         * @param query
+        *            the query string
         * @return the key which is the longest prefix of the given query string or
         *         {@code null} if none exists.
         */
index 7ed5defbe476cee9e0a25a3a4a428e5044308b70..b86ff7f177a6a32a2c55ee69b5c1be0ce509ebe6 100644 (file)
@@ -393,7 +393,6 @@ public class DeltaIndex {
                return start - resPtr;
        }
 
-       /** {@inheritDoc} */
        @Override
        @SuppressWarnings("nls")
        public String toString() {
index 132eb5095b4e61d653f1ec2181cfa2a84d56ed06..9a3f4b07eee7fcef316f196e1bea64ec9f60a312 100644 (file)
@@ -254,7 +254,6 @@ final class DeltaTask implements Callable<Object> {
                slices.add(s);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Object call() throws Exception {
                or = block.templateReader.newReader();
index d9013bff26c4dfbc4b36ec94ba920a4ddfe0d480..ea5b9461ca67dab7a5b59649b103fca470596b8d 100644 (file)
@@ -156,7 +156,6 @@ public class ObjectToPack extends PackedObjectInfo {
                return 1 < getOffset(); // markWantWrite sets 1.
        }
 
-       /** {@inheritDoc} */
        @Override
        public final int getType() {
                return (flags >> TYPE_SHIFT) & 0x7;
@@ -357,7 +356,6 @@ public class ObjectToPack extends PackedObjectInfo {
                // Empty by default.
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index d580083795ea86650b17a29bae73b8456fdaf10e..e6daaeaca9162c661089f48b77ede03a57afdeff 100644 (file)
@@ -80,7 +80,6 @@ public enum PackExt {
                return String.format(".%s_tmp", ext); //$NON-NLS-1$
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return String.format("PackExt[%s, bit=0x%s]", getExtension(), //$NON-NLS-1$
index 9508f3fe39808c505f09b35fe571d30a8b96124b..1b4c5e21a82508a90f1d9597f15fe4e45cb8ec78 100644 (file)
@@ -2286,7 +2286,7 @@ public class PackWriter implements AutoCloseable {
 
        /**
         * Determines if the object should be omitted from the pack as a result of
-        * its depth (probably because of the tree:<depth> filter).
+        * its depth (probably because of the tree:&lt;depth&gt; filter).
         * <p>
         * Causes {@code walker} to skip traversing the current tree, which ought to
         * have just started traversal, assuming this method is called as soon as a
index 7c06be876bb2b90af8a2f0ae6d71e4bb8bc51657..8700556d48b2dcaa286db676c05e3c255d51fbda 100644 (file)
@@ -16,31 +16,26 @@ import org.eclipse.jgit.lib.ReflogEntry;
 
 /** Empty {@link LogCursor} with no results. */
 class EmptyLogCursor extends LogCursor {
-       /** {@inheritDoc} */
        @Override
        public boolean next() throws IOException {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getRefName() {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getUpdateIndex() {
                return 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ReflogEntry getReflogEntry() {
                return null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                // Do nothing.
index f78975af34ceef926b93da6083247ac15d2ef765..f9c701ebe25c0041aefdd47290a3c45910f0f7c6 100644 (file)
@@ -51,7 +51,6 @@ public abstract class LogCursor implements AutoCloseable {
        @Nullable
        public abstract ReflogEntry getReflogEntry();
 
-       /** {@inheritDoc} */
        @Override
        public abstract void close();
 }
index e210acf0588253ba7c9af1b8f3560c671d69052b..aeaf24171005063c2eee208207c56f8729b23a87 100644 (file)
@@ -39,7 +39,6 @@ public class MergedReftable extends Reftable {
 
        /**
         * Initialize a merged table reader.
-        * <p>
         *
         * @param tableStack
         *            stack of tables to read from. The base of the stack is at
@@ -91,7 +90,6 @@ public class MergedReftable extends Reftable {
                return minUpdateIndex;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasObjectMap() throws IOException {
                boolean has = true;
@@ -101,7 +99,6 @@ public class MergedReftable extends Reftable {
                return has;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefCursor allRefs() throws IOException {
                MergedRefCursor m = new MergedRefCursor();
@@ -111,7 +108,6 @@ public class MergedReftable extends Reftable {
                return m;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefCursor seekRef(String name) throws IOException {
                MergedRefCursor m = new MergedRefCursor();
@@ -121,7 +117,6 @@ public class MergedReftable extends Reftable {
                return m;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefCursor seekRefsWithPrefix(String prefix) throws IOException {
                MergedRefCursor m = new MergedRefCursor();
@@ -131,7 +126,6 @@ public class MergedReftable extends Reftable {
                return m;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefCursor byObjectId(AnyObjectId name) throws IOException {
                MergedRefCursor m = new FilteringMergedRefCursor(name);
@@ -141,7 +135,6 @@ public class MergedReftable extends Reftable {
                return m;
        }
 
-       /** {@inheritDoc} */
        @Override
        public LogCursor allLogs() throws IOException {
                MergedLogCursor m = new MergedLogCursor();
@@ -151,7 +144,6 @@ public class MergedReftable extends Reftable {
                return m;
        }
 
-       /** {@inheritDoc} */
        @Override
        public LogCursor seekLog(String refName, long updateIdx)
                        throws IOException {
index 5e2c3508839f66febab37e540223c31373f32166..6cd4f6c81d2c237341392237769ac57b6ac0ae5e 100644 (file)
@@ -58,7 +58,6 @@ public abstract class RefCursor implements AutoCloseable {
                return r.getStorage() == Ref.Storage.NEW && r.getObjectId() == null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public abstract void close();
 }
index 63786dc17ecc58b4abce88ea24bc4acc6f149226..6e83778c78e662fdc8ed623115e9a834f15ac37e 100644 (file)
@@ -138,7 +138,7 @@ public abstract class Reftable {
        public abstract RefCursor byObjectId(AnyObjectId id) throws IOException;
 
        /**
-        * @return whether this reftable can do a fast SHA1 => ref lookup.
+        * @return whether this reftable can do a fast SHA1 =&gt; ref lookup.
         * @throws IOException on I/O problems.
         */
        public abstract boolean hasObjectMap() throws IOException;
index dbc2ec7dc9485e3fdc2bff227ff9dd9be5af7148..38c17e346a6b3e284943f0986cea2cc6723c5f37 100644 (file)
@@ -81,7 +81,6 @@ public abstract class ReftableBatchRefUpdate extends BatchRefUpdate {
                this.repository = repository;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void execute(RevWalk rw, ProgressMonitor pm, List<String> options) {
                List<ReceiveCommand> pending = getPending();
index aa3aba516fd5fc375cb14a8f69b4f65dd41fe62d..86e16ec8638aa0c66321506747b3d237baf5a062 100644 (file)
@@ -59,14 +59,12 @@ class ReftableOutputStream extends OutputStream {
                blockSize = bs;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) {
                ensureBytesAvailableInBlockBuf(1);
                blockBuf[cur++] = (byte) b;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b, int off, int cnt) {
                ensureBytesAvailableInBlockBuf(cnt);
index cabb2e184259748f640459b1eb559bc179f49640..2a73efd962f47874f7a96408419fce44682b0458 100644 (file)
@@ -127,7 +127,6 @@ public class ReftableReader extends Reftable implements AutoCloseable {
                return maxUpdateIndex;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefCursor allRefs() throws IOException {
                if (blockSize == -1) {
@@ -144,7 +143,6 @@ public class ReftableReader extends Reftable implements AutoCloseable {
                return i;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefCursor seekRef(String refName) throws IOException {
                initRefIndex();
@@ -155,7 +153,6 @@ public class ReftableReader extends Reftable implements AutoCloseable {
                return i;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefCursor seekRefsWithPrefix(String prefix) throws IOException {
                initRefIndex();
@@ -166,7 +163,6 @@ public class ReftableReader extends Reftable implements AutoCloseable {
                return i;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RefCursor byObjectId(AnyObjectId id) throws IOException {
                initObjIndex();
@@ -179,7 +175,6 @@ public class ReftableReader extends Reftable implements AutoCloseable {
                return i;
        }
 
-       /** {@inheritDoc} */
        @Override
        public LogCursor allLogs() throws IOException {
                initLogIndex();
@@ -192,7 +187,6 @@ public class ReftableReader extends Reftable implements AutoCloseable {
                return new EmptyLogCursor();
        }
 
-       /** {@inheritDoc} */
        @Override
        public LogCursor seekLog(String refName, long updateIndex)
                        throws IOException {
@@ -460,7 +454,6 @@ public class ReftableReader extends Reftable implements AutoCloseable {
                return src.size();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                src.close();
index f9f1def95819b5d2862ebb0f805b925fef6028f9..597303301a3f05b1f19c6635a77c45b31a31bba8 100644 (file)
@@ -34,7 +34,6 @@ public class ReftableReflogReader implements ReflogReader {
                this.refname = refname;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ReflogEntry getLastEntry() throws IOException {
                lock.lock();
@@ -46,13 +45,11 @@ public class ReftableReflogReader implements ReflogReader {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<ReflogEntry> getReverseEntries() throws IOException {
                return getReverseEntries(Integer.MAX_VALUE);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ReflogEntry getReverseEntry(int number) throws IOException {
                lock.lock();
@@ -72,7 +69,6 @@ public class ReftableReflogReader implements ReflogReader {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public List<ReflogEntry> getReverseEntries(int max) throws IOException {
                lock.lock();
index d0e24413bb1724575c2cb40dbf43726f54351ddc..ff8308df40169aabecd8e9925a7ffe381623833f 100644 (file)
@@ -45,8 +45,8 @@ public class SubmoduleValidator {
                 * @param message
                 *            Description of the problem
                 * @param fsckMessageId
-                *            Error identifier, following the git fsck fsck.<msg-id>
-                *            format
+                *            Error identifier, following the git fsck
+                *            fsck.&lt;msg-id&gt; format
                 */
                SubmoduleValidationException(String message,
                                ObjectChecker.ErrorType fsckMessageId) {
index 659ccb8c55fa267820e6260464142669b643dee2..29a2922136d71563cb227325248298846fe76747 100644 (file)
@@ -1154,7 +1154,6 @@ public class OpenSshConfigFile implements SshConfigStore {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        @SuppressWarnings("nls")
        public String toString() {
index 9109cfd769de4354ed56afabe4c19ee245d5758d..c3dffdfe79b4437781daee99b9b13f7ccca9f7f5 100644 (file)
@@ -19,7 +19,7 @@ import org.eclipse.jgit.internal.JGitText;
 
 /**
  * Git configuration option <a
- * href=https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreabbrev">
+ * href="https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreabbrev">
  * core.abbrev</a>
  *
  * @since 6.1
@@ -100,6 +100,7 @@ public final class AbbrevConfig {
         * object names to stay unique for some time.
         *
         * @param repo
+        *            the repository the AbbrevConfig shall be computed for
         * @return appropriate value computed based on the approximate number of
         *         packed objects in a repository
         */
@@ -128,7 +129,10 @@ public final class AbbrevConfig {
        private int abbrev;
 
        /**
+        * Create an {@code AbbrevConfig}
+        *
         * @param abbrev
+        *            abbreviation length
         */
        private AbbrevConfig(int abbrev) {
                this.abbrev = capAbbrev(abbrev);
index dc5e5cc20fc3280ca45dda7032e68cae9325414f..a13136b9f1ed02c191c2682874cb18336bdd82f3 100644 (file)
@@ -321,13 +321,11 @@ public final class AbbreviatedObjectId implements Serializable {
                return mask(nibbles, word, v);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return w1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object o) {
                if (o instanceof AbbreviatedObjectId) {
@@ -366,7 +364,6 @@ public final class AbbreviatedObjectId implements Serializable {
                return new String(b, 0, nibbles);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 7685b30f8ea7f3aa8d3848492f94275c201ff342..c58133adab20f1711c60ca02e057e81e6f3c982f 100644 (file)
@@ -248,7 +248,6 @@ public abstract class AnyObjectId implements Comparable<AnyObjectId> {
                return abbr.prefixCompare(this) == 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final int hashCode() {
                return w2;
@@ -266,7 +265,6 @@ public abstract class AnyObjectId implements Comparable<AnyObjectId> {
                return other != null ? isEqual(this, other) : false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final boolean equals(Object o) {
                if (o instanceof AnyObjectId) {
@@ -477,7 +475,6 @@ public abstract class AnyObjectId implements Comparable<AnyObjectId> {
                        dst[o--] = '0';
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index d2367cc3d5eac197395f7827e206cfdfd6aecfb9..f9952501c303fa5f82a67a3e2441435bc0091bc8 100644 (file)
@@ -716,7 +716,6 @@ public class BatchRefUpdate {
                                : isForceRefLog();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder r = new StringBuilder();
index f826057370e20644fc440c1343f22f9a48b9c437..8e92f20cb0f6cd6098814a193573f0d262cd70ea 100644 (file)
@@ -47,13 +47,11 @@ public abstract class BatchingProgressMonitor implements ProgressMonitor {
                delayStartUnit = unit;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void start(int totalTasks) {
                // Ignore the number of tasks.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void beginTask(String title, int work) {
                endTask();
@@ -62,14 +60,12 @@ public abstract class BatchingProgressMonitor implements ProgressMonitor {
                        task.delay(delayStartTime, delayStartUnit);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void update(int completed) {
                if (task != null)
                        task.update(this, completed);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void endTask() {
                if (task != null) {
@@ -78,7 +74,6 @@ public abstract class BatchingProgressMonitor implements ProgressMonitor {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isCancelled() {
                return false;
index 6c625bb73a03217a14634a758fae38afec549536..39fc566034f498a9722768e3ebf6f814843396fd 100644 (file)
@@ -33,6 +33,7 @@ public class BranchTrackingStatus {
         *            the local branch
         * @return the tracking status, or null if it is not known
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static BranchTrackingStatus of(Repository repository, String branchName)
                        throws IOException {
index 1665f051e9250f1c337f7bbeb4708fca63493776..ea330822298864dc8a888b3f73c0ed4fcfafec34 100644 (file)
@@ -275,7 +275,6 @@ public class CommitBuilder extends ObjectBuilder {
                return build();
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index d1d66d280e0d5ee5a4e77bd749eab88186a21353..0cccaec49229e74d08c4c65f114fff710f867b36 100644 (file)
@@ -399,6 +399,8 @@ public class Config {
        /**
         * Parse an enumeration from the configuration.
         *
+        * @param <T>
+        *            type of the returned enum
         * @param section
         *            section the key is grouped within.
         * @param subsection
@@ -431,6 +433,8 @@ public class Config {
        /**
         * Parse an enumeration from the configuration.
         *
+        * @param <T>
+        *            type of the returned enum
         * @param all
         *            all possible values in the enumeration which should be
         *            recognized. Typically {@code EnumType.values()}.
@@ -722,7 +726,7 @@ public class Config {
         * responsible for issuing {@link #fireConfigChangedEvent()} calls
         * themselves.
         *
-        * @return <code></code>
+        * @return whether to issue change events for transient changes
         */
        protected boolean notifyUponTransientChanges() {
                return true;
@@ -847,6 +851,8 @@ public class Config {
         *         name = value
         * </pre>
         *
+        * @param <T>
+        *            type of the enum to set
         * @param section
         *            section name, e.g "branch"
         * @param subsection
index 4c080f47616af03135cab4a679f89293089ce232..621db89f668bf94710a935cc712260fecb82e0a8 100644 (file)
@@ -60,7 +60,8 @@ public final class ConfigConstants {
        public static final String CONFIG_KEY_PROMPT = "prompt";
 
        /**
-        * The "trustExitCode" key within "difftool" or "mergetool.<name>." section
+        * The "trustExitCode" key within "difftool" or "mergetool.&lt;name&gt;."
+        * section
         *
         * @since 6.1
         */
index a9235ebcdf66777fc6bca33bf3389a786ae8c535..e9a8b442711c99fa5aff5dfd6042b24d4e556893 100644 (file)
@@ -83,7 +83,6 @@ class ConfigLine {
                return a.equals(b);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 3b2ef42bbec19e145233dfb5661a689a13080d43..60a23dde057052b4388ec56b03ed667ebfb9c370 100644 (file)
@@ -337,9 +337,9 @@ public final class Constants {
        public static final String GIT_CONFIG_NOSYSTEM_KEY = "GIT_CONFIG_NOSYSTEM";
 
        /**
-        * The key of the XDG_CONFIG_HOME directory defined in the XDG base
-        * directory specification, see
-        * {@link "https://wiki.archlinux.org/index.php/XDG_Base_Directory"}
+        * The key of the XDG_CONFIG_HOME directory defined in the
+        * <a href="https://wiki.archlinux.org/index.php/XDG_Base_Directory">
+        * XDG Base Directory specification</a>.
         *
         * @since 5.5.2
         */
index 86409403b00d30ab4c4e82c5a7890de8fe98670b..80aceb4e7d1f3aef0ff4de1c7ffbc00a3b88b0c0 100644 (file)
@@ -31,7 +31,6 @@ import org.eclipse.jgit.util.StringUtils;
  */
 public class DefaultTypedConfigGetter implements TypedConfigGetter {
 
-       /** {@inheritDoc} */
        @Override
        public boolean getBoolean(Config config, String section, String subsection,
                        String name, boolean defaultValue) {
@@ -50,7 +49,6 @@ public class DefaultTypedConfigGetter implements TypedConfigGetter {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public <T extends Enum<?>> T getEnum(Config config, T[] all, String section,
                        String subsection, String name, T defaultValue) {
@@ -106,7 +104,6 @@ public class DefaultTypedConfigGetter implements TypedConfigGetter {
                                JGitText.get().enumValueNotSupported2, section, name, value));
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getInt(Config config, String section, String subsection,
                        String name, int defaultValue) {
@@ -118,7 +115,6 @@ public class DefaultTypedConfigGetter implements TypedConfigGetter {
                                .format(JGitText.get().integerValueOutOfRange, section, name));
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getIntInRange(Config config, String section, String subsection,
                        String name, int minValue, int maxValue, int defaultValue) {
@@ -138,7 +134,6 @@ public class DefaultTypedConfigGetter implements TypedConfigGetter {
                                Integer.valueOf(minValue), Integer.valueOf(maxValue)));
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getLong(Config config, String section, String subsection,
                        String name, long defaultValue) {
@@ -158,7 +153,6 @@ public class DefaultTypedConfigGetter implements TypedConfigGetter {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public long getTimeUnit(Config config, String section, String subsection,
                        String name, long defaultValue, TimeUnit wantUnit) {
@@ -269,7 +263,6 @@ public class DefaultTypedConfigGetter implements TypedConfigGetter {
                                                section, name, valueString));
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public List<RefSpec> getRefSpecs(Config config, String section,
index 94d28eb345c05106181cbb64aa243c29f2f4e9c0..a5410b778cd985c48c21dcea8c24c1527e2ad7e1 100644 (file)
@@ -18,31 +18,26 @@ package org.eclipse.jgit.lib;
  */
 public abstract class EmptyProgressMonitor implements ProgressMonitor {
 
-       /** {@inheritDoc} */
        @Override
        public void start(int totalTasks) {
                // empty
        }
 
-       /** {@inheritDoc} */
        @Override
        public void beginTask(String title, int totalWork) {
                // empty
        }
 
-       /** {@inheritDoc} */
        @Override
        public void update(int completed) {
                // empty
        }
 
-       /** {@inheritDoc} */
        @Override
        public void endTask() {
                // empty
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isCancelled() {
                return false;
index e78cf16ea43b0d02b12a443ca53112d641aaded9..4018dabebe45005c03c91db487499a484fa4e874 100644 (file)
@@ -49,7 +49,6 @@ public class GpgSignature implements Serializable {
                return new String(signature, US_ASCII);
        }
 
-       /** {@inheritDoc} */
        @Override
        @SuppressWarnings("nls")
        public String toString() {
index df9fd47efa8315778c89a970cb74f3b58fe30517..b009ea1af7f2f7e6eae0b4ff9dfc8b9576511162 100644 (file)
@@ -265,6 +265,7 @@ public class IndexDiff {
         * @param workingTreeIterator
         *            iterator for working directory
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public IndexDiff(Repository repository, String revstr,
                        WorkingTreeIterator workingTreeIterator) throws IOException {
@@ -281,6 +282,7 @@ public class IndexDiff {
         * @param workingTreeIterator
         *            iterator for working directory
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public IndexDiff(Repository repository, ObjectId objectId,
                        WorkingTreeIterator workingTreeIterator) throws IOException {
@@ -325,6 +327,7 @@ public class IndexDiff {
         * Allows higher layers to set the factory for WorkingTreeIterators.
         *
         * @param wTreeIt
+        *            working tree iterator factory
         * @since 3.6
         */
        public void setWorkingTreeItFactory(WorkingTreeIteratorFactory wTreeIt) {
@@ -349,6 +352,7 @@ public class IndexDiff {
         *
         * @return if anything is different between index, tree, and workdir
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public boolean diff() throws IOException {
                return diff(null);
@@ -372,6 +376,7 @@ public class IndexDiff {
         *            {@link RepositoryBuilder}.
         * @return if anything is different between index, tree, and workdir
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 5.6
         */
        public boolean diff(RepositoryBuilderFactory factory)
@@ -395,9 +400,11 @@ public class IndexDiff {
         *            number or estimated files in the working tree
         * @param estIndexSize
         *            number of estimated entries in the cache
-        * @param title a {@link java.lang.String} object.
+        * @param title
+        *            a {@link java.lang.String} object.
         * @return if anything is different between index, tree, and workdir
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public boolean diff(final ProgressMonitor monitor, int estWorkTreeSize,
                        int estIndexSize, final String title)
@@ -436,6 +443,7 @@ public class IndexDiff {
         *            {@link RepositoryBuilder}.
         * @return if anything is different between index, tree, and workdir
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 5.6
         */
        public boolean diff(ProgressMonitor monitor, int estWorkTreeSize,
index 4a712ba360610d45e00177b7dd5b53e4b8b9d114..6a35dedcf5bcadfbd21ac361c15819ba7b535728 100644 (file)
@@ -242,7 +242,6 @@ public class MutableObjectId extends AnyObjectId {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId toObjectId() {
                return new ObjectId(this);
index 127cca9d1b429dbae4f5bfd1d15075e2f76f33d5..0a4db2a5f63ffa677e9a57548a7b311acd9c0c1b 100644 (file)
@@ -23,31 +23,26 @@ public class NullProgressMonitor implements ProgressMonitor {
                // Do not let others instantiate
        }
 
-       /** {@inheritDoc} */
        @Override
        public void start(int totalTasks) {
                // Do not report.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void beginTask(String title, int totalWork) {
                // Do not report.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void update(int completed) {
                // Do not report.
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isCancelled() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void endTask() {
                // Do not report.
index 4b7054f72b6841c8e8f0a6641e2bb33e212c79b8..064d89e084cff9c1ae68077a49f7ce6623b04898 100644 (file)
@@ -72,7 +72,6 @@ public abstract class ObjectBuilder {
         * <li>create {@link GpgSignature} from payload</li>
         * <li>set {@link GpgSignature}</li>
         * </ol>
-        * </p>
         *
         * @param gpgSignature
         *            the signature to set or {@code null} to unset
index 9e9ef882a3a3ffe9f0d1d3690da849159357d25b..a1d6d92ec25159e2486155ecd5c424468d973841 100644 (file)
@@ -1065,6 +1065,7 @@ public class ObjectChecker {
         *
         * @return true if the filename in buf could be a ".gitmodules" file
         * @throws CorruptObjectException
+        *             if an object is corrupt
         */
        private boolean isGitmodules(byte[] buf, int start, int end, @Nullable AnyObjectId id)
                        throws CorruptObjectException {
index 269049f4a220bd3ec006ea29db8657993bff5aa2..1c31263e33481f805f1a9c86e2ec20b5279c05b6 100644 (file)
@@ -262,7 +262,6 @@ public class ObjectId extends AnyObjectId implements Serializable {
                w5 = src.w5;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId toObjectId() {
                return this;
index 29039097f1afeb4c3ef8105fe6e5ed044134750a..a74fddff42577f9ba89db920ecc444a0d8ee95c6 100644 (file)
@@ -128,8 +128,11 @@ public class ObjectIdOwnerMap<V extends ObjectIdOwnerMap.Entry>
         * <p>
         * An existing mapping for <b>must not</b> be in this map. Callers must
         * first call {@link #get(AnyObjectId)} to verify there is no current
-        * mapping prior to adding a new mapping, or use {@link #addIfAbsent(Entry)}.
+        * mapping prior to adding a new mapping, or use
+        * {@link #addIfAbsent(Entry)}.
         *
+        * @param <Q>
+        *            type of values
         * @param newValue
         *            the object to store.
         */
@@ -157,6 +160,8 @@ public class ObjectIdOwnerMap<V extends ObjectIdOwnerMap.Entry>
         * boolean wasNew = map.addIfAbsent(obj) == obj;
         * </pre>
         *
+        * @param <Q>
+        *            type of values
         * @param newValue
         *            the object to store.
         * @return {@code newValue} if stored, or the prior value already stored and
@@ -199,7 +204,6 @@ public class ObjectIdOwnerMap<V extends ObjectIdOwnerMap.Entry>
                return size == 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<V> iterator() {
                return new Iterator<>() {
index a04ca6890c742e3cb9e5fd3eec4eb521ddce128b..c3c58372b1a14e3ed2f462f887da1d8c6b7c0ab8 100644 (file)
@@ -204,41 +204,35 @@ public abstract class ObjectIdRef implements Ref {
                this.updateIndex = updateIndex;
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public String getName() {
                return name;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isSymbolic() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public Ref getLeaf() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public Ref getTarget() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        @Nullable
        public ObjectId getObjectId() {
                return objectId;
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public Storage getStorage() {
@@ -257,7 +251,6 @@ public abstract class ObjectIdRef implements Ref {
                return updateIndex;
        }
 
-       /** {@inheritDoc} */
        @NonNull
        @Override
        public String toString() {
index 0e015b658b9abb2bc8d0cec5e82af443a4aea92f..d4acfd4714dcf3f00814c3f2c970ca1bef1d69d2 100644 (file)
@@ -96,6 +96,8 @@ public class ObjectIdSubclassMap<V extends ObjectId>
         * mapping prior to adding a new mapping, or use
         * {@link #addIfAbsent(ObjectId)}.
         *
+        * @param <Q>
+        *            type of values
         * @param newValue
         *            the object to store.
         */
@@ -117,6 +119,8 @@ public class ObjectIdSubclassMap<V extends ObjectId>
         * boolean wasNew = map.addIfAbsent(obj) == obj;
         * </pre>
         *
+        * @param <Q>
+        *            type of values
         * @param newValue
         *            the object to store.
         * @return {@code newValue} if stored, or the prior value already stored and
@@ -162,7 +166,6 @@ public class ObjectIdSubclassMap<V extends ObjectId>
                return size == 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<V> iterator() {
                return new Iterator<>() {
index 69b2b5104e4be4a0152c8277991c65608195b08d..3e2998530f1d2f8f432e27cab0b3d434b45c9a21 100644 (file)
@@ -245,12 +245,15 @@ public abstract class ObjectReader implements AutoCloseable {
         *
         * @return IDs of shallow commits
         * @throws java.io.IOException
+        *             if an error occurred
         */
        public abstract Set<ObjectId> getShallowCommits() throws IOException;
 
        /**
         * Asynchronous object opening.
         *
+        * @param <T>
+        *            type of {@code ObjectId}
         * @param objectIds
         *            objects to open from the object store. The supplied collection
         *            must not be modified until the queue has finished.
@@ -370,6 +373,8 @@ public abstract class ObjectReader implements AutoCloseable {
        /**
         * Asynchronous object size lookup.
         *
+        * @param <T>
+        *            type of {@code ObjectId}
         * @param objectIds
         *            objects to get the size of from the object store. The supplied
         *            collection must not be modified until the queue has finished.
index 93710299b4a45576b8964615c89cedd8c55dd076..3ba055aae80f7240bcbc55d7c111a490686c3014 100644 (file)
@@ -392,7 +392,6 @@ public class PersonIdent implements Serializable {
                return hc;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object o) {
                if (o instanceof PersonIdent) {
@@ -421,7 +420,6 @@ public class PersonIdent implements Serializable {
                return r.toString();
        }
 
-       /** {@inheritDoc} */
        @Override
        @SuppressWarnings("nls")
        public String toString() {
index a4cd1d68946735c4ca2e2db95b46a8a7f28a9913..c716f464d31eb88a5c7dac2848544771600f46c9 100644 (file)
@@ -55,6 +55,7 @@ public class RebaseTodoFile {
         *            <code>true</code> if also comments should be reported
         * @return the list of steps
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public List<RebaseTodoLine> readRebaseTodo(String path,
                        boolean includeComments) throws IOException {
@@ -126,8 +127,11 @@ public class RebaseTodoFile {
         * Skip leading space, tab, CR and LF characters
         *
         * @param buf
+        *            byte buffer
         * @param tokenBegin
+        *            index of token begin
         * @param lineEnd
+        *            index of line end
         * @return the token within the range of the given {@code buf} that doesn't
         *         need to be skipped, {@code -1} if no such token found within the
         *         range (i.e. empty line)
@@ -193,6 +197,7 @@ public class RebaseTodoFile {
         * @param append
         *            whether to append to an existing file or to write a new file
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void writeRebaseTodoFile(String path, List<RebaseTodoLine> steps,
                        boolean append) throws IOException {
index 8b778497fcd85d29e4f95e31800beb989164ce36..878cfc8f9d29582cc9d33a48d24de8643a39eb32 100644 (file)
@@ -70,6 +70,7 @@ public class RebaseTodoLine {
 
                /**
                 * @param token
+                *            token to parse
                 * @return the Action
                 */
                public static Action parse(String token) {
@@ -245,7 +246,6 @@ public class RebaseTodoLine {
                return comment;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 3ab649341f5eb8515d9066832d7324b2a76af497..c4c0001d3e2a1adfe46b5f782bc2313b64c949c5 100644 (file)
@@ -27,7 +27,6 @@ public class RefComparator implements Comparator<Ref> {
        /** Singleton instance of RefComparator */
        public static final RefComparator INSTANCE = new RefComparator();
 
-       /** {@inheritDoc} */
        @Override
        public int compare(Ref o1, Ref o2) {
                return compareTo(o1, o2);
index 98089fb8fd9fa66cc24a56fc4533ad772b6f323f..82dcc6b64c32d9b5ef3fd557b9fa5c17bb752022 100644 (file)
@@ -136,6 +136,7 @@ public abstract class RefDatabase {
         *         with the passed ref name; empty collection when there are no
         *         conflicts
         * @throws java.io.IOException
+        *             if an error occurred
         * @since 2.3
         * @see #isNameConflicting(String)
         */
index cdd4e4ba752a2802cddbc576f80e79404f5262cd..e8821d0cbb58dd8382723218e073a2cc1c3d9884 100644 (file)
@@ -122,6 +122,7 @@ public abstract class RefRename {
         *
         * @return the result of the new ref update
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public Result rename() throws IOException {
                try {
@@ -138,6 +139,7 @@ public abstract class RefRename {
         *
         * @return the result of the rename operation.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected abstract Result doRename() throws IOException;
 
index d1be63b966324912aa23797e949c175662dc2e9a..d113243bea926d7c615f451d645e68d97c0b56f2 100644 (file)
@@ -115,7 +115,6 @@ public abstract class RefUpdate {
 
                /**
                 * The ref was renamed from another name
-                * <p>
                 */
                RENAMED,
 
@@ -245,6 +244,7 @@ public abstract class RefUpdate {
         *            a {@link org.eclipse.jgit.lib.RefUpdate.Result} object.
         * @return {@code result}
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected abstract Result doUpdate(Result desiredResult) throws IOException;
 
@@ -255,6 +255,7 @@ public abstract class RefUpdate {
         *            a {@link org.eclipse.jgit.lib.RefUpdate.Result} object.
         * @return {@code result}
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected abstract Result doDelete(Result desiredResult) throws IOException;
 
@@ -265,6 +266,7 @@ public abstract class RefUpdate {
         *            a {@link java.lang.String} object.
         * @return {@link org.eclipse.jgit.lib.RefUpdate.Result#NEW} on success.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected abstract Result doLink(String target) throws IOException;
 
@@ -612,6 +614,7 @@ public abstract class RefUpdate {
         *
         * @return the result status of the delete.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public Result delete() throws IOException {
                try (RevWalk rw = new RevWalk(getRepository())) {
@@ -628,6 +631,7 @@ public abstract class RefUpdate {
         *            the merge test. The walk will be reset to perform the test.
         * @return the result status of the delete.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public Result delete(RevWalk walk) throws IOException {
                final String myName = detachingSymbolicRef
@@ -668,6 +672,7 @@ public abstract class RefUpdate {
         * @return {@link org.eclipse.jgit.lib.RefUpdate.Result#NEW} or
         *         {@link org.eclipse.jgit.lib.RefUpdate.Result#FORCED} on success.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public Result link(String target) throws IOException {
                if (!target.startsWith(Constants.R_REFS))
index d2c3f9de68a2a958e4a7657ee686cc2413068819..41917f8b5700fc971960663ec630da042c0e23ac 100644 (file)
@@ -177,6 +177,7 @@ public abstract class RefWriter {
         * @param content
         *            byte content of file to be written.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected abstract void writeFile(String file, byte[] content)
                        throws IOException;
index 1e6a6615720d3e9a173d903e3223b1978e14eaa9..5233bfc109f5e0092dcaccf95ae7c86399ed5884 100644 (file)
@@ -25,6 +25,7 @@ public interface ReflogReader {
         *
         * @return the latest reflog entry, or null if no log
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        ReflogEntry getLastEntry() throws IOException;
 
@@ -33,6 +34,7 @@ public interface ReflogReader {
         *
         * @return all reflog entries in reverse order
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        List<ReflogEntry> getReverseEntries() throws IOException;
 
@@ -40,9 +42,11 @@ public interface ReflogReader {
         * Get specific entry in the reflog relative to the last entry which is
         * considered entry zero.
         *
-        * @param number a int.
+        * @param number
+        *            a int.
         * @return reflog entry or null if not found
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        ReflogEntry getReverseEntry(int number) throws IOException;
 
@@ -53,6 +57,7 @@ public interface ReflogReader {
         *            max number of entries to read
         * @return all reflog entries in reverse order
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        List<ReflogEntry> getReverseEntries(int max) throws IOException;
 }
index db2571c673b452481db2c7b18b5fa8b1b7811692..d446a1c9c7d3fb1b9f0907cf76177b7a0fdb706d 100644 (file)
@@ -175,6 +175,7 @@ public abstract class Repository implements AutoCloseable {
         * the same as {@code create(false)}.
         *
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @see #create(boolean)
         */
        public void create() throws IOException {
@@ -484,11 +485,14 @@ public abstract class Repository implements AutoCloseable {
         * Thus this method can be used to process an expression to a method that
         * expects a branch or revision id.
         *
-        * @param revstr a {@link java.lang.String} object.
+        * @param revstr
+        *            a {@link java.lang.String} object.
         * @return object id or ref name from resolved expression or {@code null} if
         *         given expression cannot be resolved
         * @throws org.eclipse.jgit.errors.AmbiguousObjectException
+        *             if a shortened ObjectId was ambiguous
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        @Nullable
        public String simplify(String revstr)
@@ -968,7 +972,6 @@ public abstract class Repository implements AutoCloseable {
                getRefDatabase().close();
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public String toString() {
@@ -999,6 +1002,7 @@ public abstract class Repository implements AutoCloseable {
         *         {@code null} if the repository is corrupt and has no HEAD
         *         reference.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        @Nullable
        public String getFullBranch() throws IOException {
@@ -1027,6 +1031,7 @@ public abstract class Repository implements AutoCloseable {
         *         in hex format if the current branch is detached, or {@code null}
         *         if the repository is corrupt and has no HEAD reference.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        @Nullable
        public String getBranch() throws IOException {
@@ -1056,6 +1061,7 @@ public abstract class Repository implements AutoCloseable {
         *
         * @return unmodifiable collection of other known objects.
         * @throws IOException
+        *             if an IO error occurred
         */
        @NonNull
        public Set<ObjectId> getAdditionalHaves() throws IOException {
@@ -1066,11 +1072,12 @@ public abstract class Repository implements AutoCloseable {
         * Get a ref by name.
         *
         * @param name
-        *            the name of the ref to lookup. Must not be a short-hand
-        *            form; e.g., "master" is not automatically expanded to
+        *            the name of the ref to lookup. Must not be a short-hand form;
+        *            e.g., "master" is not automatically expanded to
         *            "refs/heads/master".
         * @return the Ref with the given name, or {@code null} if it does not exist
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        @Nullable
@@ -1087,6 +1094,7 @@ public abstract class Repository implements AutoCloseable {
         *            "refs/heads/master" if "refs/heads/master" already exists.
         * @return the Ref with the given name, or {@code null} if it does not exist
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        @Nullable
@@ -1162,6 +1170,7 @@ public abstract class Repository implements AutoCloseable {
         *
         * @return a map with all objects referenced by a peeled ref.
         * @throws IOException
+        *             if an IO error occurred
         */
        @NonNull
        public Map<AnyObjectId, Set<Ref>> getAllRefsByPeeledObjectId()
@@ -1579,6 +1588,7 @@ public abstract class Repository implements AutoCloseable {
         * changes are detected.
         *
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public abstract void scanForRepoChanges() throws IOException;
 
@@ -1703,6 +1713,7 @@ public abstract class Repository implements AutoCloseable {
         * @return a {@link org.eclipse.jgit.lib.ReflogReader} for the supplied ref,
         *         or {@code null} if the ref does not exist.
         * @throws IOException
+        *             if an IO error occurred
         * @since 5.13.2
         */
        public @Nullable ReflogReader getReflogReader(@NonNull  Ref ref)
@@ -1718,6 +1729,7 @@ public abstract class Repository implements AutoCloseable {
         * @return a String containing the content of the MERGE_MSG file or
         *         {@code null} if this file doesn't exist
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.errors.NoWorkTreeException
         *             if this is bare, which implies it has no working directory.
         *             See {@link #isBare()}.
@@ -1737,6 +1749,7 @@ public abstract class Repository implements AutoCloseable {
         *            the message which should be written or <code>null</code> to
         *            delete the file
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void writeMergeCommitMsg(String msg) throws IOException {
                File mergeMsgFile = new File(gitDir, Constants.MERGE_MSG);
@@ -1751,6 +1764,7 @@ public abstract class Repository implements AutoCloseable {
         * @return a String containing the content of the COMMIT_EDITMSG file or
         *         {@code null} if this file doesn't exist
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.errors.NoWorkTreeException
         *             if this is bare, which implies it has no working directory.
         *             See {@link #isBare()}.
@@ -1770,6 +1784,7 @@ public abstract class Repository implements AutoCloseable {
         *            the message which should be written or {@code null} to delete
         *            the file
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.0
         */
        public void writeCommitEditMsg(String msg) throws IOException {
@@ -1786,6 +1801,7 @@ public abstract class Repository implements AutoCloseable {
         *         {@code null} if this file doesn't exist. Also if the file exists
         *         but is empty {@code null} will be returned
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.errors.NoWorkTreeException
         *             if this is bare, which implies it has no working directory.
         *             See {@link #isBare()}.
@@ -1818,6 +1834,7 @@ public abstract class Repository implements AutoCloseable {
         *            a list of commits which IDs should be written to
         *            $GIT_DIR/MERGE_HEAD or <code>null</code> to delete the file
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void writeMergeHeads(List<? extends ObjectId> heads) throws IOException {
                writeHeadsFile(heads, Constants.MERGE_HEAD);
@@ -1830,6 +1847,7 @@ public abstract class Repository implements AutoCloseable {
         *         doesn't exist. Also if the file exists but is empty {@code null}
         *         will be returned
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.errors.NoWorkTreeException
         *             if this is bare, which implies it has no working directory.
         *             See {@link #isBare()}.
@@ -1854,6 +1872,7 @@ public abstract class Repository implements AutoCloseable {
         *         doesn't exist. Also if the file exists but is empty {@code null}
         *         will be returned
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.errors.NoWorkTreeException
         *             if this is bare, which implies it has no working directory.
         *             See {@link #isBare()}.
@@ -1877,6 +1896,7 @@ public abstract class Repository implements AutoCloseable {
         *            an object id of the cherry commit or <code>null</code> to
         *            delete the file
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void writeCherryPickHead(ObjectId head) throws IOException {
                List<ObjectId> heads = (head != null) ? Collections.singletonList(head)
@@ -1892,6 +1912,7 @@ public abstract class Repository implements AutoCloseable {
         *            an object id of the revert commit or <code>null</code> to
         *            delete the file
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void writeRevertHead(ObjectId head) throws IOException {
                List<ObjectId> heads = (head != null) ? Collections.singletonList(head)
@@ -1906,6 +1927,7 @@ public abstract class Repository implements AutoCloseable {
         *            an object id of the original HEAD commit or <code>null</code>
         *            to delete the file
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void writeOrigHead(ObjectId head) throws IOException {
                List<ObjectId> heads = head != null ? Collections.singletonList(head)
@@ -1920,6 +1942,7 @@ public abstract class Repository implements AutoCloseable {
         *         doesn't exist. Also if the file exists but is empty {@code null}
         *         will be returned
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.errors.NoWorkTreeException
         *             if this is bare, which implies it has no working directory.
         *             See {@link #isBare()}.
@@ -1941,6 +1964,7 @@ public abstract class Repository implements AutoCloseable {
         * @return a String containing the content of the SQUASH_MSG file or
         *         {@code null} if this file doesn't exist
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws NoWorkTreeException
         *             if this is bare, which implies it has no working directory.
         *             See {@link #isBare()}.
@@ -1960,6 +1984,7 @@ public abstract class Repository implements AutoCloseable {
         *            the message which should be written or <code>null</code> to
         *            delete the file
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void writeSquashCommitMsg(String msg) throws IOException {
                File squashMsgFile = new File(gitDir, Constants.SQUASH_MSG);
@@ -1997,9 +2022,11 @@ public abstract class Repository implements AutoCloseable {
         * Read a file from the git directory.
         *
         * @param filename
+        *            the file to read
         * @return the raw contents or {@code null} if the file doesn't exist or is
         *         empty
         * @throws IOException
+        *             if an IO error occurred
         */
        private byte[] readGitDirectoryFile(String filename) throws IOException {
                File file = new File(getDirectory(), filename);
@@ -2021,8 +2048,11 @@ public abstract class Repository implements AutoCloseable {
         *            a list of object ids to write or null if the file should be
         *            deleted.
         * @param filename
+        *            name of the file to write heads to
         * @throws FileNotFoundException
+        *             if the heads file couldn't be found
         * @throws IOException
+        *             if an IO error occurred
         */
        private void writeHeadsFile(List<? extends ObjectId> heads, String filename)
                        throws FileNotFoundException, IOException {
@@ -2052,6 +2082,7 @@ public abstract class Repository implements AutoCloseable {
         *            <code>true</code> if also comments should be reported
         * @return the list of steps
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.2
         */
        @NonNull
@@ -2072,6 +2103,7 @@ public abstract class Repository implements AutoCloseable {
         * @param append
         *            whether to append to an existing file or to write a new file
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.2
         */
        public void writeRebaseTodoFile(String path, List<RebaseTodoLine> steps,
index 9ddfd59a189092ee82144f2a0e9b579a37e7eec1..a10eb0c583d9a27b4da6fedc03a741a1888d80f2 100644 (file)
@@ -57,7 +57,6 @@ public abstract class StoredConfig extends Config {
         */
        public abstract void save() throws IOException;
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                super.clear();
index 3ba33422c6472cb35bd6d660bc2f8796f2095fa6..6fb8f326ccd362b362c65ec45ef0efcd4bb2dd2f 100644 (file)
@@ -59,20 +59,17 @@ public class SymbolicRef implements Ref {
                this.updateIndex = updateIndex;
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public String getName() {
                return name;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isSymbolic() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public Ref getLeaf() {
@@ -82,35 +79,30 @@ public class SymbolicRef implements Ref {
                return dst;
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public Ref getTarget() {
                return target;
        }
 
-       /** {@inheritDoc} */
        @Override
        @Nullable
        public ObjectId getObjectId() {
                return getLeaf().getObjectId();
        }
 
-       /** {@inheritDoc} */
        @Override
        @NonNull
        public Storage getStorage() {
                return Storage.LOOSE;
        }
 
-       /** {@inheritDoc} */
        @Override
        @Nullable
        public ObjectId getPeeledObjectId() {
                return getLeaf().getPeeledObjectId();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isPeeled() {
                return getLeaf().isPeeled();
@@ -128,7 +120,6 @@ public class SymbolicRef implements Ref {
                return updateIndex;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index facb4a54beaa1fc9139a6339f8320bae582c92ee..bbc614448fbf5e32b0b537ce41c6c57c52e2073d 100644 (file)
@@ -223,7 +223,6 @@ public class TagBuilder extends ObjectBuilder {
                }
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 85aa0b663989c01f8ee8fa6266b2c1eb1e929e19..98ea2f97a3704c2ff5dc2b07daa0595a1d07c9d5 100644 (file)
@@ -45,7 +45,6 @@ public class TextProgressMonitor extends BatchingProgressMonitor {
                this.write = true;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onUpdate(String taskName, int workCurr, Duration duration) {
                StringBuilder s = new StringBuilder();
@@ -53,7 +52,6 @@ public class TextProgressMonitor extends BatchingProgressMonitor {
                send(s);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndTask(String taskName, int workCurr, Duration duration) {
                StringBuilder s = new StringBuilder();
@@ -73,7 +71,6 @@ public class TextProgressMonitor extends BatchingProgressMonitor {
                appendDuration(s, duration);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onUpdate(String taskName, int cmp, int totalWork, int pcnt,
                        Duration duration) {
@@ -82,7 +79,6 @@ public class TextProgressMonitor extends BatchingProgressMonitor {
                send(s);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndTask(String taskName, int cmp, int totalWork, int pcnt,
                        Duration duration) {
index e5539555600be46fda58897ecd7a20e15d7a0d0a..05eacdcd634823b9b75d1c7d02f1499a9498b025 100644 (file)
@@ -55,7 +55,6 @@ public class ThreadSafeProgressMonitor implements ProgressMonitor {
                this.process = new Semaphore(0);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void start(int totalTasks) {
                if (!isMainThread())
@@ -63,7 +62,6 @@ public class ThreadSafeProgressMonitor implements ProgressMonitor {
                pm.start(totalTasks);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void beginTask(String title, int totalWork) {
                if (!isMainThread())
@@ -132,14 +130,12 @@ public class ThreadSafeProgressMonitor implements ProgressMonitor {
                        pm.update(cnt);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void update(int completed) {
                if (0 == pendingUpdates.getAndAdd(completed))
                        process.release();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isCancelled() {
                lock.lock();
@@ -150,7 +146,6 @@ public class ThreadSafeProgressMonitor implements ProgressMonitor {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void endTask() {
                if (!isMainThread())
index e1f868483056d269d30451c84b83f8e253aa8ae0..c3c170a2c9f698262eca1a80e3072dcf9a9753fd 100644 (file)
@@ -332,7 +332,6 @@ public class TreeFormatter {
                }
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index c4eb8f10d5c65cf56736c7078992b496a3ef9804..0c03adcab8d48133ad58be8e413b428b01fdd2e3 100644 (file)
@@ -57,6 +57,8 @@ public interface TypedConfigGetter {
        /**
         * Parse an enumeration from a git {@link Config}.
         *
+        * @param <T>
+        *            type of the enum
         * @param config
         *            to get the value from
         * @param all
index e44970abff06327534ac5a6fca0684792bd6f08d..1ddac18e5649eaafe35eb7cecb967e89431f75bd 100644 (file)
@@ -79,14 +79,12 @@ class EolAwareOutputStream extends OutputStream {
                return bol;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int val) throws IOException {
                out.write(val);
                bol = (val == '\n');
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] buf, int pos, int cnt) throws IOException {
                if (cnt > 0) {
index 80607351ae1c24e8064778fa3840ae41b3b57322..abca813c1102b14ad0d6aa700983303b3ed8d958 100644 (file)
@@ -90,10 +90,16 @@ public final class MergeAlgorithm {
        /**
         * Does the three way merge between a common base and two sequences.
         *
-        * @param cmp comparison method for this execution.
-        * @param base the common base sequence
-        * @param ours the first sequence to be merged
-        * @param theirs the second sequence to be merged
+        * @param <S>
+        *            type of the sequences
+        * @param cmp
+        *            comparison method for this execution.
+        * @param base
+        *            the common base sequence
+        * @param ours
+        *            the first sequence to be merged
+        * @param theirs
+        *            the second sequence to be merged
         * @return the resulting content
         */
        public <S extends Sequence> MergeResult<S> merge(
index 18b0ad92c85c60f187c5c689a82204389b014948..baf5d277141ee19fb4e1c5e3455803088ce0b92d 100644 (file)
@@ -43,6 +43,7 @@ public class MergeFormatter {
         *            the name of the character set used when writing conflict
         *            metadata
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @deprecated Use
         *             {@link #formatMerge(OutputStream, MergeResult, List, Charset)}
         *             instead.
@@ -73,6 +74,7 @@ public class MergeFormatter {
         * @param charset
         *            the character set used when writing conflict metadata
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 5.2
         */
        public void formatMerge(OutputStream out, MergeResult<RawText> res,
@@ -102,6 +104,7 @@ public class MergeFormatter {
         *            the name of the character set used when writing conflict
         *            metadata
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @deprecated use
         *             {@link #formatMerge(OutputStream, MergeResult, String, String, String, Charset)}
         *             instead.
@@ -134,6 +137,7 @@ public class MergeFormatter {
         * @param charset
         *            the character set used when writing conflict metadata
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 5.2
         */
        @SuppressWarnings("unchecked")
index 20fc3c339cc15221e8ef858691397ae6a2bc3763..acf955303d87e02e8ba5fba8c508085d8564cdd0 100644 (file)
@@ -97,7 +97,6 @@ public class MergeResult<S extends Sequence> implements Iterable<MergeChunk> {
 
        static final ConflictState[] states = ConflictState.values();
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<MergeChunk> iterator() {
                return new Iterator<>() {
index df6068925b84e8590840c759fba990259c5e223c..1162a615f2a7a60eb1d4a8fd29e6e8ba5446a83e 100644 (file)
@@ -123,6 +123,7 @@ public class RecursiveMerger extends ResolveMerger {
         *         synthetic merge base this commit is visible only the merger's
         *         RevWalk and will not be in the repository.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws IncorrectObjectTypeException
         *             one of the input objects is not a commit.
         * @throws NoMergeBaseException
@@ -213,6 +214,7 @@ public class RecursiveMerger extends ResolveMerger {
         *            the list of parent commits
         * @return a new commit visible only within this merger's RevWalk.
         * @throws IOException
+        *             if an IO error occurred
         */
        private RevCommit createCommitForTree(ObjectId tree, List<RevCommit> parents)
                        throws IOException {
index e56513d4e936c856bf81c6130be1aa503dfc2efb..2b2ab023ba448af9a09ca7003f909c3d86c64da6 100644 (file)
@@ -466,7 +466,6 @@ public class ResolveMerger extends ThreeWayMerger {
                /**
                 * Detects if CRLF conversion has been configured.
                 * <p>
-                * </p>
                 * See {@link EolStreamTypeUtil#detectStreamType} for more info.
                 *
                 * @param attributes
@@ -904,7 +903,6 @@ public class ResolveMerger extends ThreeWayMerger {
                                : strategy;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean mergeImpl() throws IOException {
                return mergeTrees(mergeBase(), sourceTrees[0], sourceTrees[1],
@@ -915,18 +913,23 @@ public class ResolveMerger extends ThreeWayMerger {
         * adds a new path with the specified stage to the index builder
         *
         * @param path
+        *            the new path
         * @param p
+        *            canonical tree parser
         * @param stage
-        * @param lastMod
+        *            the stage
+        * @param lastModified
+        *            lastModified attribute of the file
         * @param len
+        *            file length
         * @return the entry which was added to the index
         */
        private DirCacheEntry add(byte[] path, CanonicalTreeParser p, int stage,
-                       Instant lastMod, long len) {
+                       Instant lastModified, long len) {
                if (p != null && !p.getEntryFileMode().equals(FileMode.TREE)) {
                        return workTreeUpdater.addExistingToIndex(p.getEntryObjectId(), path,
                                        p.getEntryFileMode(), stage,
-                                       lastMod, (int) len);
+                                       lastModified, (int) len);
                }
                return null;
        }
@@ -1056,6 +1059,7 @@ public class ResolveMerger extends ThreeWayMerger {
         *         didn't match ours or the working-dir file was dirty and a
         *         conflict occurred
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 6.1
         */
        protected boolean processEntry(CanonicalTreeParser base,
@@ -1432,15 +1436,21 @@ public class ResolveMerger extends ThreeWayMerger {
         * specified as <code>null</code> then an empty text will be used instead.
         *
         * @param base
+        *            used to parse base tree
         * @param ours
+        *            used to parse ours tree
         * @param theirs
+        *            used to parse theirs tree
         * @param attributes
+        *            attributes for the different stages
         * @param strategy
+        *            merge strategy
         *
         * @return the result of the content merge
         * @throws BinaryBlobException
         *             if any of the blobs looks like a binary blob
         * @throws IOException
+        *             if an IO error occurred
         */
        private MergeResult<RawText> contentMerge(CanonicalTreeParser base,
                        CanonicalTreeParser ours, CanonicalTreeParser theirs,
@@ -1516,11 +1526,17 @@ public class ResolveMerger extends ThreeWayMerger {
         * correct stages to the index.
         *
         * @param base
+        *            used to parse base tree
         * @param ours
+        *            used to parse ours tree
         * @param theirs
+        *            used to parse theirs tree
         * @param result
+        *            merge result
         * @param attributes
+        *            the file's attributes
         * @throws IOException
+        *             if an IO error occurred
         */
        private void updateIndex(CanonicalTreeParser base,
                        CanonicalTreeParser ours, CanonicalTreeParser theirs,
@@ -1571,6 +1587,7 @@ public class ResolveMerger extends ThreeWayMerger {
         *            the files .gitattributes entries
         * @return the working tree file to which the merged content was written.
         * @throws IOException
+        *             if an IO error occurred
         */
        private File writeMergedFile(TemporaryBuffer rawMerged,
                        Attributes attributes)
@@ -1659,7 +1676,6 @@ public class ResolveMerger extends ThreeWayMerger {
                return FileMode.GITLINK.equals(mode);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getResultTreeId() {
                return (resultTree == null) ? null : resultTree.toObjectId();
@@ -1819,6 +1835,7 @@ public class ResolveMerger extends ThreeWayMerger {
         *            content-merge conflicts.
         * @return whether the trees merged cleanly
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.5
         */
        protected boolean mergeTrees(AbstractTreeIterator baseTree,
@@ -1878,6 +1895,7 @@ public class ResolveMerger extends ThreeWayMerger {
         *            {@link org.eclipse.jgit.merge.ResolveMerger#mergeTrees(AbstractTreeIterator, RevTree, RevTree, boolean)}
         * @return Whether the trees merged cleanly.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.5
         */
        protected boolean mergeTreeWalk(TreeWalk treeWalk, boolean ignoreConflicts)
index 7055ccd127b5bb2403e4c2d9e49f3418c8ebdcaf..6064ebe326dd4cbf51063789a424054a48a2fc58 100644 (file)
@@ -43,25 +43,21 @@ public class StrategyOneSided extends MergeStrategy {
                treeIndex = index;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getName() {
                return strategyName;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Merger newMerger(Repository db) {
                return new OneSide(db, treeIndex);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Merger newMerger(Repository db, boolean inCore) {
                return new OneSide(db, treeIndex);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Merger newMerger(ObjectInserter inserter, Config config) {
                return new OneSide(inserter, treeIndex);
index c9512edf63d36c2e815b5080b07193dc5923a31e..a74bfc03792457b872fb421b7e1cd0053c9c058a 100644 (file)
@@ -21,25 +21,21 @@ import org.eclipse.jgit.lib.Repository;
  */
 public class StrategyRecursive extends StrategyResolve {
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(Repository db) {
                return new RecursiveMerger(db, false);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(Repository db, boolean inCore) {
                return new RecursiveMerger(db, inCore);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(ObjectInserter inserter, Config config) {
                return new RecursiveMerger(inserter, config);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getName() {
                return "recursive"; //$NON-NLS-1$
index 5991ef68a31fb1be0b097bbbf754ce1b4754ce3d..a686fd0964ab52f71e624b9289869b6fbbc730d5 100644 (file)
@@ -19,25 +19,21 @@ import org.eclipse.jgit.lib.Repository;
  */
 public class StrategyResolve extends ThreeWayMergeStrategy {
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(Repository db) {
                return new ResolveMerger(db, false);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(Repository db, boolean inCore) {
                return new ResolveMerger(db, inCore);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(ObjectInserter inserter, Config config) {
                return new ResolveMerger(inserter, config);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getName() {
                return "resolve"; //$NON-NLS-1$
index ff40fc1d687e3e8cd4481b9d69566ee6768f01e3..c3180abd3531abd50324cee67ab9ba29636234dd 100644 (file)
@@ -43,26 +43,22 @@ public class StrategySimpleTwoWayInCore extends ThreeWayMergeStrategy {
                //
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getName() {
                return "simple-two-way-in-core"; //$NON-NLS-1$
        }
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(Repository db) {
                return new InCoreMerger(db);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(Repository db, boolean inCore) {
                // This class is always inCore, so ignore the parameter
                return newMerger(db);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ThreeWayMerger newMerger(ObjectInserter inserter, Config config) {
                return new InCoreMerger(inserter);
index 411789fd955a4a3629ee79d9ce197a00275c3894..8cefa6566e9290606b4325c22f0a3bc3b39f78e1 100644 (file)
@@ -16,11 +16,9 @@ import org.eclipse.jgit.lib.Repository;
  * A merge strategy to merge 2 trees, using a common base ancestor tree.
  */
 public abstract class ThreeWayMergeStrategy extends MergeStrategy {
-       /** {@inheritDoc} */
        @Override
        public abstract ThreeWayMerger newMerger(Repository db);
 
-       /** {@inheritDoc} */
        @Override
        public abstract ThreeWayMerger newMerger(Repository db, boolean inCore);
 }
index f283edee01b85276c12355863b5d98af3fe41e27..68a1b5e50948c07463de3bbbd3c415ed35916333 100644 (file)
@@ -88,7 +88,6 @@ public abstract class ThreeWayMerger extends Merger {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean merge(AnyObjectId... tips) throws IOException {
                if (tips.length != 2)
@@ -96,7 +95,6 @@ public abstract class ThreeWayMerger extends Merger {
                return super.merge(tips);
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getBaseCommitId() {
                return baseCommitId;
@@ -108,6 +106,7 @@ public abstract class ThreeWayMerger extends Merger {
         * @return an iterator over the caller-specified merge base, or the natural
         *         merge base of the two input commits.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected AbstractTreeIterator mergeBase() throws IOException {
                if (baseTree != null) {
index 881873de6f947c62216b715e3c675e251bf0f927..16d17637e29bbc0700980a30a0b7a8db8f0039eb 100644 (file)
@@ -83,6 +83,8 @@ public class NLS {
         * injected as described in the
         * {@link org.eclipse.jgit.nls.TranslationBundle}.
         *
+        * @param <T>
+        *            type of the translation bundle
         * @param type
         *            required bundle type
         * @return an instance of the required bundle type
index bde0b9e445be45fb29780d3afa466a87ddc3cd61..b65f28c918d1a0a970455be9822f301f5af50cd5 100644 (file)
@@ -34,7 +34,6 @@ import org.eclipse.jgit.util.io.UnionInputStream;
  */
 public class DefaultNoteMerger implements NoteMerger {
 
-       /** {@inheritDoc} */
        @Override
        public Note merge(Note base, Note ours, Note theirs, ObjectReader reader,
                        ObjectInserter inserter) throws IOException {
index c35696323e742e83170a01ead2e5061b781d62e7..2f719bf45373983f0c7ba299576ba7ad2c52f7f3 100644 (file)
@@ -45,7 +45,6 @@ public class Note extends ObjectId {
                data = newData;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 93adf36a3a6b078e0c8cd6c178843990b34318f0..b872750212b3a7a5a3f89379d0516bc753a7f45a 100644 (file)
@@ -166,7 +166,6 @@ public class NoteMap implements Iterable<Note> {
                this.reader = reader;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<Note> iterator() {
                try {
index a6ea523a78f0ca8ffeb8c80e6c10f69e3f490b52..79ceb1316aa459a99892546f0b0ca2d7b124bb24 100644 (file)
@@ -94,6 +94,7 @@ public class NoteMapMerger {
         *            theirs version of the note tree
         * @return merge result as a new NoteMap
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public NoteMap merge(NoteMap base, NoteMap ours, NoteMap theirs)
                        throws IOException {
@@ -113,11 +114,16 @@ public class NoteMapMerger {
         * between base, ours and theirs.
         *
         * @param treeDepth
+        *            depth of the tree
         * @param base
+        *            base version
         * @param ours
+        *            ours version
         * @param theirs
+        *            theirs version
         * @return merge result as an InMemoryBucket
         * @throws IOException
+        *             if an IO error occurred
         */
        private InMemoryNoteBucket merge(int treeDepth, InMemoryNoteBucket base,
                        InMemoryNoteBucket ours, InMemoryNoteBucket theirs)
index 4ba7cca51ec8172664a9ee1314b33d8095f5310d..e29af614a6f2d1f0a86e1394caba8635c6a5df9d 100644 (file)
@@ -40,7 +40,6 @@ public class CombinedFileHeader extends FileHeader {
                super(b, offset);
        }
 
-       /** {@inheritDoc} */
        @Override
        @SuppressWarnings("unchecked")
        public List<? extends CombinedHunkHeader> getHunks() {
@@ -48,9 +47,6 @@ public class CombinedFileHeader extends FileHeader {
        }
 
        /**
-        * {@inheritDoc}
-        * <p>
-        *
         * @return number of ancestor revisions mentioned in this diff.
         */
        @Override
@@ -60,7 +56,7 @@ public class CombinedFileHeader extends FileHeader {
 
        /**
         * {@inheritDoc}
-        * <p>
+        *
         * @return get the file mode of the first parent.
         */
        @Override
@@ -81,7 +77,6 @@ public class CombinedFileHeader extends FileHeader {
 
        /**
         * {@inheritDoc}
-        * <p>
         *
         * @return get the object id of the first parent.
         */
@@ -101,7 +96,6 @@ public class CombinedFileHeader extends FileHeader {
                return oldIds[nthParent];
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getScriptText(Charset ocs, Charset ncs) {
                final Charset[] cs = new Charset[getParentCount() + 1];
@@ -110,11 +104,6 @@ public class CombinedFileHeader extends FileHeader {
                return getScriptText(cs);
        }
 
-       /**
-        * {@inheritDoc}
-        * <p>
-        * Convert the patch script for this file into a string.
-        */
        @Override
        public String getScriptText(Charset[] charsetGuess) {
                return super.getScriptText(charsetGuess);
@@ -156,7 +145,6 @@ public class CombinedFileHeader extends FileHeader {
                return ptr;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void parseIndexLine(int ptr, int eol) {
                // "index $asha1,$bsha1..$csha1"
@@ -178,7 +166,6 @@ public class CombinedFileHeader extends FileHeader {
                oldModes = new FileMode[oldIds.length];
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void parseNewFileMode(int ptr, int eol) {
                for (int i = 0; i < oldModes.length; i++)
index 263b1b9ddce3b6ca9d0de082fe142ae485101cac..49cf4998651e42f12dac538590e871b6327737d8 100644 (file)
@@ -45,13 +45,11 @@ public class CombinedHunkHeader extends HunkHeader {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public CombinedFileHeader getFileHeader() {
                return (CombinedFileHeader) super.getFileHeader();
        }
 
-       /** {@inheritDoc} */
        @Override
        public OldImage getOldImage() {
                return getOldImage(0);
index 1e6fb780b2b6fbea24efb4ebfdac233c97c7a2b6..a47b73dc34f163858fa8d6808668e5d39dda7eb2 100644 (file)
@@ -187,6 +187,13 @@ public class FileHeader extends DiffEntry {
                return getScriptText(new Charset[] { oldCharset, newCharset });
        }
 
+       /**
+        * Convert the patch script for this file into a string.
+        *
+        * @param charsetGuess
+        *            hint which charset is used
+        * @return the patch script, as a Unicode string.
+        */
        String getScriptText(Charset[] charsetGuess) {
                if (getHunks().isEmpty()) {
                        // If we have no hunks then we can safely assume the entire
index 5618a717822f40c197123c6af32d01c4ac06c943..8d21b6dabb97c619bdf812dc9900ceb0908e6d76 100644 (file)
@@ -91,7 +91,6 @@ public class FormatError {
                return RawParseUtils.decode(UTF_8, buf, offset, eol);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder r = new StringBuilder();
index 4b59fcfc63dce0d43107ac485a67a893278cf1d1..1359f6606277edb4d6105e56d8b8dd12ac94e674 100644 (file)
@@ -409,7 +409,6 @@ public class HunkHeader {
                offsets[fileIdx] = end < 0 ? s.length() : end + 1;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index da698d6bf675eb16e91f1f704cbd26aec7d37a48..e9c119279690f898fcc9a6e11e2da3c4a99e8393 100644 (file)
@@ -251,6 +251,7 @@ public class PatchApplier {
         *            the patch to apply.
         * @return the result of the patch
         * @throws IOException
+        *             if an IO error occurred
         * @since 6.6
         */
        public Result applyPatch(Patch p) throws IOException {
@@ -423,6 +424,7 @@ public class PatchApplier {
         * @param result
         *            The patch application result.
         * @throws IOException
+        *             if an IO error occurred
         */
        private void apply(String pathWithOriginalContent, DirCache dirCache,
                        DirCacheBuilder dirCacheBuilder, @Nullable File f, FileHeader fh, Result result)
@@ -777,7 +779,9 @@ public class PatchApplier {
         *            The patch application result
         * @return a loader for the new content, or null if invalid.
         * @throws IOException
+        *             if an IO error occurred
         * @throws UnsupportedOperationException
+        *             if an operation isn't supported
         */
        private @Nullable ContentStreamLoader applyBinary(String path, File f, FileHeader fh,
                        StreamSupplier inputSupplier, ObjectId id, Result result)
index c11fca13d8d17381e9f2c4658ca8fb749965a29a..fa109e820862c7c8e0b269110fd5ef3af5d7a963 100644 (file)
@@ -179,7 +179,6 @@ public class PlotCommit<L extends PlotLane> extends RevCommit {
                return (L) lane;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void reset() {
                forkingOffLanes = NO_LANES;
index 458f2409826ead4871bfbc9e363d77ac16c1505b..3177de17e89dc2363f2b41492e79cd825faa24dd 100644 (file)
@@ -49,7 +49,6 @@ public class PlotCommitList<L extends PlotLane> extends
        private final HashMap<PlotLane, Integer> laneLength = new HashMap<>(
                        32);
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                super.clear();
@@ -59,7 +58,6 @@ public class PlotCommitList<L extends PlotLane> extends
                laneLength.clear();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void source(RevWalk w) {
                if (!(w instanceof PlotWalk))
@@ -91,7 +89,6 @@ public class PlotCommitList<L extends PlotLane> extends
                        result.add((L) p);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("ReferenceEquality")
        @Override
        protected void enter(int index, PlotCommit<L> currCommit) {
@@ -184,6 +181,7 @@ public class PlotCommitList<L extends PlotLane> extends
         * @param index
         *            the index of <code>currCommit</code> in the list
         * @param currCommit
+        *            the current commit
         * @param childOnLane
         *            the direct child on the same lane as <code>currCommit</code>,
         *            may be null if <code>currCommit</code> is the first commit on
@@ -287,8 +285,11 @@ public class PlotCommitList<L extends PlotLane> extends
         * All blockades on the lane must be resolved before calling this method.
         *
         * @param commitIndex
+        *            commit index
         * @param child
+        *            child to connect
         * @param laneToContinue
+        *            lane to continue
         */
        @SuppressWarnings("ReferenceEquality")
        private void drawLaneToChild(final int commitIndex, PlotCommit child,
index 058233865251c1dc550f84904adb0134e4f9475b..0f6bd2d6cc2128d9908b70782900fd6ca6707684 100644 (file)
@@ -49,7 +49,6 @@ public class PlotWalk extends RevWalk {
 
        private Repository repository;
 
-       /** {@inheritDoc} */
        @Override
        public void dispose() {
                super.dispose();
@@ -83,6 +82,7 @@ public class PlotWalk extends RevWalk {
         * @param refs
         *            additional refs
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void addAdditionalRefs(Iterable<Ref> refs) throws IOException {
                for (Ref ref : refs) {
@@ -97,7 +97,6 @@ public class PlotWalk extends RevWalk {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void sort(RevSort s, boolean use) {
                if (s == RevSort.TOPO && !use)
@@ -105,13 +104,11 @@ public class PlotWalk extends RevWalk {
                super.sort(s, use);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected RevCommit createCommit(AnyObjectId id) {
                return new PlotCommit(id);
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevCommit next() throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
index dda108bc6957ad828d08acccd760cb0ae1d5bcac..73ae62a23fa5a16bd5334f88e0c3ffb2b5a62c60 100644 (file)
@@ -79,8 +79,6 @@ abstract class AbstractRevQueue extends Generator {
        }
 
        /**
-        * {@inheritDoc}
-        * <p>
         * Remove the first commit from the queue.
         */
        @Override
index cdd8073d6e31d14465a04489ce6e60ae6c4a9b45..e855d8f700a75bce88ad4da4a23d528452105327 100644 (file)
@@ -45,8 +45,6 @@ abstract class BlockRevQueue extends AbstractRevQueue {
        }
 
        /**
-        * {@inheritDoc}
-        * <p>
         * Reconfigure this queue to share the same free list as another.
         * <p>
         * Multiple revision queues can be connected to the same free list, making
@@ -56,6 +54,11 @@ abstract class BlockRevQueue extends AbstractRevQueue {
         * <p>
         * Free lists are not thread-safe. Applications must ensure that all queues
         * sharing the same free list are doing so from only a single thread.
+        *
+        * @param q
+        *            another FIFO queue that wants to share our queue's free list.
+        *
+        * @see Generator#shareFreeList
         */
        @Override
        public void shareFreeList(BlockRevQueue q) {
index 0cabf07057a2c5f018c823f01717a2b39beffa9c..4ec9afc718feff4032b191ed6226858d37f4257f 100644 (file)
@@ -56,7 +56,6 @@ public class DateRevQueue extends AbstractRevQueue {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void add(RevCommit c) {
                sinceLastIndex++;
@@ -102,7 +101,6 @@ public class DateRevQueue extends AbstractRevQueue {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevCommit next() {
                final Entry q = head;
@@ -139,7 +137,6 @@ public class DateRevQueue extends AbstractRevQueue {
                return head != null ? head.commit : null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                head = null;
@@ -173,7 +170,6 @@ public class DateRevQueue extends AbstractRevQueue {
                return outputType | SORT_COMMIT_TIME_DESC;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder s = new StringBuilder();
index ec0824cb0bc9d51bdef8c7611bd30ed198329961..664f8fa3a7e307838c64325659ed46517ffaf9d3 100644 (file)
@@ -55,10 +55,15 @@ class DepthGenerator extends Generator {
 
        /**
         * @param w
-        * @param s Parent generator
+        *            walk used for depth filtering
+        * @param s
+        *            Parent generator
         * @throws MissingObjectException
+        *             if an object is missing
         * @throws IncorrectObjectTypeException
+        *             if an object has an unexpected type
         * @throws IOException
+        *             if an IO error occurred
         */
        DepthGenerator(DepthWalk w, Generator s) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
index 5277563ac46667e3e4c385f5ff7ed7844db6da6a..f74666bd86da05198ae863e71ce4a27a8b3e2efd 100644 (file)
@@ -159,8 +159,11 @@ public interface DepthWalk {
                 * @param c
                 *            Commit to mark
                 * @throws IOException
+                *             if an IO error occurred
                 * @throws IncorrectObjectTypeException
+                *             if object has an unexpected type
                 * @throws MissingObjectException
+                *             if object is missing
                 */
                public void markRoot(RevCommit c) throws MissingObjectException,
                                IncorrectObjectTypeException, IOException {
@@ -289,8 +292,11 @@ public interface DepthWalk {
                 * @param o
                 *            Commit to mark
                 * @throws IOException
+                *             if an IO error occurred
                 * @throws IncorrectObjectTypeException
+                *             if object has an unexpected type
                 * @throws MissingObjectException
+                *             if object is missing
                 */
                public void markRoot(RevObject o) throws MissingObjectException,
                                IncorrectObjectTypeException, IOException {
@@ -313,8 +319,11 @@ public interface DepthWalk {
                 * @param c
                 *            Commit to mark
                 * @throws MissingObjectException
+                *             if object is missing
                 * @throws IncorrectObjectTypeException
+                *             if object has an unexpected type
                 * @throws IOException
+                *             if an IO error occurred
                 */
                public void markUnshallow(RevObject c) throws MissingObjectException,
                                IncorrectObjectTypeException, IOException {
index 0f8eddd6d4bace00897ad29798129ed2e208efc8..996745c158ebd1527098f5ddb7f6824aadc369c4 100644 (file)
@@ -37,7 +37,6 @@ public class FIFORevQueue extends BlockRevQueue {
                super(s);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void add(RevCommit c) {
                Block b = tail;
@@ -82,7 +81,6 @@ public class FIFORevQueue extends BlockRevQueue {
                head = b;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevCommit next() {
                final Block b = head;
@@ -99,7 +97,6 @@ public class FIFORevQueue extends BlockRevQueue {
                return c;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                head = null;
@@ -135,7 +132,6 @@ public class FIFORevQueue extends BlockRevQueue {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder s = new StringBuilder();
index 3b54123f0bf9c76ff07232cfcb885db866eb4c59..14a34375cd819218117ce005cc4dced73a2f1c5e 100644 (file)
@@ -77,7 +77,6 @@ public class FollowFilter extends TreeFilter {
                return path.getPath();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk walker)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -85,19 +84,16 @@ public class FollowFilter extends TreeFilter {
                return path.include(walker) && ANY_DIFF.include(walker);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                return path.shouldBeRecursive() || ANY_DIFF.shouldBeRecursive();
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter clone() {
                return new FollowFilter(path.clone(), cfg);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 74e4c1edb7dd80f9b3a142a937248ffcb53468fa..af5079401400c4120834a1d896ba48d1a623d4ab 100644 (file)
@@ -51,7 +51,6 @@ public final class FooterKey {
                return name;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 3d128a6bd302303b11847f8b2b5eef21dde47e05..676573c2f2d03e803105c209aff47ee7ecf87c8a 100644 (file)
@@ -117,7 +117,6 @@ public final class FooterLine {
                return RawParseUtils.decode(enc, buffer, lt, gt - 1);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return getKey() + ": " + getValue(); //$NON-NLS-1$
index 3493dcfb47c5984abfd8df7d5a9e0d0c5ddb2023..d97812ff45bc11d68238d68862f6d3289473eb1a 100644 (file)
@@ -71,8 +71,11 @@ abstract class Generator {
         *
         * @return next available commit; null if no more are to be returned.
         * @throws MissingObjectException
+        *             if an object is missing
         * @throws IncorrectObjectTypeException
+        *             if an object has an unexpected type
         * @throws IOException
+        *             if an IO error occurred
         */
        abstract RevCommit next() throws MissingObjectException,
                        IncorrectObjectTypeException, IOException;
index 4773ca84271ba4ef3a275a7b5eee9bafb1b6c69a..ae67ca75990d2bfa54c131591eaf9c528aa03168 100644 (file)
@@ -34,7 +34,6 @@ public class LIFORevQueue extends BlockRevQueue {
                super(s);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void add(RevCommit c) {
                Block b = head;
@@ -47,7 +46,6 @@ public class LIFORevQueue extends BlockRevQueue {
                b.unpop(c);
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevCommit next() {
                final Block b = head;
@@ -62,7 +60,6 @@ public class LIFORevQueue extends BlockRevQueue {
                return c;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                head = null;
@@ -89,7 +86,6 @@ public class LIFORevQueue extends BlockRevQueue {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder s = new StringBuilder();
index 4e48a5c3286665de05708cc9b6ac5d4f316ad7a4..64b2fcd66a27192dc3e3521cc3052a1832471889 100644 (file)
@@ -300,14 +300,12 @@ public class ObjectWalk extends RevWalk {
                        addObject(o);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void sort(RevSort s) {
                super.sort(s);
                boundary = hasRevSort(RevSort.BOUNDARY);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void sort(RevSort s, boolean use) {
                super.sort(s, use);
@@ -357,7 +355,6 @@ public class ObjectWalk extends RevWalk {
                visitationPolicy = requireNonNull(policy);
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevCommit next() throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
@@ -762,7 +759,6 @@ public class ObjectWalk extends RevWalk {
                pathBuf = newBuf;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void dispose() {
                super.dispose();
@@ -771,7 +767,6 @@ public class ObjectWalk extends RevWalk {
                freeVisit = null;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void reset(int retainFlags) {
                super.reset(retainFlags);
index f5abbb870aa47db5df3dafb2f72ca9193779b60d..1f81b6a92294deec55a4c3ec0dda769f002dc0fd 100644 (file)
@@ -33,7 +33,6 @@ public class RevBlob extends RevObject {
                super(id);
        }
 
-       /** {@inheritDoc} */
        @Override
        public final int getType() {
                return Constants.OBJ_BLOB;
index b64c9ce9060870e6123ff3e0c096f721c1e034c7..e32f28ebbc8aa33a6e4268b2317e27fe5ccef6ea 100644 (file)
@@ -222,7 +222,6 @@ public class RevCommit extends RevObject {
                flags |= PARSED;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final int getType() {
                return Constants.OBJ_COMMIT;
@@ -713,7 +712,6 @@ public class RevCommit extends RevObject {
                buffer = null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder s = new StringBuilder();
index 4d3664da11e57ff39b7823bd9fd46e515fd4cfc3..3846ca579a8c0c1041bc496cb723fd8004b52ae1 100644 (file)
@@ -44,7 +44,6 @@ class RevCommitCG extends RevCommit {
                this.graphPosition = graphPosition;
        }
 
-       /** {@inheritDoc} */
        @Override
        void parseCanonical(RevWalk walk, byte[] raw) throws IOException {
                if (walk.isRetainBody()) {
@@ -53,7 +52,6 @@ class RevCommitCG extends RevCommit {
                parseInGraph(walk);
        }
 
-       /** {@inheritDoc} */
        @Override
        void parseHeaders(RevWalk walk) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
@@ -98,7 +96,6 @@ class RevCommitCG extends RevCommit {
                flags |= PARSED;
        }
 
-       /** {@inheritDoc} */
        @Override
        int getGeneration() {
                return generation;
index 59213a8e60161698da4bb4db8d8a241ae69cb51e..58f5d425cc162632541692283cd1d05d5c058ae8 100644 (file)
@@ -25,7 +25,6 @@ import org.eclipse.jgit.revwalk.filter.RevFilter;
 public class RevCommitList<E extends RevCommit> extends RevObjectList<E> {
        private RevWalk walker;
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                super.clear();
@@ -313,7 +312,6 @@ public class RevCommitList<E extends RevCommit> extends RevObjectList<E> {
         * walker specified by {@link #source(RevWalk)} is pumped until the
         * specified commit is loaded. Callers can test the final size of the list
         * by {@link #size()} to determine if the high water mark specified was met.
-        * <p>
         *
         * @param commitToLoad
         *            commit the caller wants this list to contain when the fill
index a0160ddbef4c89a9e738c52e4a19dd52b636cca8..3221bf6e8fda15ad8f047f45e757301585acf6e0 100644 (file)
@@ -67,7 +67,6 @@ public class RevFlag {
                return walker;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return name;
index 4d2684a0f0a74ae65b76f306115ce68538bb4047..55ea30d24b3e08baeec24771f55a420d601f1366 100644 (file)
@@ -132,7 +132,6 @@ public abstract class RevObject extends ObjectIdOwnerMap.Entry {
                flags &= ~set.mask;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder s = new StringBuilder();
index 0393f55957de59f5545d6baab55556743baac099..ad8aeedeb91ae52258d3e5b1537aa973d71ecdeb 100644 (file)
@@ -47,7 +47,6 @@ public class RevObjectList<E extends RevObject> extends AbstractList<E> {
                // Initialized above.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void add(int index, E element) {
                if (index != size)
@@ -58,7 +57,6 @@ public class RevObjectList<E extends RevObject> extends AbstractList<E> {
                size++;
        }
 
-       /** {@inheritDoc} */
        @Override
        @SuppressWarnings("unchecked")
        public E set(int index, E element) {
@@ -80,7 +78,6 @@ public class RevObjectList<E extends RevObject> extends AbstractList<E> {
                return (E) old;
        }
 
-       /** {@inheritDoc} */
        @Override
        @SuppressWarnings("unchecked")
        public E get(int index) {
@@ -95,13 +92,11 @@ public class RevObjectList<E extends RevObject> extends AbstractList<E> {
                return s != null ? (E) s.contents[index] : null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int size() {
                return size;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                contents = new Block(0);
index b9d145008b35e3208b0e596b64336eee639d8fbf..75dbd577402720e6b70ae67b326087f19d2d4acf 100644 (file)
@@ -149,7 +149,6 @@ public class RevTag extends RevObject {
                flags |= PARSED;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final int getType() {
                return Constants.OBJ_TAG;
index 8119af468a68442c62484cbf9d972aab03392086..d81af0c0294d1cbe40f07aeb1b9bd75033b3b85a 100644 (file)
@@ -33,7 +33,6 @@ public class RevTree extends RevObject {
                super(id);
        }
 
-       /** {@inheritDoc} */
        @Override
        public final int getType() {
                return Constants.OBJ_TREE;
index 3737c6b67b2affaed24c282040ebf6d2cd0105d3..27a09f49561c3de0e81cce9a09524fcfe1dcfcd8 100644 (file)
@@ -220,7 +220,6 @@ public class RevWalk implements Iterable<RevCommit>, AutoCloseable {
 
        /**
         * Create a new revision walker for a given repository.
-        * <p>
         *
         * @param or
         *            the reader the walker will obtain data from. The reader is not
@@ -454,7 +453,6 @@ public class RevWalk implements Iterable<RevCommit>, AutoCloseable {
         * <p>
         * A commit is merged into a ref if we can find a path of commits that leads
         * from that specific ref and ends at <code>commit</code>.
-        * <p>
         *
         * @param commit
         *            commit the caller thinks is reachable from <code>refs</code>.
@@ -476,7 +474,6 @@ public class RevWalk implements Iterable<RevCommit>, AutoCloseable {
         * <p>
         * A commit is merged into a ref if we can find a path of commits that leads
         * from that specific ref and ends at <code>commit</code>.
-        * <p>
         *
         * @param commit
         *            commit the caller thinks is reachable from <code>refs</code>.
@@ -1197,6 +1194,8 @@ public class RevWalk implements Iterable<RevCommit>, AutoCloseable {
        /**
         * Asynchronous object parsing.
         *
+        * @param <T>
+        *            Type of returned {@code ObjectId}
         * @param objectIds
         *            objects to open from the object store. The supplied collection
         *            must not be modified until the queue has finished.
index e52e916318ebae2300610152d40cd90be12a4c7c..4bfe2fda02164a8c83326460dbb4eebc6c2adb4f 100644 (file)
@@ -51,8 +51,11 @@ public final class RevWalkUtils {
         *            should be done until there are no more commits
         * @return the number of commits
         * @throws org.eclipse.jgit.errors.MissingObjectException
+        *             if object is missing
         * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
+        *             if object has unexpected type
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static int count(final RevWalk walk, final RevCommit start,
                        final RevCommit end) throws MissingObjectException,
@@ -80,8 +83,11 @@ public final class RevWalkUtils {
         *            should be done until there are no more commits
         * @return the commits found
         * @throws org.eclipse.jgit.errors.MissingObjectException
+        *             if object is missing
         * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
+        *             if object has unexpected type
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static List<RevCommit> find(final RevWalk walk,
                        final RevCommit start, final RevCommit end)
@@ -116,8 +122,11 @@ public final class RevWalkUtils {
         *            the set of branches we want to see reachability from
         * @return the list of branches a given commit is reachable from
         * @throws org.eclipse.jgit.errors.MissingObjectException
+        *             if object is missing
         * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
+        *             if object has unexpected type
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static List<Ref> findBranchesReachableFrom(RevCommit commit,
                        RevWalk revWalk, Collection<Ref> refs)
@@ -147,8 +156,11 @@ public final class RevWalkUtils {
         *            the callback for progress and cancellation
         * @return the list of branches a given commit is reachable from
         * @throws org.eclipse.jgit.errors.MissingObjectException
+        *             if object is missing
         * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
+        *             if object has unexpected type
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 5.4
         */
        public static List<Ref> findBranchesReachableFrom(RevCommit commit,
index 2c88bb872e9c3c4f201641fb52664fe7738a4f75..4a93f4d745c46c6920c296acae02c082b0007ed5 100644 (file)
@@ -101,9 +101,13 @@ class RewriteGenerator extends Generator {
         * of this commit by the previous {@link PendingGenerator}.
         *
         * @param c
+        *            given commit
         * @throws MissingObjectException
+        *             if an object is missing
         * @throws IncorrectObjectTypeException
+        *             if an object has an unexpected type
         * @throws IOException
+        *             if an IO error occurred
         */
        private void applyFilterToParents(RevCommit c)
                        throws MissingObjectException, IncorrectObjectTypeException,
index 452545a04e72755352ec0fa59d4ebd7f438d7574..c9d8ff90fd18f83800d21b9810785d18f602e326 100644 (file)
@@ -33,8 +33,11 @@ class TopoNonIntermixSortGenerator extends Generator {
         * @param s
         *            generator to pull all commits out of, and into this buffer.
         * @throws MissingObjectException
+        *             if an object is missing
         * @throws IncorrectObjectTypeException
+        *             if an object has an unexpected type
         * @throws IOException
+        *             if an IO error occurred
         */
        TopoNonIntermixSortGenerator(Generator s) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
index 4739f78fc0f426617e050e4fb51d64ff74990a41..950b0a45b4d7324323525fe2deb45ec7992a9280 100644 (file)
@@ -33,8 +33,11 @@ class TopoSortGenerator extends Generator {
         * @param s
         *            generator to pull all commits out of, and into this buffer.
         * @throws MissingObjectException
+        *             if an object is missing
         * @throws IncorrectObjectTypeException
+        *             if an object has an unexpected type
         * @throws IOException
+        *             if an IO error occurred
         */
        TopoSortGenerator(Generator s) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
index f921449ffa03e024522a068182abbe075ff9f079..98bb5884fa4413d456e12db8635831450697ee2b 100644 (file)
@@ -92,13 +92,11 @@ public class TreeRevFilter extends RevFilter {
                this.rewriteFlag = rewriteFlag;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevFilter clone() {
                throw new UnsupportedOperationException();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(RevWalk walker, RevCommit c)
                        throws StopWalkException, MissingObjectException,
@@ -241,7 +239,6 @@ public class TreeRevFilter extends RevFilter {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean requiresCommitBody() {
                return false;
index 6ac490a34520b978f777fd23891a719560e520e4..4100e877dfa999073750377be924b1d8b22b270f 100644 (file)
@@ -98,13 +98,11 @@ public abstract class CommitTimeRevFilter extends RevFilter {
                when = (int) (ts / 1000);
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevFilter clone() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean requiresCommitBody() {
                return false;
index 0e3a803b64dbecc5bde84377926ffc52563bd448..09bcb33f2e79e961224fe54f8764696cc2238767 100644 (file)
@@ -46,7 +46,6 @@ public class MaxCountRevFilter extends RevFilter {
                this.maxCount = maxCount;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(RevWalk walker, RevCommit cmit)
                        throws StopWalkException, MissingObjectException,
@@ -57,7 +56,6 @@ public class MaxCountRevFilter extends RevFilter {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevFilter clone() {
                return new MaxCountRevFilter(maxCount);
index 1482c5129103351ab1c455c5fae929ff8cb22a60..8fcebc9fa190070ad5c148cf9f39abf15ef38860 100644 (file)
@@ -38,13 +38,11 @@ public class NotRevFilter extends RevFilter {
                a = one;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevFilter negate() {
                return a;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(RevWalk walker, RevCommit c)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -52,19 +50,16 @@ public class NotRevFilter extends RevFilter {
                return !a.include(walker, c);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean requiresCommitBody() {
                return a.requiresCommitBody();
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevFilter clone() {
                return new NotRevFilter(a.clone());
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "NOT " + a.toString(); //$NON-NLS-1$
index 256e4794cd7b09ddc1ef798d9a0018be18828181..84306463050ccd4c2c9b8391be72c1cd1fa05d58 100644 (file)
@@ -264,7 +264,6 @@ public abstract class RevFilter {
        @Override
        public abstract RevFilter clone();
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                String n = getClass().getName();
index 16d9f761431144b9f4def1558de20eb3b1a4b250..f9ee632b50c9a17e3591c3c0c2465ce3e1efa145 100644 (file)
@@ -91,13 +91,11 @@ public abstract class RevFlagFilter extends RevFilter {
                flags = m;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevFilter clone() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return super.toString() + flags;
index 84df36a2d27033db5f8df901e04889702068c504..bf93b7ba3eda090530fb86cecbb4557b0c79d892 100644 (file)
@@ -45,7 +45,6 @@ public class SkipRevFilter extends RevFilter {
                this.skip = skip;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(RevWalk walker, RevCommit cmit)
                        throws StopWalkException, MissingObjectException,
@@ -55,7 +54,6 @@ public class SkipRevFilter extends RevFilter {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public RevFilter clone() {
                return new SkipRevFilter(skip);
index 7f00dfd5049a68020db94a607215c48b0be42f10..ff1fea24186b3911ab033315f68700193ffd1657 100644 (file)
@@ -67,7 +67,6 @@ public abstract class SubStringRevFilter extends RevFilter {
                pattern = new RawSubStringPattern(patternText);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(RevWalk walker, RevCommit cmit)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -75,7 +74,6 @@ public abstract class SubStringRevFilter extends RevFilter {
                return pattern.match(text(cmit)) >= 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean requiresCommitBody() {
                return true;
@@ -90,13 +88,11 @@ public abstract class SubStringRevFilter extends RevFilter {
         */
        protected abstract RawCharSequence text(RevCommit cmit);
 
-       /** {@inheritDoc} */
        @Override
        public RevFilter clone() {
                return this; // Typically we are actually thread-safe.
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index cba5e1697cdd6c2ac0a6aa0c252061499f9440bc..910c5cbd85c195f17c4b34d43ef7507cd3ed2660 100644 (file)
@@ -84,7 +84,6 @@ public class FileBasedConfig extends StoredConfig {
                this.hash = ObjectId.zeroId();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean notifyUponTransientChanges() {
                // we will notify listeners upon save()
@@ -197,7 +196,6 @@ public class FileBasedConfig extends StoredConfig {
                fireConfigChangedEvent();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                hash = hash(new byte[0]);
@@ -208,7 +206,6 @@ public class FileBasedConfig extends StoredConfig {
                return ObjectId.fromRaw(Constants.newMessageDigest().digest(rawText));
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index b0b1d4ff2d61e664d7077ac6b900314da8056508..95c001e8a321bf106434eabf29f5a8b5989836ce 100644 (file)
@@ -256,8 +256,9 @@ public class PackConfig {
        public static final int DEFAULT_MIN_BYTES_FOR_OBJ_SIZE_INDEX = -1;
 
        /**
-        * Default max time to spend during the search for reuse phase. This
-        * optimization is disabled by default: {@value}
+        * Default max time to spend during the search for reuse phase.
+        *
+        * This optimization is disabled by default: {@link Integer#MAX_VALUE} seconds.
         *
         * @see #setSearchForReuseTimeout(Duration)
         * @since 5.13
@@ -1185,7 +1186,7 @@ public class PackConfig {
        /**
         * Get the max time to spend during the search for reuse phase.
         *
-        * Default setting: {@value #DEFAULT_SEARCH_FOR_REUSE_TIMEOUT}
+        * Default setting: {@link #DEFAULT_SEARCH_FOR_REUSE_TIMEOUT}
         *
         * @return the maximum time to spend during the search for reuse phase.
         * @since 5.13
@@ -1197,7 +1198,7 @@ public class PackConfig {
        /**
         * Set the age in days that marks a branch as "inactive".
         *
-        * Default setting: {@value #DEFAULT_BITMAP_INACTIVE_BRANCH_AGE_IN_DAYS}
+        * Default setting: {@link #DEFAULT_BITMAP_INACTIVE_BRANCH_AGE_IN_DAYS}
         *
         * @param ageInDays
         *            the age in days that marks a branch as "inactive"
@@ -1234,7 +1235,7 @@ public class PackConfig {
         * @param timeout
         *            max time allowed during the search for reuse phase
         *
-        *            Default setting: {@value #DEFAULT_SEARCH_FOR_REUSE_TIMEOUT}
+        *            Default setting: {@link #DEFAULT_SEARCH_FOR_REUSE_TIMEOUT}
         * @since 5.13
         */
        public void setSearchForReuseTimeout(Duration timeout) {
@@ -1369,7 +1370,6 @@ public class PackConfig {
                                CONFIG_KEY_PRUNE_PRESERVED, DEFAULT_PRUNE_PRESERVED));
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder b = new StringBuilder();
index 856eb725dd2e7169de63bca9eb58922e3616356f..f09e1a5171e952516566b64cec5ef23fa507c489 100644 (file)
@@ -55,9 +55,11 @@ public class SubmoduleConflict extends Sequence {
     private final ObjectId objectId;
 
     /**
-     * Create a SubmoduleConflict for the given submodule object id
-     * @param objectId
-     */
+        * Create a SubmoduleConflict for the given submodule object id
+        *
+        * @param objectId
+        *            the id of the object to create a submodule conflict for
+        */
     public SubmoduleConflict(ObjectId objectId) {
         super();
         this.objectId = objectId;
index bf77021b0cd7d835891d719cbc471fc31ad96784..7d5836ece2c67de68706bd39a3a8a23690c7e828 100644 (file)
@@ -87,6 +87,7 @@ public class SubmoduleWalk implements AutoCloseable {
         * @return generator over submodule index entries. The caller is responsible
         *         for calling {@link #close()}.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static SubmoduleWalk forIndex(Repository repository)
                        throws IOException {
@@ -116,6 +117,7 @@ public class SubmoduleWalk implements AutoCloseable {
         * @return generator at given path. The caller is responsible for calling
         *         {@link #close()}. Null if no submodule at given path.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static SubmoduleWalk forPath(Repository repository,
                        AnyObjectId treeId, String path) throws IOException {
@@ -150,6 +152,7 @@ public class SubmoduleWalk implements AutoCloseable {
         * @return generator at given path. The caller is responsible for calling
         *         {@link #close()}. Null if no submodule at given path.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static SubmoduleWalk forPath(Repository repository,
                        AbstractTreeIterator iterator, String path) throws IOException {
@@ -193,6 +196,7 @@ public class SubmoduleWalk implements AutoCloseable {
         *            submodule path
         * @return repository or null if repository doesn't exist
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static Repository getSubmoduleRepository(final Repository parent,
                        final String path) throws IOException {
@@ -209,6 +213,7 @@ public class SubmoduleWalk implements AutoCloseable {
         *            submodule path
         * @return repository or null if repository doesn't exist
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static Repository getSubmoduleRepository(final File parent,
                        final String path) throws IOException {
@@ -220,11 +225,14 @@ public class SubmoduleWalk implements AutoCloseable {
         * abstraction
         *
         * @param parent
+        *            {@link Repository} that contains the submodule
         * @param path
+        *            of the working tree of the submodule
         * @param fs
         *            the file system abstraction to be used
         * @return repository or null if repository doesn't exist
         * @throws IOException
+        *             if an IO error occurred
         * @since 4.10
         */
        public static Repository getSubmoduleRepository(final File parent,
@@ -249,7 +257,7 @@ public class SubmoduleWalk implements AutoCloseable {
         * @return the {@link Repository} of the submodule, or {@code null} if it
         *         doesn't exist
         * @throws IOException
-        *             on errors
+        *             if an IO error occurred
         * @since 5.6
         */
        public static Repository getSubmoduleRepository(File parent, String path,
@@ -286,6 +294,7 @@ public class SubmoduleWalk implements AutoCloseable {
         *            absolute or relative URL of the submodule repository
         * @return resolved URL
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public static String getSubmoduleRemoteUrl(final Repository parent,
                        final String url) throws IOException {
@@ -369,6 +378,7 @@ public class SubmoduleWalk implements AutoCloseable {
         * @param repository
         *            the {@link org.eclipse.jgit.lib.Repository}.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public SubmoduleWalk(Repository repository) throws IOException {
                this.repository = repository;
@@ -419,13 +429,14 @@ public class SubmoduleWalk implements AutoCloseable {
         * The root tree is not read until the first submodule is encountered by the
         * walk.
         * <p>
-        * This method need only be called if constructing a walk manually instead of
-        * with one of the static factory methods above.
+        * This method need only be called if constructing a walk manually instead
+        * of with one of the static factory methods above.
         *
         * @param id
         *            ID of a tree containing .gitmodules
         * @return this generator
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public SubmoduleWalk setRootTree(AnyObjectId id) throws IOException {
                final CanonicalTreeParser p = new CanonicalTreeParser();
@@ -448,6 +459,7 @@ public class SubmoduleWalk implements AutoCloseable {
         * @throws java.io.IOException
         *             if an error occurred, or if the repository is bare
         * @throws org.eclipse.jgit.errors.ConfigInvalidException
+        *             if .gitmodules config is invalid
         */
        public SubmoduleWalk loadModulesConfig() throws IOException, ConfigInvalidException {
                if (rootTree == null) {
@@ -512,11 +524,13 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @param repository
         *            the repository to check
-        * @return <code>true</code> if the working tree contains a .gitmodules file,
-        *         <code>false</code> otherwise. Always returns <code>false</code>
-        *         for bare repositories.
+        * @return <code>true</code> if the working tree contains a .gitmodules
+        *         file, <code>false</code> otherwise. Always returns
+        *         <code>false</code> for bare repositories.
         * @throws java.io.IOException
-        * @throws CorruptObjectException if any.
+        *             if an IO error occurred
+        * @throws CorruptObjectException
+        *             if a corrupt object was found
         * @since 3.6
         */
        public static boolean containsGitModulesFile(Repository repository)
@@ -560,6 +574,7 @@ public class SubmoduleWalk implements AutoCloseable {
         *            object.
         * @return this generator
         * @throws org.eclipse.jgit.errors.CorruptObjectException
+        *             if a corrupt object was found
         */
        public SubmoduleWalk setTree(AbstractTreeIterator iterator)
                        throws CorruptObjectException {
@@ -574,10 +589,11 @@ public class SubmoduleWalk implements AutoCloseable {
         *            an {@link org.eclipse.jgit.lib.AnyObjectId} object.
         * @return this generator
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws IncorrectObjectTypeException
-        *             if any.
+        *             if object has unexpected type
         * @throws MissingObjectException
-        *             if any.
+        *             if object is missing
         */
        public SubmoduleWalk setTree(AnyObjectId treeId) throws IOException {
                walk.addTree(treeId);
@@ -614,6 +630,7 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return true if entry found, false otherwise
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public boolean next() throws IOException {
                while (walk.next()) {
@@ -656,9 +673,11 @@ public class SubmoduleWalk implements AutoCloseable {
         * name of .git/config)
         *
         * @since 4.10
-        * @return name
+        * @return name of the submodule
         * @throws ConfigInvalidException
+        *             if the .gitmodules config is invalid
         * @throws IOException
+        *             if an IO error occurred
         */
        public String getModuleName() throws IOException, ConfigInvalidException {
                lazyLoadModulesConfig();
@@ -680,7 +699,9 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return configured path
         * @throws org.eclipse.jgit.errors.ConfigInvalidException
+        *             if .gitmodules config is invalid
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public String getModulesPath() throws IOException, ConfigInvalidException {
                lazyLoadModulesConfig();
@@ -694,7 +715,9 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return configured URL
         * @throws org.eclipse.jgit.errors.ConfigInvalidException
+        *             if .gitmodules config is invalid
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public String getConfigUrl() throws IOException, ConfigInvalidException {
                return repoConfig.getString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
@@ -707,7 +730,9 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return configured URL
         * @throws org.eclipse.jgit.errors.ConfigInvalidException
+        *             if .gitmodules config is invalid
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public String getModulesUrl() throws IOException, ConfigInvalidException {
                lazyLoadModulesConfig();
@@ -721,7 +746,9 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return update value
         * @throws org.eclipse.jgit.errors.ConfigInvalidException
+        *             if .gitmodules config is invalid
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public String getConfigUpdate() throws IOException, ConfigInvalidException {
                return repoConfig.getString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
@@ -734,7 +761,9 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return update value
         * @throws org.eclipse.jgit.errors.ConfigInvalidException
+        *             if .gitmodules config is invalid
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public String getModulesUpdate() throws IOException, ConfigInvalidException {
                lazyLoadModulesConfig();
@@ -748,7 +777,9 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return ignore value
         * @throws org.eclipse.jgit.errors.ConfigInvalidException
+        *             if .gitmodules config is invalid
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.6
         */
        public IgnoreSubmoduleMode getModulesIgnore() throws IOException,
@@ -771,6 +802,7 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return repository or null if non-existent
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public Repository getRepository() throws IOException {
                return getSubmoduleRepository(repository.getWorkTree(), path,
@@ -782,6 +814,7 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return object id of HEAD reference
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public ObjectId getHead() throws IOException {
                try (Repository subRepo = getRepository()) {
@@ -797,6 +830,7 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return ref name, null on failures
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public String getHeadRef() throws IOException {
                try (Repository subRepo = getRepository()) {
@@ -816,7 +850,9 @@ public class SubmoduleWalk implements AutoCloseable {
         *
         * @return resolved remote URL
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @throws org.eclipse.jgit.errors.ConfigInvalidException
+        *             if .gitmodules config is invalid
         */
        public String getRemoteUrl() throws IOException, ConfigInvalidException {
                String url = getModulesUrl();
index fb9c14576a58f23574aa11518afd834ba80a924a..260a85e0e48c43f72b1f65b5dcb03b7bc95dd662 100644 (file)
@@ -58,7 +58,6 @@ import org.eclipse.jgit.revwalk.RevWalk;
  * @since 2.0
  */
 public abstract class AbstractAdvertiseRefsHook implements AdvertiseRefsHook {
-       /** {@inheritDoc} */
        @Override
        public void advertiseRefs(UploadPack uploadPack)
                        throws ServiceMayNotContinueException {
@@ -67,7 +66,6 @@ public abstract class AbstractAdvertiseRefsHook implements AdvertiseRefsHook {
        }
 
        /**
-        * {@inheritDoc}
         */
        @Override
        public void advertiseRefs(ReceivePack receivePack)
index 84c36915a2e6be164c42d0178eca871ead381ee8..6381f1e94630d6b88374c78916a0ee7f445afdfb 100644 (file)
@@ -92,6 +92,7 @@ public interface AdvertiseRefsHook {
         * @throws org.eclipse.jgit.transport.ServiceMayNotContinueException
         *             abort; the message will be sent to the user.
         * @throws IOException
+        *             if an IO error occurred
         * @since 5.6
         */
        void advertiseRefs(ReceivePack receivePack)
index eb9c673ef3aec268fdce4073e57ca31ab7076765..6db0775769b18622caee90105dce73161b65f17a 100644 (file)
@@ -50,9 +50,6 @@ public class AdvertiseRefsHookChain implements AdvertiseRefsHook {
                }
        }
 
-       /**
-        * {@inheritDoc}
-        */
        @Override
        public void advertiseRefs(ReceivePack rp)
                        throws IOException {
@@ -60,7 +57,6 @@ public class AdvertiseRefsHookChain implements AdvertiseRefsHook {
                        hooks[i].advertiseRefs(rp);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void advertiseRefs(UploadPack rp)
                        throws ServiceMayNotContinueException {
index 9e229a18ad7308d40cff333c209684147fd227f4..3ac9f59ba634ada866bbd84d8344a21fdbfdce2c 100644 (file)
@@ -38,25 +38,21 @@ public abstract class BaseConnection implements Connection {
 
        private Writer messageWriter;
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, Ref> getRefsMap() {
                return advertisedRefs;
        }
 
-       /** {@inheritDoc} */
        @Override
        public final Collection<Ref> getRefs() {
                return advertisedRefs.values();
        }
 
-       /** {@inheritDoc} */
        @Override
        public final Ref getRef(String name) {
                return advertisedRefs.get(name);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getMessages() {
                return messageWriter != null ? messageWriter.toString() : ""; //$NON-NLS-1$
@@ -84,7 +80,6 @@ public abstract class BaseConnection implements Connection {
                peerUserAgent = agent;
        }
 
-       /** {@inheritDoc} */
        @Override
        public abstract void close();
 
index 6954bd9a0e42a47cb17e8f3e3fc42b7d2fe7e479..48992f3e3bd016dcb8bd70b4579e92e41ea50366 100644 (file)
@@ -31,7 +31,6 @@ import org.eclipse.jgit.lib.Ref;
  */
 abstract class BaseFetchConnection extends BaseConnection implements
                FetchConnection {
-       /** {@inheritDoc} */
        @Override
        public final void fetch(final ProgressMonitor monitor,
                        final Collection<Ref> want, final Set<ObjectId> have)
@@ -39,7 +38,6 @@ abstract class BaseFetchConnection extends BaseConnection implements
                fetch(monitor, want, have, null);
        }
 
-       /** {@inheritDoc} */
        @Override
        public final void fetch(final ProgressMonitor monitor,
                        final Collection<Ref> want, final Set<ObjectId> have,
index 09c559d7b56e0a1d85e11bd858825987c1faf29c..bac5025f83cb7c96ccea2bcf4357b4319e10d880 100644 (file)
@@ -64,6 +64,7 @@ import org.eclipse.jgit.util.io.TimeoutOutputStream;
  */
 abstract class BasePackConnection extends BaseConnection {
 
+       /** The capability prefix for a symlink */
        protected static final String CAPABILITY_SYMREF_PREFIX = "symref="; //$NON-NLS-1$
 
        /** The repository this transport fetches into, or pushes out of. */
@@ -72,7 +73,7 @@ abstract class BasePackConnection extends BaseConnection {
        /** Remote repository location. */
        protected final URIish uri;
 
-       /** A transport connected to {@link #uri}. */
+       /** A transport connected to {@link BasePackConnection#uri}. */
        protected final Transport transport;
 
        /** Low-level input stream, if a timeout was configured. */
@@ -81,7 +82,10 @@ abstract class BasePackConnection extends BaseConnection {
        /** Low-level output stream, if a timeout was configured. */
        protected TimeoutOutputStream timeoutOut;
 
-       /** Timer to manage {@link #timeoutIn} and {@link #timeoutOut}. */
+       /**
+        * Timer to manage {@link #timeoutIn} and
+        * {@link BasePackConnection#timeoutOut}.
+        */
        private InterruptTimer myTimer;
 
        /** Input stream reading from the remote. */
@@ -90,13 +94,16 @@ abstract class BasePackConnection extends BaseConnection {
        /** Output stream sending to the remote. */
        protected OutputStream out;
 
-       /** Packet line decoder around {@link #in}. */
+       /** Packet line decoder around {@link BasePackConnection#in}. */
        protected PacketLineIn pckIn;
 
-       /** Packet line encoder around {@link #out}. */
+       /** Packet line encoder around {@link BasePackConnection#out}. */
        protected PacketLineOut pckOut;
 
-       /** Send {@link PacketLineOut#end()} before closing {@link #out}? */
+       /**
+        * Send {@link PacketLineOut#end()} before closing
+        * {@link BasePackConnection#out}?
+        */
        protected boolean outNeedsEnd;
 
        /** True if this is a stateless RPC connection. */
@@ -486,7 +493,6 @@ abstract class BasePackConnection extends BaseConnection {
         * <p>
         * If refMap already contains an entry for symRef.key, it is replaced.
         * </p>
-        * </p>
         * <p>
         * For example, given:
         * </p>
@@ -627,7 +633,6 @@ abstract class BasePackConnection extends BaseConnection {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getPeerUserAgent() {
                String agent = remoteCapabilities.get(OPTION_AGENT);
@@ -642,7 +647,6 @@ abstract class BasePackConnection extends BaseConnection {
                return new PackProtocolException(uri, MessageFormat.format(JGitText.get().invalidRefAdvertisementLine, line));
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                if (out != null) {
index 8909380176e1edc6f9827391af6a5ca53a0f90ff..cdda3c0388ed6e01b3a617f6067f5e0749f6b439 100644 (file)
@@ -334,7 +334,6 @@ public abstract class BasePackFetchConnection extends BasePackConnection
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public final void fetch(final ProgressMonitor monitor,
                        final Collection<Ref> want, final Set<ObjectId> have)
@@ -342,7 +341,6 @@ public abstract class BasePackFetchConnection extends BasePackConnection
                fetch(monitor, want, have, null);
        }
 
-       /** {@inheritDoc} */
        @Override
        public final void fetch(final ProgressMonitor monitor,
                        final Collection<Ref> want, final Set<ObjectId> have,
@@ -351,25 +349,21 @@ public abstract class BasePackFetchConnection extends BasePackConnection
                doFetch(monitor, want, have, outputStream);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean didFetchIncludeTags() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean didFetchTestConnectivity() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setPackLockMessage(String message) {
                lockMessage = message;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<PackLock> getPackLocks() {
                if (packLock != null)
@@ -659,7 +653,6 @@ public abstract class BasePackFetchConnection extends BasePackConnection
                return gotReady;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                if (walk != null)
index adc1c9849dd7f0f6e25d57a1ac5328e444127975..9a96fdcf37d5eb4bbec19ac966fb07c533a225b3 100644 (file)
@@ -122,7 +122,6 @@ public abstract class BasePackPushConnection extends BasePackConnection implemen
                useBitmaps = transport.isPushUseBitmaps();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void push(final ProgressMonitor monitor,
                        final Map<String, RemoteRefUpdate> refUpdates)
@@ -130,7 +129,6 @@ public abstract class BasePackPushConnection extends BasePackConnection implemen
                push(monitor, refUpdates, null);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void push(final ProgressMonitor monitor,
                        final Map<String, RemoteRefUpdate> refUpdates, OutputStream outputStream)
@@ -139,7 +137,6 @@ public abstract class BasePackPushConnection extends BasePackConnection implemen
                doPush(monitor, refUpdates, outputStream);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected TransportException noRepository(Throwable cause) {
                // Sadly we cannot tell the "invalid URI" case from "push not allowed".
index f04e573feb7b6e99c19d482bd9d576d6960c750e..5299dfa981ed7cfa8c40acadcf40781621527d01 100644 (file)
@@ -147,13 +147,11 @@ class BundleFetchConnection extends BaseFetchConnection {
                return line.toString();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean didFetchTestConnectivity() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void doFetch(final ProgressMonitor monitor,
                        final Collection<Ref> want, final Set<ObjectId> have)
@@ -174,13 +172,11 @@ class BundleFetchConnection extends BaseFetchConnection {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setPackLockMessage(String message) {
                lockMessage = message;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<PackLock> getPackLocks() {
                if (packLock != null)
@@ -258,7 +254,6 @@ class BundleFetchConnection extends BaseFetchConnection {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                if (bin != null) {
index 6a4cfca865fa50ee348ad7abb71909f1c7083fe4..3bae0eae5a19ebf82d9ac7d0241c026c8e311e76 100644 (file)
@@ -39,7 +39,6 @@ public class ChainingCredentialsProvider extends CredentialsProvider {
                                Arrays.asList(providers));
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isInteractive() {
                for (CredentialsProvider p : credentialProviders)
@@ -48,7 +47,6 @@ public class ChainingCredentialsProvider extends CredentialsProvider {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean supports(CredentialItem... items) {
                for (CredentialsProvider p : credentialProviders)
index 2b0942452628c141bcaca973467e4ba90dbf3ef7..78c5c6374f3e2016a44171c2141d8cdd5a4d39a9 100644 (file)
@@ -115,8 +115,8 @@ public abstract class CredentialItem {
                }
 
                /**
-                *
                 * @param newValue
+                *            the new value
                 */
                public void setValue(String newValue) {
                        value = newValue;
@@ -223,6 +223,7 @@ public abstract class CredentialItem {
                 * Set the new value.
                 *
                 * @param newValue
+                *            the new value
                 */
                public void setValue(boolean newValue) {
                        value = newValue;
index a8cf849fed55e33fb5b6d56a8e6625db6af67dfd..12a7dd3af474bfae39441a6b3f5cd7e33ef6e5bb 100644 (file)
@@ -55,7 +55,6 @@ public final class FilterSpec {
                        return val.testBit(type);
                }
 
-               /** {@inheritDoc} */
                @Override
                public boolean equals(Object obj) {
                        if (!(obj instanceof ObjectTypes)) {
@@ -66,7 +65,6 @@ public final class FilterSpec {
                        return other.val.equals(val);
                }
 
-               /** {@inheritDoc} */
                @Override
                public int hashCode() {
                        return val.hashCode();
index 44656c1397674a84edbb94c44c15325511a46402..6d5b5e61ecd61fd9dff12ba1d3ec8d29b009aae1 100644 (file)
@@ -71,6 +71,7 @@ public interface FtpChannel {
         * @param unit
         *            of the {@code timeout}
         * @throws IOException
+        *             if an IO error occurred
         */
        void connect(int timeout, TimeUnit unit) throws IOException;
 
@@ -97,6 +98,7 @@ public interface FtpChannel {
        /**
         * @return the current remote directory path
         * @throws IOException
+        *             if an IO error occurred
         */
        String pwd() throws IOException;
 
@@ -118,6 +120,7 @@ public interface FtpChannel {
         *            of the directory to list
         * @return the directory entries
         * @throws IOException
+        *             if an IO error occurred
         */
        Collection<DirEntry> ls(String path) throws IOException;
 
@@ -128,6 +131,7 @@ public interface FtpChannel {
         * @param path
         *            to delete
         * @throws IOException
+        *             if an IO error occurred
         */
        void rmdir(String path) throws IOException;
 
@@ -137,6 +141,7 @@ public interface FtpChannel {
         * @param path
         *            to create
         * @throws IOException
+        *             if an IO error occurred
         */
        void mkdir(String path) throws IOException;
 
@@ -148,6 +153,7 @@ public interface FtpChannel {
         *
         * @return the stream to read from
         * @throws IOException
+        *             if an IO error occurred
         */
        InputStream get(String path) throws IOException;
 
@@ -160,6 +166,7 @@ public interface FtpChannel {
         *
         * @return the stream to read from
         * @throws IOException
+        *             if an IO error occurred
         */
        OutputStream put(String path) throws IOException;
 
@@ -204,6 +211,7 @@ public interface FtpChannel {
         * @param to
         *            new name of the file
         * @throws IOException
+        *             if an IO error occurred
         * @see <a href=
         *      "http://pubs.opengroup.org/onlinepubs/9699919799/functions/rename.html">stdio.h:
         *      rename()</a>
index 14d6c1ec14fe96a3b9a941bb25caadb4767b9365..655b4605e43caa7014e6955be3c3cddf4d2b2b0f 100644 (file)
@@ -35,9 +35,8 @@ public class HMACSHA1NonceGenerator implements NonceGenerator {
         *
         * @param seed
         *            seed the generator
-        * @throws java.lang.IllegalStateException
         */
-       public HMACSHA1NonceGenerator(String seed) throws IllegalStateException {
+       public HMACSHA1NonceGenerator(String seed) {
                try {
                        byte[] keyBytes = seed.getBytes(ISO_8859_1);
                        SecretKeySpec signingKey = new SecretKeySpec(keyBytes, "HmacSHA1"); //$NON-NLS-1$
@@ -48,16 +47,13 @@ public class HMACSHA1NonceGenerator implements NonceGenerator {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
-       public synchronized String createNonce(Repository repo, long timestamp)
-                       throws IllegalStateException {
+       public synchronized String createNonce(Repository repo, long timestamp) {
                String input = repo.getIdentifier() + ":" + String.valueOf(timestamp); //$NON-NLS-1$
                byte[] rawHmac = mac.doFinal(input.getBytes(UTF_8));
                return Long.toString(timestamp) + "-" + toHex(rawHmac); //$NON-NLS-1$
        }
 
-       /** {@inheritDoc} */
        @Override
        public NonceStatus verify(String received, String sent,
                        Repository db, boolean allowSlop, int slop) {
index aec5b89c7e4a1980c5720f06bb4eb9ebc1053716..3db0421d6933b2d973479bd50b338b5b9ca127bb 100644 (file)
@@ -224,7 +224,9 @@ abstract class HttpAuthMethod {
         * Update this method with the given username and password pair.
         *
         * @param user
+        *            username
         * @param pass
+        *            password
         */
        abstract void authorize(String user, String pass);
 
@@ -232,7 +234,9 @@ abstract class HttpAuthMethod {
         * Update connection properties based on this authentication method.
         *
         * @param conn
+        *            the connection to configure
         * @throws IOException
+        *             if an IO error occurred
         */
        abstract void configureRequest(HttpConnection conn) throws IOException;
 
index 18dc792eb1ecebd2f4183ac1f6b513c4a8b17e78..9a699a877fa1953668117c175a744664fb0244b2 100644 (file)
@@ -103,7 +103,6 @@ class InternalFetchConnection<C> extends BasePackFetchConnection {
                readAdvertisedRefs();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                super.close();
index d2b0ef4a29a4c815238c6831bf06848ef1372837..a23fdc94ad4fa8ad221eba1d7b53651f98394030 100644 (file)
@@ -99,7 +99,6 @@ class InternalPushConnection<C> extends BasePackPushConnection {
                readAdvertisedRefs();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                super.close();
index 856047ee1927e95abbd656a013285b1b9259767d..b2799e1362ea255e2f8b25ea03c1c65ed26a31c9 100644 (file)
@@ -130,6 +130,7 @@ public final class LsRefsV2Request {
 
                /**
                 * @param value
+                *            ref prefix values
                 * @return the Builder
                 */
                public Builder setRefPrefixes(List<String> value) {
@@ -139,6 +140,7 @@ public final class LsRefsV2Request {
 
                /**
                 * @param value
+                *            of symrefs
                 * @return the Builder
                 */
                public Builder setSymrefs(boolean value) {
@@ -148,6 +150,7 @@ public final class LsRefsV2Request {
 
                /**
                 * @param value
+                *            of peel
                 * @return the Builder
                 */
                public Builder setPeel(boolean value) {
@@ -203,7 +206,11 @@ public final class LsRefsV2Request {
                        return this;
                }
 
-               /** @return LsRefsV2Request */
+               /**
+                * Builds the request
+                *
+                * @return LsRefsV2Request the request
+                */
                public LsRefsV2Request build() {
                        return new LsRefsV2Request(
                                        Collections.unmodifiableList(refPrefixes), symrefs, peel,
index 6531b17e2335a11ae53b6039edd18840d82a1faa..e32530cc9bd001d1c425be7aa0fa9c1ec5404a02 100644 (file)
@@ -67,7 +67,6 @@ public class NetRCCredentialsProvider extends CredentialsProvider {
                CredentialsProvider.setDefault(new NetRCCredentialsProvider());
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean supports(CredentialItem... items) {
                for (CredentialItem i : items) {
@@ -81,7 +80,6 @@ public class NetRCCredentialsProvider extends CredentialsProvider {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean get(URIish uri, CredentialItem... items)
                        throws UnsupportedCredentialItem {
@@ -112,7 +110,6 @@ public class NetRCCredentialsProvider extends CredentialsProvider {
                return !isAnyNull(items);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isInteractive() {
                return false;
index 2541ff139339721c82c82473a9fa11eeb36465ed..30e80e0783d3d421ce9f62c632c8f4ba77d7806f 100644 (file)
@@ -31,10 +31,8 @@ public interface NonceGenerator {
         * @param timestamp
         *            The current time in seconds.
         * @return The nonce to be signed by the pusher
-        * @throws java.lang.IllegalStateException
         */
-       String createNonce(Repository db, long timestamp)
-                       throws IllegalStateException;
+       String createNonce(Repository db, long timestamp);
 
        /**
         * Verify trustworthiness of the received nonce.
index 86a2716675063f7ea7e9c65b8bc9b55348afdb47..2a52d7fd7fea5aa3862b1152153bad5bab35dbfe 100644 (file)
@@ -53,6 +53,7 @@ public final class ObjectInfoRequest {
 
                /**
                 * @param value
+                *            of objectIds
                 * @return the Builder
                 */
                public Builder setObjectIDs(List<ObjectId> value) {
@@ -60,7 +61,11 @@ public final class ObjectInfoRequest {
                        return this;
                }
 
-               /** @return ObjectInfoRequest */
+               /**
+                * Build the request
+                *
+                * @return ObjectInfoRequest the request
+                */
                public ObjectInfoRequest build() {
                        return new ObjectInfoRequest(
                                        Collections.unmodifiableList(objectIDs));
index d9669044c70bdb2f575ba1f61c3d9fbb68438097..fe9ddabf8e3fdc033ed44dbd5e8dcdf666c194b2 100644 (file)
@@ -1102,6 +1102,7 @@ public abstract class PackParser {
         * @param data
         *            raw content of the object.
         * @throws org.eclipse.jgit.errors.CorruptObjectException
+        *             if a corrupt object was found
         * @since 4.9
         */
        protected void verifySafeObject(final AnyObjectId id, final int type,
index bf7997ec62a6d360410a34eded8e4ef19c24a3c1..d7ef4f8f0af97cd5c4c136bb28ebbb9c2f4cc1d8 100644 (file)
@@ -117,6 +117,7 @@ public class PackedObjectInfo extends ObjectIdOwnerMap.Entry {
         * Size in storage
         *
         * @param sizeBeforeInflating
+        *            size before inflating
         */
        void setSize(long sizeBeforeInflating) {
                this.sizeBeforeInflating = sizeBeforeInflating;
index 4d53e1b261db4521ea9b42ca4b57fa6fe1847194..f9d2c38ad3f4e9d12e2bf91f11b109bb6dc16f2e 100644 (file)
@@ -47,7 +47,6 @@ public class PostReceiveHookChain implements PostReceiveHook {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void onPostReceive(ReceivePack rp,
                        Collection<ReceiveCommand> commands) {
index 4334888a9af0e26d1bcf6d84231bc4fcdb75aba8..072f43f41bd2d331e9d9b35471bc4314134e9876 100644 (file)
@@ -80,7 +80,6 @@ public class PostUploadHookChain implements PostUploadHook {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void onPostUpload(PackStatistics stats) {
                for (PostUploadHook hook : hooks) {
index dffa30da8e6664cf847fb9addfd4a9f500ca67ee..2a5522bb4ce55c4f4e335a8e94d6217d0cfde797 100644 (file)
@@ -46,7 +46,6 @@ public class PreReceiveHookChain implements PreReceiveHook {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void onPreReceive(ReceivePack rp,
                        Collection<ReceiveCommand> commands) {
index 9c28abed9566151e9c340e05408f593a16048f81..dc703d0b112ab4cd42d90debc33aab84ee0368ce 100644 (file)
@@ -48,7 +48,6 @@ public class PreUploadHookChain implements PreUploadHook {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void onBeginNegotiateRound(UploadPack up,
                        Collection<? extends ObjectId> wants, int cntOffered)
@@ -58,7 +57,6 @@ public class PreUploadHookChain implements PreUploadHook {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void onEndNegotiateRound(UploadPack up,
                        Collection<? extends ObjectId> wants, int cntCommon,
@@ -69,7 +67,6 @@ public class PreUploadHookChain implements PreUploadHook {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void onSendPack(UploadPack up,
                        Collection<? extends ObjectId> wants,
index 9d055519a5ea35dde77df356d196c4b8d7ba79b9..f1afeab020ce3b6fb5f2062002c73790b76a4f54 100644 (file)
@@ -51,7 +51,9 @@ final class ProtocolV0Parser {
         *            incoming lines. This method will read until an END line.
         * @return a FetchV0Request with the data received in the wire.
         * @throws PackProtocolException
+        *             if a protocol occurred
         * @throws IOException
+        *             if an IO error occurred
         */
        FetchV0Request recvWants(PacketLineIn pckIn)
                        throws PackProtocolException, IOException {
index d9831c7701adac5f33df4e994d8e83c8661c2780..437abb06397e43963349e6deade177e267789501 100644 (file)
@@ -222,13 +222,11 @@ public class PushCertificate {
                return sb;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return signature.hashCode();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object o) {
                if (!(o instanceof PushCertificate)) {
@@ -259,7 +257,6 @@ public class PushCertificate {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return getClass().getSimpleName() + '['
index 94d1169abb65f8a9e362b6370153da28eadde996..bd76b34aef056d854eb737c729dd9980b18a74b5 100644 (file)
@@ -228,20 +228,17 @@ public class PushCertificateIdent {
                return tzOffset;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object o) {
                return (o instanceof PushCertificateIdent)
                        && raw.equals(((PushCertificateIdent) o).raw);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return raw.hashCode();
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 51c8558bfd1f050b354639a6eb3e687a798c11b7..32c443f0f33f6a7b453b6590fbda0d75d104976e 100644 (file)
@@ -43,17 +43,14 @@ public interface PushConnection extends Connection {
         * and sending objects that remote repository need to have a consistent
         * objects graph from new refs.
         * <p>
-        * <p>
         * Only one call per connection is allowed. Subsequent calls will result in
         * {@link org.eclipse.jgit.errors.TransportException}.
-        * </p>
         * <p>
         * Implementation may use local repository to send a minimum set of objects
         * needed by remote repository in efficient way.
         * {@link org.eclipse.jgit.transport.Transport#isPushThin()} should be
         * honored if applicable. refUpdates should be filled with information about
         * status of each update.
-        * </p>
         *
         * @param monitor
         *            progress monitor to update the end-user about the amount of
@@ -90,17 +87,14 @@ public interface PushConnection extends Connection {
         * and sending objects that remote repository need to have a consistent
         * objects graph from new refs.
         * <p>
-        * <p>
         * Only one call per connection is allowed. Subsequent calls will result in
         * {@link org.eclipse.jgit.errors.TransportException}.
-        * </p>
         * <p>
         * Implementation may use local repository to send a minimum set of objects
         * needed by remote repository in efficient way.
         * {@link org.eclipse.jgit.transport.Transport#isPushThin()} should be
         * honored if applicable. refUpdates should be filled with information about
         * status of each update.
-        * </p>
         *
         * @param monitor
         *            progress monitor to update the end-user about the amount of
index b59ae0c4504e879f6baa15df0155ebec7235baa0..8f90f326d39687fba41e55c7eb8086cb6b4c9a1c 100644 (file)
@@ -76,6 +76,7 @@ class PushProcess {
         *            {@link PrePushHook} to run after the remote advertisement has
         *            been gotten
         * @throws TransportException
+        *             if a protocol error occurred during push/fetch
         */
        PushProcess(Transport transport, Collection<RemoteRefUpdate> toPush,
                        PrePushHook prePush) throws TransportException {
@@ -96,6 +97,7 @@ class PushProcess {
         * @param out
         *            OutputStream to write messages to
         * @throws TransportException
+        *             if a protocol error occurred during push/fetch
         */
        PushProcess(Transport transport, Collection<RemoteRefUpdate> toPush,
                        PrePushHook prePush, OutputStream out) throws TransportException {
@@ -272,6 +274,7 @@ class PushProcess {
         *            {@link ObjectId} of the new commit
         * @return {@code true} if the update fast-forwards, {@code false} otherwise
         * @throws TransportException
+        *             if a protocol error occurred during push/fetch
         */
        private boolean isFastForward(ObjectId oldOid, ObjectId newOid)
                        throws TransportException {
index ab411600f1494ba778c4e5028c546e5411e34409..bfc75f036cf21dc9157aeed452dc75e0da95106a 100644 (file)
@@ -849,7 +849,6 @@ public class ReceiveCommand {
                                JGitText.get().lockError, err.getMessage()));
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 816cec89afac442b7e496c453955cbeedeed9356..9a6177433458d63c64d2ca262220c0510c75843d 100644 (file)
@@ -460,6 +460,7 @@ public class ReceivePack {
         *            null, assumes the default set of additional haves from the
         *            repository.
         * @throws IOException
+        *             if an IO error occurred
         */
        public void setAdvertisedRefs(Map<String, Ref> allRefs,
                        Set<ObjectId> additionalHaves) throws IOException {
@@ -1024,6 +1025,7 @@ public class ReceivePack {
         * Set an error handler for {@link ReceiveCommand}.
         *
         * @param receiveCommandErrorHandler
+        *            the error handler
         * @since 5.7
         */
        public void setReceiveCommandErrorHandler(
@@ -1212,6 +1214,7 @@ public class ReceivePack {
         *
         * @return advertised refs, or the default if not explicitly advertised.
         * @throws IOException
+        *             if an IO error occurred
         */
        private Map<String, Ref> getAdvertisedOrDefaultRefs() throws IOException {
                if (refs == null)
@@ -1348,7 +1351,8 @@ public class ReceivePack {
        /**
         * Receive a list of commands from the input.
         *
-        * @throws java.io.IOException
+        * @throws IOException
+        *             if an IO error occurred
         */
        private void recvCommands() throws IOException {
                PacketLineIn pck = maxCommandBytes > 0
@@ -1936,7 +1940,8 @@ public class ReceivePack {
        /**
         * Close and flush (if necessary) the underlying streams.
         *
-        * @throws java.io.IOException
+        * @throws IOException
+        *             if an IO error occurred
         */
        private void close() throws IOException {
                if (sideBand) {
@@ -2174,6 +2179,7 @@ public class ReceivePack {
         *            standard error channel of the command execution. For most
         *            other network connections this should be null.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void receive(final InputStream input, final OutputStream output,
                        final OutputStream messages) throws IOException {
@@ -2217,6 +2223,7 @@ public class ReceivePack {
         *            standard error channel of the command execution. For most
         *            other network connections this should be null.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 5.7
         */
        public void receiveWithExceptionPropagation(InputStream input,
index c525e668482f8ccb80c7907678b5563cee23a726..6b022ea5d199550d5f10122d29b804d23b347e2a 100644 (file)
@@ -173,7 +173,7 @@ public abstract class RefAdvertiser {
        /**
         * Toggle tag peeling.
         * <p>
-        * <p>
+        *
         * This method must be invoked prior to any of the following:
         * <ul>
         * <li>{@link #send(Map)}</li>
index 1af3fadadb6c02385a11334465a890ae6b1e4e73..8a131c897131c4a75ab9b31968a8b787c4c7f6f0 100644 (file)
@@ -58,7 +58,6 @@ public class RefLeaseSpec implements Serializable {
                return expected;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder r = new StringBuilder();
index 61d193593ac1ff036ce161cf04a60d0f742c0588..0466085b32097df51e70b035c682182101d37f5c 100644 (file)
@@ -616,7 +616,6 @@ public class RefSpec implements Serializable {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                int hc = 0;
@@ -627,7 +626,6 @@ public class RefSpec implements Serializable {
                return hc;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object obj) {
                if (!(obj instanceof RefSpec))
@@ -649,7 +647,6 @@ public class RefSpec implements Serializable {
                                && Objects.equals(getDestination(), b.getDestination());
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder r = new StringBuilder();
index 218e62c10a00b034d8c86b1675fad91051e092ea..fb3cd21d1a8b51d17138b65ea8d3a4352f49cae3 100644 (file)
@@ -541,7 +541,6 @@ public class RemoteRefUpdate {
                        trackingRefUpdate.setResult(localUpdate.update(walk));
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 96c7be5b97ba114f4fdce94dab517b528807738b..1f96be8e47381d6c0d0d1a47cbc5e817d46cf455 100644 (file)
@@ -94,7 +94,6 @@ public class SideBandInputStream extends InputStream {
                out = outputStream;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                needDataPacket();
@@ -104,7 +103,6 @@ public class SideBandInputStream extends InputStream {
                return rawIn.read();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] b, int off, int len) throws IOException {
                int r = 0;
index bb80299fad5fcf146c40d51a08968a542b96a353..b6d840dd81b02104e524ac41ec5a5f2bd49c8962 100644 (file)
@@ -94,14 +94,12 @@ public class SideBandOutputStream extends OutputStream {
                        writeBuffer();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                flushBuffer();
                out.flush();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b, int off, int len) throws IOException {
                while (0 < len) {
@@ -128,7 +126,6 @@ public class SideBandOutputStream extends OutputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                if (cnt == buffer.length)
index 33308600d98b76b4bce1f16b47bebab80699918d..1e85d81084369938cc0eedd4d4b78022033dd9c6 100644 (file)
@@ -28,7 +28,6 @@ class SideBandProgressMonitor extends BatchingProgressMonitor {
                write = true;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onUpdate(String taskName, int workCurr, Duration duration) {
                StringBuilder s = new StringBuilder();
@@ -37,7 +36,6 @@ class SideBandProgressMonitor extends BatchingProgressMonitor {
                send(s);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndTask(String taskName, int workCurr, Duration duration) {
                StringBuilder s = new StringBuilder();
@@ -54,7 +52,6 @@ class SideBandProgressMonitor extends BatchingProgressMonitor {
                appendDuration(s, duration);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onUpdate(String taskName, int cmp, int totalWork, int pcnt,
                        Duration duration) {
@@ -64,7 +61,6 @@ class SideBandProgressMonitor extends BatchingProgressMonitor {
                send(s);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void onEndTask(String taskName, int cmp, int totalWork, int pcnt,
                        Duration duration) {
index 1226a6b5eae421c7c2adc1808764123a532d91ea..b2e2549f1209a04a2a18525dcbde8c358f25eca0 100644 (file)
@@ -43,6 +43,7 @@ public interface SshConfigStore {
         * {@link SshConstants#CONNECTION_ATTEMPTS}, fill those values with defaults
         * from the arguments:
         * <table>
+        * <caption>Description of arguments</caption>
         * <tr>
         * <th>ssh config key</th>
         * <th>value from argument</th>
index 48cacf0964582737b9224067b3d2bf512e3a8bf8..be0c2963d96d9edc57e4df4b1e1539a45dd1caa8 100644 (file)
@@ -146,8 +146,8 @@ public final class SshConstants {
         * Comma-separated list of jump hosts, defining a jump host chain <em>in
         * reverse order</em>. Each jump host is a SSH URI or "[user@]host[:port]".
         * <p>
-        * Reverse order means: to connect A->B->target, one can do in
-        * {@code ~/.ssh/config} either of:
+        * Reverse order means: to connect {@literal A -> B -> target}, one can do
+        * in {@code ~/.ssh/config} either of:
         * </p>
         *
         * <pre>
index 28ec92c7061e2ede5a8b7e67cb765c3ce0e8f337..8d93977a1d6b29344410606dd1d51d2cb788b0d1 100644 (file)
@@ -108,7 +108,6 @@ public abstract class SshTransport extends TcpTransport {
                return sock;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                if (sock != null) {
index 1985b66d87ad7c25b1efaf7637ef33499a26d102..77ab0f676d85bbf9519a24e6d54531ccc5074f39 100644 (file)
@@ -81,19 +81,16 @@ public class TestProtocol<C> extends TransportProtocol {
                this.handles = new HashMap<>();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getName() {
                return JGitText.get().transportProtoTest;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Set<String> getSchemes() {
                return Collections.singleton(SCHEME);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Transport open(URIish uri, Repository local, String remoteName)
                        throws NotSupportedException, TransportException {
@@ -105,13 +102,11 @@ public class TestProtocol<C> extends TransportProtocol {
                return new TransportInternal(local, uri, h);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Set<URIishField> getRequiredFields() {
                return EnumSet.of(URIishField.HOST, URIishField.PATH);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Set<URIishField> getOptionalFields() {
                return Collections.emptySet();
index 51bc07cb948b036f8aa95a8668051924243f2a8a..26045a2c7c2b9efe6d19b8d56e892124a6fe03d4 100644 (file)
@@ -174,7 +174,6 @@ public class TrackingRefUpdate {
                }
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index ee35f4866e7d83193316652b8132a5285725b406..4d2f4a9ac0846d5cd1e08c0ff8dae49351cf0971 100644 (file)
@@ -533,10 +533,13 @@ public abstract class Transport implements AutoCloseable {
         * Note that the resulting transport instance can not be used for fetching
         * or pushing, but only for reading remote refs.
         *
-        * @param uri a {@link org.eclipse.jgit.transport.URIish} object.
+        * @param uri
+        *            a {@link org.eclipse.jgit.transport.URIish} object.
         * @return new Transport instance
         * @throws org.eclipse.jgit.errors.NotSupportedException
+        *             case that is not supported by JGit
         * @throws org.eclipse.jgit.errors.TransportException
+        *             if transport failed
         */
        public static Transport open(URIish uri) throws NotSupportedException, TransportException {
                for (WeakReference<TransportProtocol> ref : protocols) {
index 784f566159474c19aba2c5ab387c5c1fd611126e..58232a7dde17c21cb0f1664679aa00fac03dabfa 100644 (file)
@@ -170,7 +170,6 @@ public class TransportAmazonS3 extends HttpTransport implements WalkTransport {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public FetchConnection openFetch() throws TransportException {
                final DatabaseS3 c = new DatabaseS3(bucket, keyPrefix + "/objects"); //$NON-NLS-1$
@@ -179,7 +178,6 @@ public class TransportAmazonS3 extends HttpTransport implements WalkTransport {
                return r;
        }
 
-       /** {@inheritDoc} */
        @Override
        public PushConnection openPush() throws TransportException {
                final DatabaseS3 c = new DatabaseS3(bucket, keyPrefix + "/objects"); //$NON-NLS-1$
@@ -188,7 +186,6 @@ public class TransportAmazonS3 extends HttpTransport implements WalkTransport {
                return r;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                // No explicit connections are maintained.
index 04ebddb107369a05baa0c1aa2ed5310bc4d53ed8..0f84f7e21ec188db9b5203f50a7f24d9fc37d0d2 100644 (file)
@@ -105,7 +105,6 @@ class TransportBundleFile extends Transport implements TransportBundle {
                bundle = bundlePath;
        }
 
-       /** {@inheritDoc} */
        @Override
        public FetchConnection openFetch() throws NotSupportedException,
                        TransportException {
@@ -121,14 +120,12 @@ class TransportBundleFile extends Transport implements TransportBundle {
                return new BundleFetchConnection(this, src);
        }
 
-       /** {@inheritDoc} */
        @Override
        public PushConnection openPush() throws NotSupportedException {
                throw new NotSupportedException(
                                JGitText.get().pushIsNotSupportedForBundleTransport);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                // Resources must be established per-connection.
index eac9208a3aa4223d3d5a2efa69de13c885b4640e..0366bf3aa257e050c7ac36741682953d3ce5cbb8 100644 (file)
@@ -57,7 +57,6 @@ public class TransportBundleStream extends Transport implements TransportBundle
                src = in;
        }
 
-       /** {@inheritDoc} */
        @Override
        public FetchConnection openFetch() throws TransportException {
                if (src == null)
@@ -69,14 +68,12 @@ public class TransportBundleStream extends Transport implements TransportBundle
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public PushConnection openPush() throws NotSupportedException {
                throw new NotSupportedException(
                                JGitText.get().pushIsNotSupportedForBundleTransport);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                if (src != null) {
index a1914b61820ac0c6446199adf267b46f9c86a731..43b3f6cce0ab7da60660e4489167a3db77dbe89f 100644 (file)
@@ -89,7 +89,6 @@ class TransportGitAnon extends TcpTransport implements PackTransport {
                super(uri);
        }
 
-       /** {@inheritDoc} */
        @Override
        public FetchConnection openFetch() throws TransportException {
                return new TcpFetchConnection();
@@ -102,13 +101,11 @@ class TransportGitAnon extends TcpTransport implements PackTransport {
                return new TcpFetchConnection(refSpecs, additionalPatterns);
        }
 
-       /** {@inheritDoc} */
        @Override
        public PushConnection openPush() throws TransportException {
                return new TcpPushConnection();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                // Resources must be established per-connection.
index 19ed4fbcc11c7b1f36342e137334aee6498db9ca..a2273b21be56940354ef9cef6942555b49e12beb 100644 (file)
@@ -140,7 +140,6 @@ public class TransportGitSsh extends SshTransport implements PackTransport {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public FetchConnection openFetch() throws TransportException {
                return new SshFetchConnection();
@@ -153,7 +152,6 @@ public class TransportGitSsh extends SshTransport implements PackTransport {
                return new SshFetchConnection(refSpecs, additionalPatterns);
        }
 
-       /** {@inheritDoc} */
        @Override
        public PushConnection openPush() throws TransportException {
                return new SshPushConnection();
index df034bdc8bb353a3b019c709cd48a1999fbc355a..c08b7fa2431b7ab44db32e30cdde4348a3343f24 100644 (file)
@@ -311,6 +311,7 @@ public class TransportHttp extends HttpTransport implements WalkTransport,
         * @param uri
         *            a {@link org.eclipse.jgit.transport.URIish} object.
         * @throws org.eclipse.jgit.errors.NotSupportedException
+        *             if URI is not supported by JGit
         * @since 4.9
         */
        protected void setURI(URIish uri) throws NotSupportedException {
@@ -327,7 +328,9 @@ public class TransportHttp extends HttpTransport implements WalkTransport,
         * Create a minimal HTTP transport with default configuration values.
         *
         * @param uri
+        *            URI to create a HTTP transport for
         * @throws NotSupportedException
+        *             if URI is not supported by JGit
         */
        TransportHttp(URIish uri) throws NotSupportedException {
                super(uri);
@@ -445,7 +448,6 @@ public class TransportHttp extends HttpTransport implements WalkTransport,
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public FetchConnection openFetch() throws TransportException,
                        NotSupportedException {
@@ -532,7 +534,6 @@ public class TransportHttp extends HttpTransport implements WalkTransport,
                return new BufferedReader(new InputStreamReader(in, UTF_8));
        }
 
-       /** {@inheritDoc} */
        @Override
        public PushConnection openPush() throws NotSupportedException,
                        TransportException {
@@ -567,7 +568,6 @@ public class TransportHttp extends HttpTransport implements WalkTransport,
                return p;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                if (gitSession != null) {
@@ -822,7 +822,7 @@ public class TransportHttp extends HttpTransport implements WalkTransport,
                /**
                 * Trust the server for all git operations from this repository; may be
                 * {@code null} if the transport was created via
-                * {@link #TransportHttp(URIish)}.
+                * {@link TransportHttp#TransportHttp(URIish)}.
                 */
                CredentialItem.YesNoType forRepo;
 
@@ -1035,11 +1035,15 @@ public class TransportHttp extends HttpTransport implements WalkTransport,
        /**
         * Open an HTTP connection.
         *
-        * @param method HTTP request method
-        * @param u url of the HTTP connection
-        * @param acceptEncoding accept-encoding header option
+        * @param method
+        *            HTTP request method
+        * @param u
+        *            url of the HTTP connection
+        * @param acceptEncoding
+        *            accept-encoding header option
         * @return the HTTP connection
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.6
         */
        protected HttpConnection httpOpen(String method, URL u,
index 77d1419ea2b40f2ff632ac236bebc1bf6cfe18a4..3a06ce5b6332e273fd694bc969a9314ddf4461fa 100644 (file)
@@ -151,7 +151,6 @@ class TransportLocal extends Transport implements PackTransport {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public FetchConnection openFetch() throws TransportException {
                return openFetch(Collections.emptyList());
@@ -170,7 +169,6 @@ class TransportLocal extends Transport implements PackTransport {
                return new InternalFetchConnection<>(this, upf, null, openRepo());
        }
 
-       /** {@inheritDoc} */
        @Override
        public PushConnection openPush() throws TransportException {
                final String rp = getOptionReceivePack();
@@ -183,7 +181,6 @@ class TransportLocal extends Transport implements PackTransport {
                return new InternalPushConnection<>(this, rpf, null, openRepo());
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                // Resources must be established per-connection.
index 912a90a1bf073898b2c195a3cfb1e9f115908c70..bfb840d75f485c89b7f5745c880077bb2eaf1a0a 100644 (file)
@@ -251,7 +251,9 @@ public abstract class TransportProtocol {
         *            a {@link org.eclipse.jgit.transport.URIish} object.
         * @return new Transport
         * @throws org.eclipse.jgit.errors.NotSupportedException
+        *             this protocol does not support the URI.
         * @throws org.eclipse.jgit.errors.TransportException
+        *             the transport cannot open this URI.
         */
        public Transport open(URIish uri)
                        throws NotSupportedException, TransportException {
index b9feeb9c02875bce86e3d6b16f00711c296f001a..a59d352e0da5f7bc97ce6a270d51bd7c401fa569 100644 (file)
@@ -104,7 +104,6 @@ public class TransportSftp extends SshTransport implements WalkTransport {
                super(local, uri);
        }
 
-       /** {@inheritDoc} */
        @Override
        public FetchConnection openFetch() throws TransportException {
                final SftpObjectDB c = new SftpObjectDB(uri.getPath());
@@ -113,7 +112,6 @@ public class TransportSftp extends SshTransport implements WalkTransport {
                return r;
        }
 
-       /** {@inheritDoc} */
        @Override
        public PushConnection openPush() throws TransportException {
                final SftpObjectDB c = new SftpObjectDB(uri.getPath());
index c9bb89a436c43305ff9db91bc3f4aeb327205c6e..4de6ff825f546a14b50a46f123e3f3e8457fd783 100644 (file)
@@ -94,7 +94,7 @@ public class URIish implements Serializable {
        private static final long serialVersionUID = 1L;
 
        /**
-        * A pattern matching standard URI: </br>
+        * A pattern matching standard URI: <br>
         * <code>scheme "://" user_password? hostname? portnumber? path</code>
         */
        private static final Pattern FULL_URI = Pattern.compile("^" // //$NON-NLS-1$
@@ -175,6 +175,7 @@ public class URIish implements Serializable {
         * @param s
         *            a {@link java.lang.String} object.
         * @throws java.net.URISyntaxException
+        *             if {@code s} was null or couldn't be parsed
         */
        public URIish(String s) throws URISyntaxException {
                if (StringUtils.isEmptyOrNull(s)) {
@@ -477,6 +478,7 @@ public class URIish implements Serializable {
         *            the new value for path.
         * @return a new URI with the updated value.
         * @throws java.net.URISyntaxException
+        *             if URI couldn't be parsed from String
         */
        public URIish setRawPath(String n) throws URISyntaxException {
                final URIish r = new URIish(this);
@@ -551,7 +553,6 @@ public class URIish implements Serializable {
                return r;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                int hc = 0;
@@ -570,7 +571,6 @@ public class URIish implements Serializable {
                return hc;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean equals(Object obj) {
                if (!(obj instanceof URIish))
@@ -611,7 +611,6 @@ public class URIish implements Serializable {
                return format(true, false);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return format(false, false);
@@ -683,7 +682,8 @@ public class URIish implements Serializable {
        /**
         * Get the "humanish" part of the path. Some examples of a 'humanish' part
         * for a full path:
-        * <table summary="path vs humanish path" border="1">
+        * <table border="1">
+        * <caption>path vs. humanish path</caption>
         * <tr>
         * <th>Path</th>
         * <th>Humanish part</th>
index 3264f556fa2ec87f174673ea88036b1023083128..78e9110c7ce47f98807faf562306a6a2e5c2965f 100644 (file)
@@ -771,9 +771,13 @@ public class UploadPack implements Closeable {
         * its own error handling mechanism.
         *
         * @param input
+        *            input stream
         * @param output
+        *            output stream
         * @param messages
+        *            stream for messages
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void upload(InputStream input, OutputStream output,
                        @Nullable OutputStream messages) throws IOException {
@@ -2266,7 +2270,8 @@ public class UploadPack implements Closeable {
         *            request in process
         * @param allTags
         *            refs to search for annotated tags to include in the pack if
-        *            the {@link #OPTION_INCLUDE_TAG} capability was requested.
+        *            the {@link GitProtocolConstants#OPTION_INCLUDE_TAG} capability
+        *            was requested.
         * @param unshallowCommits
         *            shallow commits on the client that are now becoming unshallow
         * @param deepenNots
@@ -2327,7 +2332,8 @@ public class UploadPack implements Closeable {
         *            where to write statistics about the content of the pack.
         * @param allTags
         *            refs to search for annotated tags to include in the pack if
-        *            the {@link #OPTION_INCLUDE_TAG} capability was requested.
+        *            the {@link GitProtocolConstants#OPTION_INCLUDE_TAG} capability
+        *            was requested.
         * @param unshallowCommits
         *            shallow commits on the client that are now becoming unshallow
         * @param deepenNots
index df98d0cfd50a4cf93a89a5ca1bfda61aa6dc6904..7b052ad4a77702fae2630f2471e1b04ab456cb9b 100644 (file)
@@ -94,10 +94,12 @@ public class UserAgent {
        /**
         *
         * @param options
+        *            options
         * @param transportAgent
+        *            name of transport agent
         * @return The transport agent.
-        * @deprecated Capabilities with <key>=<value> shape are now parsed
-        *             alongside other capabilities in the ReceivePack flow.
+        * @deprecated Capabilities with &lt;key&gt;=&lt;value&gt; shape are now
+        *             parsed alongside other capabilities in the ReceivePack flow.
         */
        @Deprecated
        static String getAgent(Set<String> options, String transportAgent) {
@@ -117,9 +119,10 @@ public class UserAgent {
        /**
         *
         * @param options
+        *            options
         * @return True if the transport agent is set. False otherwise.
-        * @deprecated Capabilities with <key>=<value> shape are now parsed
-        *             alongside other capabilities in the ReceivePack flow.
+        * @deprecated Capabilities with &lt;key&gt;=&lt;value&gt; shape are now
+        *             parsed alongside other capabilities in the ReceivePack flow.
         */
        @Deprecated
        static boolean hasAgent(Set<String> options) {
index c0de42cb57845153f3e247f9e7fff925b88a4a67..da8af5a0fe1e6c1f0fb9e0f1b70e535f2a782a32 100644 (file)
@@ -48,13 +48,11 @@ public class UsernamePasswordCredentialsProvider extends CredentialsProvider {
                this.password = password;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isInteractive() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean supports(CredentialItem... items) {
                for (CredentialItem i : items) {
@@ -77,7 +75,6 @@ public class UsernamePasswordCredentialsProvider extends CredentialsProvider {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean get(URIish uri, CredentialItem... items)
                        throws UnsupportedCredentialItem {
index c8cdb5a549d20d2aa4ac3d6eb8d56652d5d2a9c3..3bfc5234ee410e33d813a6cfa602fc48ced7d697 100644 (file)
@@ -130,6 +130,7 @@ abstract class WalkEncryption {
         * EncryptionUtil.java</a>
         * <p>
         * Note: EncryptionUtil is inadequate:
+        * <ul>
         * <li>EncryptionUtil.isCipherAvailableForUse checks encryption only which
         * "always works", but in JetS3t both encryption and decryption use non-IV
         * aware algorithm parameters for all PBE specs, which breaks in case of AES
@@ -137,6 +138,7 @@ abstract class WalkEncryption {
         * JetS3t, such as PBEWithMD5AndDES and PBEWithSHAAndTwofish-CBC
         * <li>any AES based algorithms such as "PBE...With...And...AES" will not
         * work, since they need proper IV setup
+        * </ul>
         */
        static class JetS3tV2 extends WalkEncryption {
 
@@ -516,8 +518,10 @@ abstract class WalkEncryption {
         * Encryption factory.
         *
         * @param props
-        * @return instance
+        *            configuration properties
+        * @return instance this object
         * @throws GeneralSecurityException
+        *             if generic security failure occurred
         */
        static WalkEncryption instance(Properties props)
                        throws GeneralSecurityException {
index cc6c252fa19ca5bb726416ecb5a6abfab090fca4..8d89107c2be87215ce6e0ce8e2dec0160873de1d 100644 (file)
@@ -186,13 +186,11 @@ class WalkFetchConnection extends BaseFetchConnection {
                workQueue = new LinkedList<>();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean didFetchTestConnectivity() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected void doFetch(final ProgressMonitor monitor,
                        final Collection<Ref> want, final Set<ObjectId> have)
@@ -214,19 +212,16 @@ class WalkFetchConnection extends BaseFetchConnection {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public Collection<PackLock> getPackLocks() {
                return packLocks;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setPackLockMessage(String message) {
                lockMessage = message;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                inserter.close();
index a54fd8e14dde6425a3fc08ceb9ab08633a5d77fa..464017a84db03cf509dc0af717dbd1272f82b58d 100644 (file)
@@ -104,7 +104,6 @@ class WalkPushConnection extends BaseConnection implements PushConnection {
                dest = w;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void push(final ProgressMonitor monitor,
                        final Map<String, RemoteRefUpdate> refUpdates)
@@ -112,7 +111,6 @@ class WalkPushConnection extends BaseConnection implements PushConnection {
                push(monitor, refUpdates, null);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void push(final ProgressMonitor monitor,
                        final Map<String, RemoteRefUpdate> refUpdates, OutputStream out)
@@ -184,7 +182,6 @@ class WalkPushConnection extends BaseConnection implements PushConnection {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() {
                dest.close();
index 98c231a46dc648ef96f6a46bbbd3218bb100e33f..125ee6cbe9ff1aa16c03b99d8e6a4688612f5482 100644 (file)
@@ -105,6 +105,7 @@ public interface HttpConnection {
         * @see HttpURLConnection#getResponseCode()
         * @return the HTTP Status-Code, or -1
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        int getResponseCode() throws IOException;
 
@@ -122,6 +123,7 @@ public interface HttpConnection {
         * @see HttpURLConnection#getResponseMessage()
         * @return the HTTP response message, or <code>null</code>
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        String getResponseMessage() throws IOException;
 
@@ -207,14 +209,14 @@ public interface HttpConnection {
         * @exception IOException
         *                if an I/O error occurs while creating the input stream.
         * @throws java.io.IOException
-        *             if any.
+        *             if an IO error occurred
         */
        InputStream getInputStream() throws IOException;
 
        /**
         * Get header field. According to
-        * {@link <a href="https://tools.ietf.org/html/rfc2616#section-4.2">RFC
-        * 2616</a>} header field names are case insensitive. Header fields defined
+        * <a href="https://tools.ietf.org/html/rfc2616#section-4.2">RFC 2616</a>
+        * header field names are case insensitive. Header fields defined
         * as a comma separated list can have multiple header fields with the same
         * field name. This method only returns one of these header fields. If you
         * want the union of all values of all multiple header fields with the same
@@ -230,8 +232,8 @@ public interface HttpConnection {
 
        /**
         * Get all values of given header field. According to
-        * {@link <a href="https://tools.ietf.org/html/rfc2616#section-4.2">RFC
-        * 2616</a>} header field names are case insensitive. Header fields defined
+        * <a href="https://tools.ietf.org/html/rfc2616#section-4.2">RFC 2616</a>
+        * header field names are case insensitive. Header fields defined
         * as a comma separated list can have multiple header fields with the same
         * field name. This method does not validate if the given header field is
         * defined as a comma separated list.
@@ -287,6 +289,7 @@ public interface HttpConnection {
         * @see HttpURLConnection#getOutputStream()
         * @return an output stream that writes to this connection.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        OutputStream getOutputStream() throws IOException;
 
@@ -321,6 +324,7 @@ public interface HttpConnection {
         *
         * @see HttpURLConnection#connect()
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        void connect() throws IOException;
 
@@ -338,7 +342,9 @@ public interface HttpConnection {
         *            the source of randomness for this generator or null. See
         *            {@link javax.net.ssl.SSLContext#init(KeyManager[], TrustManager[], SecureRandom)}
         * @throws java.security.NoSuchAlgorithmException
+        *             if algorithm isn't available
         * @throws java.security.KeyManagementException
+        *             if key management failed
         */
        void configure(KeyManager[] km, TrustManager[] tm,
                        SecureRandom random) throws NoSuchAlgorithmException,
@@ -351,7 +357,9 @@ public interface HttpConnection {
         * @param hostnameverifier
         *            a {@link javax.net.ssl.HostnameVerifier} object.
         * @throws java.security.NoSuchAlgorithmException
+        *             if algorithm isn't available
         * @throws java.security.KeyManagementException
+        *             if key management failed
         */
        void setHostnameVerifier(HostnameVerifier hostnameverifier)
                        throws NoSuchAlgorithmException, KeyManagementException;
index bd0aa3f7ad819d2c6a9f6d9acaaacbd626e69d4b..b50eaa41862cf08635e916e129224f352a16ddbf 100644 (file)
@@ -28,6 +28,7 @@ public interface HttpConnectionFactory {
         *            a {@link java.net.URL} object.
         * @return a {@link org.eclipse.jgit.transport.http.HttpConnection}
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        HttpConnection create(URL url) throws IOException;
 
@@ -41,6 +42,7 @@ public interface HttpConnectionFactory {
         *            the proxy to be used
         * @return a {@link org.eclipse.jgit.transport.http.HttpConnection}
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        HttpConnection create(URL url, Proxy proxy)
                        throws IOException;
index 88abc60162c1c22cc743652220df7a0279cd11f0..71d5c1b6f78108cf08b5d2c300987c923ca80ef0 100644 (file)
@@ -48,7 +48,7 @@ public interface HttpConnectionFactory2 extends HttpConnectionFactory {
                 *            {@link HttpConnectionFactory} instance
                 * @param sslVerify
                 *            whether SSL is to be verified
-                * @return the configured {@connection}
+                * @return the configured {@code connection}
                 * @throws IOException
                 *             if the connection cannot be configured
                 * @throws GeneralSecurityException
index 3b0bae21ef849b678d5aa2de680126aee14f8528..8e9be1dde86ee47581f521467583e3a86ec67db9 100644 (file)
@@ -55,7 +55,9 @@ public class JDKHttpConnection implements HttpConnection {
         * @param url
         *            a {@link java.net.URL} object.
         * @throws java.net.MalformedURLException
+        *             if URL is malformed
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected JDKHttpConnection(URL url)
                        throws MalformedURLException,
@@ -71,7 +73,9 @@ public class JDKHttpConnection implements HttpConnection {
         * @param proxy
         *            a {@link java.net.Proxy} object.
         * @throws java.net.MalformedURLException
+        *             if URL is malformed
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        protected JDKHttpConnection(URL url, Proxy proxy)
                        throws MalformedURLException, IOException {
@@ -79,73 +83,61 @@ public class JDKHttpConnection implements HttpConnection {
                                .openConnection(proxy);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getResponseCode() throws IOException {
                return wrappedUrlConnection.getResponseCode();
        }
 
-       /** {@inheritDoc} */
        @Override
        public URL getURL() {
                return wrappedUrlConnection.getURL();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getResponseMessage() throws IOException {
                return wrappedUrlConnection.getResponseMessage();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Map<String, List<String>> getHeaderFields() {
                return wrappedUrlConnection.getHeaderFields();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setRequestProperty(String key, String value) {
                wrappedUrlConnection.setRequestProperty(key, value);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setRequestMethod(String method) throws ProtocolException {
                wrappedUrlConnection.setRequestMethod(method);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setUseCaches(boolean usecaches) {
                wrappedUrlConnection.setUseCaches(usecaches);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setConnectTimeout(int timeout) {
                wrappedUrlConnection.setConnectTimeout(timeout);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setReadTimeout(int timeout) {
                wrappedUrlConnection.setReadTimeout(timeout);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getContentType() {
                return wrappedUrlConnection.getContentType();
        }
 
-       /** {@inheritDoc} */
        @Override
        public InputStream getInputStream() throws IOException {
                return wrappedUrlConnection.getInputStream();
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getHeaderField(@NonNull String name) {
                return wrappedUrlConnection.getHeaderField(name);
@@ -167,68 +159,57 @@ public class JDKHttpConnection implements HttpConnection {
                return fields;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int getContentLength() {
                return wrappedUrlConnection.getContentLength();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setInstanceFollowRedirects(boolean followRedirects) {
                wrappedUrlConnection.setInstanceFollowRedirects(followRedirects);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setDoOutput(boolean dooutput) {
                wrappedUrlConnection.setDoOutput(dooutput);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setFixedLengthStreamingMode(int contentLength) {
                wrappedUrlConnection.setFixedLengthStreamingMode(contentLength);
        }
 
-       /** {@inheritDoc} */
        @Override
        public OutputStream getOutputStream() throws IOException {
                return wrappedUrlConnection.getOutputStream();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setChunkedStreamingMode(int chunklen) {
                wrappedUrlConnection.setChunkedStreamingMode(chunklen);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String getRequestMethod() {
                return wrappedUrlConnection.getRequestMethod();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean usingProxy() {
                return wrappedUrlConnection.usingProxy();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void connect() throws IOException {
                wrappedUrlConnection.connect();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void setHostnameVerifier(HostnameVerifier hostnameverifier) {
                ((HttpsURLConnection) wrappedUrlConnection)
                                .setHostnameVerifier(hostnameverifier);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void configure(KeyManager[] km, TrustManager[] tm,
                        SecureRandom random) throws NoSuchAlgorithmException,
index 046f3950494af874951af486ab51982f6f48f9be..36731a5fa6e6e92860915a2a26602ee4d6768e5b 100644 (file)
@@ -60,7 +60,6 @@ public class FileResolver<C> implements RepositoryResolver<C> {
                setExportAll(exportAll);
        }
 
-       /** {@inheritDoc} */
        @Override
        public Repository open(C req, String name)
                        throws RepositoryNotFoundException, ServiceNotEnabledException {
index 3ef5b29a5532aea7969dd2554ae033ff52375a24..65b18086b45f393b0df885577efb18ade6f6c9ba 100644 (file)
@@ -718,7 +718,6 @@ public abstract class AbstractTreeIterator {
                System.arraycopy(path, pathOffset, buffer, offset, pathLen - pathOffset);
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 5c3f6aefe1f8e5f8cd4ad7ffec905ac141362f49..c6d50d35f169f3dde3f5a6688fc74e1f6dad74c2 100644 (file)
@@ -191,7 +191,6 @@ public class CanonicalTreeParser extends AbstractTreeIterator {
                reset(reader.open(id, OBJ_TREE).getCachedBytes());
        }
 
-       /** {@inheritDoc} */
        @Override
        public CanonicalTreeParser createSubtreeIterator(final ObjectReader reader,
                        final MutableObjectId idBuffer)
@@ -227,51 +226,43 @@ public class CanonicalTreeParser extends AbstractTreeIterator {
                return p;
        }
 
-       /** {@inheritDoc} */
        @Override
        public CanonicalTreeParser createSubtreeIterator(ObjectReader reader)
                        throws IncorrectObjectTypeException, IOException {
                return createSubtreeIterator(reader, new MutableObjectId());
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasId() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public byte[] idBuffer() {
                return raw;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int idOffset() {
                return nextPtr - OBJECT_ID_LENGTH;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void reset() {
                if (!first())
                        reset(raw);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean first() {
                return currPtr == 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean eof() {
                return currPtr == raw.length;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void next(int delta) {
                if (delta == 1) {
@@ -301,7 +292,6 @@ public class CanonicalTreeParser extends AbstractTreeIterator {
                        parseEntry();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void back(int delta) {
                if (delta == 1 && 0 <= prevPtr) {
@@ -376,6 +366,7 @@ public class CanonicalTreeParser extends AbstractTreeIterator {
         * @return {@link org.eclipse.jgit.attributes.AttributesNode} for the
         *         current entry.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        public AttributesNode getEntryAttributesNode(ObjectReader reader)
index 0661c9044ae984e8959d6845678deaeb2a557125..32368dcfb803cf8fc7da4dafe0daa7f5879628cf 100644 (file)
@@ -57,75 +57,63 @@ public class EmptyTreeIterator extends AbstractTreeIterator {
                pathLen = childPathOffset - 1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public AbstractTreeIterator createSubtreeIterator(ObjectReader reader)
                        throws IncorrectObjectTypeException, IOException {
                return new EmptyTreeIterator(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasId() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public ObjectId getEntryObjectId() {
                return ObjectId.zeroId();
        }
 
-       /** {@inheritDoc} */
        @Override
        public byte[] idBuffer() {
                return zeroid;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int idOffset() {
                return 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void reset() {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean first() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean eof() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void next(int delta) throws CorruptObjectException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void back(int delta) throws CorruptObjectException {
                // Do nothing.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void stopWalk() {
                if (parent != null)
                        parent.stopWalk();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected boolean needsStopWalk() {
                return parent != null && parent.needsStopWalk();
index 60b92d7271dbea8da6f98bfa9762490340f1c87c..36fa72028e00689e137c5795f64bc526e1770c31 100644 (file)
@@ -175,7 +175,6 @@ public class FileTreeIterator extends WorkingTreeIterator {
                init(entries());
        }
 
-       /** {@inheritDoc} */
        @Override
        public AbstractTreeIterator createSubtreeIterator(ObjectReader reader)
                        throws IncorrectObjectTypeException, IOException {
@@ -425,13 +424,11 @@ public class FileTreeIterator extends WorkingTreeIterator {
                return ((FileEntry) current()).getFile();
        }
 
-       /** {@inheritDoc} */
        @Override
        protected byte[] idSubmodule(Entry e) {
                return idSubmodule(getDirectory(), e);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected String readSymlinkTarget(Entry entry) throws IOException {
                return fs.readSymLink(getEntryFile());
index ece945232ec8c8755ff4e7107b176928db21eb31..e0a8af1800b7817cdf471deed5886d8ff7700789 100644 (file)
@@ -548,7 +548,7 @@ public class TreeWalk implements AutoCloseable, AttributesProvider {
         * <p>
         * Retrieve the git attributes for the current entry.
         *
-        * <h3>Git attribute computation</h3>
+        * <h4>Git attribute computation</h4>
         *
         * <ul>
         * <li>Get the attributes matching the current path entry from the info file
@@ -563,11 +563,10 @@ public class TreeWalk implements AutoCloseable, AttributesProvider {
         * <li>In the end, completes the list of matching attributes using the
         * global attribute file define in the configuration (see
         * {@link AttributesNodeProvider#getGlobalAttributesNode()})</li>
-        *
         * </ul>
         *
         *
-        * <h3>Iterator constraints</h3>
+        * <h4>Iterator constraints</h4>
         *
         * <p>
         * In order to have a correct list of attributes for the current entry, this
@@ -960,6 +959,8 @@ public class TreeWalk implements AutoCloseable, AttributesProvider {
         * iterators to manage only one list of items, with the diving handled by
         * recursive trees.
         *
+        * @param <T>
+        *            Type of returned {@code AbstractTreeIterator}
         * @param nth
         *            tree to obtain the current iterator of.
         * @param clazz
@@ -1376,12 +1377,14 @@ public class TreeWalk implements AutoCloseable, AttributesProvider {
        }
 
        /**
-        * Returns an AbstractTreeIterator from {@code trees} with the smallest name, and sets its
-        * {@code matches} field. This may clobber {@code matches} in other {@code tree}s. Other iterators
-        * at the same name will have their {@code matches} pointing to the same {@code min()} value.
+        * Returns an AbstractTreeIterator from {@code trees} with the smallest
+        * name, and sets its {@code matches} field. This may clobber
+        * {@code matches} in other {@code tree}s. Other iterators at the same name
+        * will have their {@code matches} pointing to the same {@code min()} value.
         *
         * @return the smallest tree iterator available.
         * @throws CorruptObjectException
+        *             if an object is corrupt
         */
        @SuppressWarnings("unused")
        AbstractTreeIterator min() throws CorruptObjectException {
@@ -1488,6 +1491,7 @@ public class TreeWalk implements AutoCloseable, AttributesProvider {
         *            {{@link #getSmudgeCommand(int)} instead.
         * @return a filter command
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        public String getFilterCommand(String filterCommandType)
@@ -1521,6 +1525,7 @@ public class TreeWalk implements AutoCloseable, AttributesProvider {
         *            of the tree the item to be smudged is in
         * @return a filter command
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 6.1
         */
        public String getSmudgeCommand(int index)
@@ -1536,6 +1541,7 @@ public class TreeWalk implements AutoCloseable, AttributesProvider {
         *            to use
         * @return a filter command
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 6.1
         */
        public String getSmudgeCommand(Attributes attributes) throws IOException {
index b5d6610d52e7c0e382978afc476d6b6e9c66e616..aa544606af85d58665cb5c8ef62e622bf4e9e51c 100644 (file)
@@ -270,7 +270,6 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
                return state.walkIgnored;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean hasId() {
                if (contentIdFromPtr == ptr)
@@ -278,7 +277,6 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
                return (mode & FileMode.TYPE_MASK) == FileMode.TYPE_FILE;
        }
 
-       /** {@inheritDoc} */
        @Override
        public byte[] idBuffer() {
                if (contentIdFromPtr == ptr)
@@ -316,7 +314,6 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
                return zeroid;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isWorkTree() {
                return true;
@@ -549,13 +546,11 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
                return repository;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int idOffset() {
                return contentIdOffset;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void reset() {
                if (!first()) {
@@ -565,19 +560,16 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean first() {
                return ptr == 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean eof() {
                return ptr == entryCnt;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void next(int delta) throws CorruptObjectException {
                ptr += delta;
@@ -586,7 +578,6 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void back(int delta) throws CorruptObjectException {
                ptr -= delta;
@@ -620,6 +611,7 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
         *
         * @return size of the content, in bytes
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public long getEntryContentLength() throws IOException {
                if (canonLen == -1) {
@@ -772,6 +764,7 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
         * @return the {@link org.eclipse.jgit.attributes.AttributesNode} for the
         *         current entry.
         * @throws IOException
+        *             if an IO error occurred
         */
        public AttributesNode getEntryAttributesNode() throws IOException {
                if (attributesNode instanceof PerDirectoryAttributesNode)
@@ -964,6 +957,7 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
         *            access to repository objects if necessary. Should not be null.
         * @return true if content is most likely different.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.3
         */
        public boolean isModified(DirCacheEntry entry, boolean forceContentCheck,
@@ -1070,6 +1064,7 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
         * @return <code>true</code> if the content doesn't match,
         *         <code>false</code> if it matches
         * @throws IOException
+        *             if an IO error occurred
         */
        private boolean contentCheck(DirCacheEntry entry, ObjectReader reader)
                        throws IOException {
@@ -1450,6 +1445,7 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
         * @return the clean filter command for the current entry or
         *         <code>null</code> if no such command is defined
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        public String getCleanFilterCommand() throws IOException {
@@ -1472,6 +1468,7 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
         *         {@link org.eclipse.jgit.treewalk.TreeWalk} is not based on a
         *         {@link org.eclipse.jgit.lib.Repository} then null is returned.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.3
         */
        public EolStreamType getEolStreamType() throws IOException {
@@ -1486,6 +1483,7 @@ public abstract class WorkingTreeIterator extends AbstractTreeIterator {
         *         {@link TreeWalk} is not based on a {@link Repository} then null
         *         is returned.
         * @throws IOException
+        *             if an IO error occurred
         */
        private EolStreamType getEolStreamType(OperationType opType)
                        throws IOException {
index cafa926ffc2330264c5d32eab98e314c4fa18428..c94160144ebf001e1437166c642e80d09f2c6318 100644 (file)
@@ -39,6 +39,7 @@ class ByteArraySet {
         * Create an empty set.
         *
         * @param capacity
+        *            initial capacity of the set
         */
        ByteArraySet(int capacity) {
                initTable(1 << Integer.highestOneBit((capacity * 2) - 1));
@@ -180,7 +181,6 @@ class ByteArraySet {
                table = new byte[sz][];
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder sb = new StringBuilder();
index 4731f345bcd7796665c7859a95070dc26a5ef467..699ff6b68b293a25cef5d1cc87fe854c0f311d84 100644 (file)
@@ -106,7 +106,6 @@ public class IndexDiffFilter extends TreeFilter {
                this.honorIgnores = honorIgnores;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk tw) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
@@ -234,7 +233,6 @@ public class IndexDiffFilter extends TreeFilter {
                return tw.getTree(workingTree, WorkingTreeIterator.class);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                // We cannot compare subtrees in the working tree, so encourage
@@ -242,13 +240,11 @@ public class IndexDiffFilter extends TreeFilter {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter clone() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "INDEX_DIFF_FILTER"; //$NON-NLS-1$
index 163dc71daac78b6ff3533d31c684e56f9bcbd29f..0c0b09e7bfc200a8f522a3bc907ce4f304643f8b 100644 (file)
@@ -28,7 +28,6 @@ public final class InterIndexDiffFilter extends TreeFilter {
         */
        public static final TreeFilter INSTANCE = new InterIndexDiffFilter();
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk walker) {
                final int n = walker.getTreeCount();
@@ -57,19 +56,16 @@ public final class InterIndexDiffFilter extends TreeFilter {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter clone() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "INTERINDEX_DIFF"; //$NON-NLS-1$
index 7d04f27f3c7d63f0ff93788a398b2750c479a058..25947da08f96bee1ec1c768be5b9db67c7e1b0ae 100644 (file)
@@ -33,7 +33,6 @@ public class NotIgnoredFilter extends TreeFilter {
                this.index = workdirTreeIndex;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk tw) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
@@ -41,20 +40,17 @@ public class NotIgnoredFilter extends TreeFilter {
                return i == null || !i.isEntryIgnored();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter clone() {
                // immutable
                return this;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 4fb615321f9fd86420acff31a833672793fd1919..e9cd83c2e2b93aaa2a08a5b21b2905f53643d98e 100644 (file)
@@ -38,13 +38,11 @@ public class NotTreeFilter extends TreeFilter {
                a = one;
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter negate() {
                return a;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk walker)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -52,7 +50,6 @@ public class NotTreeFilter extends TreeFilter {
                return matchFilter(walker) == 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int matchFilter(TreeWalk walker)
                        throws MissingObjectException, IncorrectObjectTypeException,
@@ -69,20 +66,17 @@ public class NotTreeFilter extends TreeFilter {
                return -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                return a.shouldBeRecursive();
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter clone() {
                final TreeFilter n = a.clone();
                return n == a ? this : new NotTreeFilter(n);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return "NOT " + a.toString(); //$NON-NLS-1$
index c94215fcb1d849d2fe9e15769f159f46e761ace1..63e587ab244ca15c7f43dac03bf93f023501363b 100644 (file)
@@ -67,19 +67,16 @@ public class PathFilter extends TreeFilter {
                return pathStr;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk walker) {
                return matchFilter(walker) <= 0;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int matchFilter(TreeWalk walker) {
                return walker.isPathMatch(pathRaw, pathRaw.length);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                for (byte b : pathRaw)
@@ -88,13 +85,11 @@ public class PathFilter extends TreeFilter {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public PathFilter clone() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        @SuppressWarnings("nls")
        public String toString() {
index 3816d5ed000f7169febfd9fa3f4de8bcd0b1e79d..ec259032118ab8d1d59325d82e673ad9a08b0b2f 100644 (file)
@@ -56,13 +56,11 @@ public class PathSuffixFilter extends TreeFilter {
                pathRaw = Constants.encode(pathStr);
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter clone() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk walker) throws MissingObjectException,
                        IncorrectObjectTypeException, IOException {
@@ -82,7 +80,6 @@ public class PathSuffixFilter extends TreeFilter {
                return super.matchFilter(walker);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                return true;
index 1ed2ef32cdced83e8981c03e326a755f33e70fd9..e311523033ee81a63ed597e4b0ca9ff631e29cc7 100644 (file)
@@ -36,7 +36,6 @@ public class SkipWorkTreeFilter extends TreeFilter {
                this.treeIdx = treeIdx;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean include(TreeWalk walker) {
                DirCacheIterator i = walker.getTree(treeIdx, DirCacheIterator.class);
@@ -47,19 +46,16 @@ public class SkipWorkTreeFilter extends TreeFilter {
                return e == null || !e.isSkipWorkTree();
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean shouldBeRecursive() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public TreeFilter clone() {
                return this;
        }
 
-       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {
index 6dbd508e4837ab8d252c7ecb4eb2ac1f274c3089..28f2cd9461616dc2fe405b279b21ba39d76343ea 100644 (file)
@@ -220,7 +220,6 @@ public abstract class TreeFilter {
        @Override
        public abstract TreeFilter clone();
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                String n = getClass().getName();
index 527c5a69dfdabf9e71733982543063bdc0a9ef37..557e2cde3bf9de09746d09a4b59a278987d9a8e5 100644 (file)
@@ -75,13 +75,11 @@ public class BlockList<T> extends AbstractList<T> {
                tailBlock = directory[0];
        }
 
-       /** {@inheritDoc} */
        @Override
        public int size() {
                return size;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void clear() {
                for (T[] block : directory) {
@@ -94,7 +92,6 @@ public class BlockList<T> extends AbstractList<T> {
                tailBlock = directory[0];
        }
 
-       /** {@inheritDoc} */
        @Override
        public T get(int index) {
                if (index < 0 || size <= index)
@@ -102,7 +99,6 @@ public class BlockList<T> extends AbstractList<T> {
                return directory[toDirectoryIndex(index)][toBlockIndex(index)];
        }
 
-       /** {@inheritDoc} */
        @Override
        public T set(int index, T element) {
                if (index < 0 || size <= index)
@@ -160,7 +156,6 @@ public class BlockList<T> extends AbstractList<T> {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean add(T element) {
                int i = tailBlkIdx;
@@ -191,7 +186,6 @@ public class BlockList<T> extends AbstractList<T> {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void add(int index, T element) {
                if (index == size) {
@@ -213,7 +207,6 @@ public class BlockList<T> extends AbstractList<T> {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public T remove(int index) {
                if (index == size - 1) {
@@ -253,7 +246,6 @@ public class BlockList<T> extends AbstractList<T> {
                tailBlock = directory[tailDirIdx];
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<T> iterator() {
                return new MyIterator();
index 5815c62e891e07aedb38d3845358d3182d77ecaa..d8183eb8beb67a7a9429a205f5de45e2961613a3 100644 (file)
@@ -32,7 +32,6 @@ public abstract class CachedAuthenticator extends Authenticator {
                cached.add(ca);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected final PasswordAuthentication getPasswordAuthentication() {
                final String host = getRequestingHost();
index da1684630b7ec226b788ca0594c26cb8d5cef42d..ff136f7b3b9f3a84321c028ca669f6b1a97eef33 100644 (file)
@@ -13,22 +13,24 @@ package org.eclipse.jgit.util;
 /**
  * Equality utilities.
  *
- * @since: 6.2
+ * @since 6.2
  */
 public class Equality {
 
     /**
-     * Compare by reference
-     *
-     * @param a
-     *            First object to compare
-     * @param b
-     *            Second object to compare
-     * @return {@code true} if the objects are identical, {@code false}
-     *         otherwise
-     *
-     * @since 6.2
-     */
+        * Compare by reference
+        *
+        * @param <T>
+        *            type of the objects to compare
+        * @param a
+        *            First object to compare
+        * @param b
+        *            Second object to compare
+        * @return {@code true} if the objects are identical, {@code false}
+        *         otherwise
+        *
+        * @since 6.2
+        */
     @SuppressWarnings("ReferenceEquality")
     public static <T> boolean isSameInstance(T a, T b) {
         return a == b;
index aef9e64e024645d4708d5c3bfb708f74e3fd83d2..f504c66eb3528284fa56b310056d31613460f013 100644 (file)
@@ -118,6 +118,7 @@ public abstract class FS {
                 * Detect the file system
                 *
                 * @param cygwinUsed
+                *            whether cygwin is used
                 * @return FS instance
                 */
                public FS detect(Boolean cygwinUsed) {
@@ -149,8 +150,11 @@ public abstract class FS {
 
                /**
                 * @param stdout
+                *            stdout stream
                 * @param stderr
+                *            stderr stream
                 * @param rc
+                *            return code
                 */
                public ExecutionResult(TemporaryBuffer stdout, TemporaryBuffer stderr,
                                int rc) {
@@ -849,6 +853,7 @@ public abstract class FS {
                 * timestamp resolution
                 *
                 * @param fsTimestampResolution
+                *            resolution of filesystem timestamps
                 */
                public FileStoreAttributes(
                                @NonNull Duration fsTimestampResolution) {
@@ -1074,6 +1079,7 @@ public abstract class FS {
         *            a {@link java.io.File} object.
         * @return last modified time of f
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         * @deprecated use {@link #lastModifiedInstant(Path)} instead
         */
@@ -1120,6 +1126,7 @@ public abstract class FS {
         * @param time
         *            last modified time
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         * @deprecated use {@link #setLastModified(Path, Instant)} instead
         */
@@ -1138,6 +1145,7 @@ public abstract class FS {
         * @param time
         *            last modified time
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 5.1.9
         */
        public void setLastModified(Path p, Instant time) throws IOException {
@@ -1152,6 +1160,7 @@ public abstract class FS {
         *            a {@link java.io.File} object.
         * @return length of a file
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         */
        public long length(File path) throws IOException {
@@ -1164,7 +1173,7 @@ public abstract class FS {
         * @param f
         *            a {@link java.io.File} object.
         * @throws java.io.IOException
-        *             this may be a Java7 subclass with detailed information
+        *             if an IO error occurred
         * @since 3.3
         */
        public void delete(File f) throws IOException {
@@ -1264,8 +1273,10 @@ public abstract class FS {
         * Return all the attributes of a file, without following symbolic links.
         *
         * @param file
+        *            the file
         * @return {@link BasicFileAttributes} of the file
-        * @throws IOException in case of any I/O errors accessing the file
+        * @throws IOException
+        *             in case of any I/O errors accessing the file
         *
         * @since 4.5.6
         */
@@ -1671,6 +1682,7 @@ public abstract class FS {
         *            a {@link java.io.File} object.
         * @return target of link or null
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         */
        public String readSymLink(File path) throws IOException {
@@ -1684,6 +1696,7 @@ public abstract class FS {
         *            a {@link java.io.File} object.
         * @return true if the path is a symbolic link (and we support these)
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         */
        public boolean isSymLink(File path) throws IOException {
@@ -1738,6 +1751,7 @@ public abstract class FS {
         * @return true if path is hidden, either starts with . on unix or has the
         *         hidden attribute in windows
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         */
        public boolean isHidden(File path) throws IOException {
@@ -1752,6 +1766,7 @@ public abstract class FS {
         * @param hidden
         *            whether to set the file hidden
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         */
        public void setHidden(File path, boolean hidden) throws IOException {
@@ -1766,6 +1781,7 @@ public abstract class FS {
         * @param target
         *            target path of the symlink
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         */
        public void createSymLink(File path, String target) throws IOException {
@@ -1782,6 +1798,7 @@ public abstract class FS {
         * @return <code>true</code> if the file was created, <code>false</code> if
         *         the file already existed
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @deprecated use {@link #createNewFileAtomic(File)} instead
         * @since 4.5
         */
@@ -1852,6 +1869,7 @@ public abstract class FS {
         * @return LockToken this token must be closed after the created file was
         *         deleted
         * @throws IOException
+        *             if an IO error occurred
         * @since 4.7
         */
        public LockToken createNewFileAtomic(File path) throws IOException {
@@ -2317,7 +2335,9 @@ public abstract class FS {
         *            The standard input stream passed to the process
         * @return The result of the executed command
         * @throws java.lang.InterruptedException
+        *             if thread was interrupted
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        public ExecutionResult execute(ProcessBuilder pb, InputStream in)
@@ -2441,8 +2461,10 @@ public abstract class FS {
                 * Constructor when there are issues with reading. All attributes except
                 * given will be set to the default values.
                 *
-                * @param fs
                 * @param path
+                *            file path
+                * @param fs
+                *            FS to use
                 */
                public Attributes(File path, FS fs) {
                        this(fs, path, false, false, false, false, false, 0L, EPOCH, 0L);
index 1c113617f85087b9744ecfd955d38de84852f7de..6f31847996894c8206ab80b16f67d2d9df15182c 100644 (file)
@@ -418,6 +418,7 @@ public class FS_POSIX extends FS {
         * @return LockToken this lock token must be held until the file is no
         *         longer needed
         * @throws IOException
+        *             if an IO error occurred
         * @since 5.0
         */
        @Override
index ae73d3feb888979678363bf52726eda999be0596..5926655b7b0665253d1b1e46e23d46614762e455 100644 (file)
@@ -58,43 +58,36 @@ public class FS_Win32 extends FS {
                super(src);
        }
 
-       /** {@inheritDoc} */
        @Override
        public FS newInstance() {
                return new FS_Win32(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean supportsExecute() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean canExecute(File f) {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean setExecute(File f, boolean canExec) {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isCaseSensitive() {
                return false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean retryFailedLockFileCommit() {
                return true;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Entry[] list(File directory, FileModeStrategy fileModeStrategy) {
                if (!Files.isDirectory(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) {
@@ -140,7 +133,6 @@ public class FS_Win32 extends FS {
                return result.toArray(new Entry[0]);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected File discoverGitExe() {
                String path = SystemReader.getInstance().getenv("PATH"); //$NON-NLS-1$
@@ -171,7 +163,6 @@ public class FS_Win32 extends FS {
                return gitExe;
        }
 
-       /** {@inheritDoc} */
        @Override
        protected File userHomeImpl() {
                String home = SystemReader.getInstance().getenv("HOME"); //$NON-NLS-1$
@@ -194,7 +185,6 @@ public class FS_Win32 extends FS {
                return super.userHomeImpl();
        }
 
-       /** {@inheritDoc} */
        @Override
        public ProcessBuilder runInShell(String cmd, String[] args) {
                List<String> argv = new ArrayList<>(3 + args.length);
@@ -207,7 +197,6 @@ public class FS_Win32 extends FS {
                return proc;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Attributes getAttributes(File path) {
                return FileUtils.getFileAttributesBasic(this, path);
index add5498175c1208e229e1a23910f74919256083a..635351ac844bc74096d0c4ba2bf84bd717e47fac 100644 (file)
@@ -72,13 +72,11 @@ public class FS_Win32_Cygwin extends FS_Win32 {
                super(src);
        }
 
-       /** {@inheritDoc} */
        @Override
        public FS newInstance() {
                return new FS_Win32_Cygwin(this);
        }
 
-       /** {@inheritDoc} */
        @Override
        public File resolve(File dir, String pn) {
                String useCygPath = System.getProperty("jgit.usecygpath"); //$NON-NLS-1$
@@ -99,7 +97,6 @@ public class FS_Win32_Cygwin extends FS_Win32 {
                return super.resolve(dir, pn);
        }
 
-       /** {@inheritDoc} */
        @Override
        protected File userHomeImpl() {
                final String home = AccessController.doPrivileged(
@@ -110,7 +107,6 @@ public class FS_Win32_Cygwin extends FS_Win32 {
                return resolve(new File("."), home); //$NON-NLS-1$
        }
 
-       /** {@inheritDoc} */
        @Override
        public ProcessBuilder runInShell(String cmd, String[] args) {
                List<String> argv = new ArrayList<>(4 + args.length);
@@ -129,14 +125,12 @@ public class FS_Win32_Cygwin extends FS_Win32 {
                return QuotedString.BOURNE.quote(cmd.replace(File.separatorChar, '/'));
        }
 
-       /** {@inheritDoc} */
        @Override
        public String relativize(String base, String other) {
                final String relativized = super.relativize(base, other);
                return relativized.replace(File.separatorChar, '/');
        }
 
-       /** {@inheritDoc} */
        @Override
        public ProcessResult runHookIfPresent(Repository repository, String hookName,
                        String[] args, OutputStream outRedirect, OutputStream errRedirect,
index f013e7e095d9d445e78536a8dac3d000d857b1bc..9d052d13fafc25b617431d809b2cfa9c33aed2c9 100644 (file)
@@ -288,6 +288,7 @@ public class FileUtils {
         * @throws java.nio.file.AtomicMoveNotSupportedException
         *             if file cannot be moved as an atomic file system operation
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.1
         */
        public static void rename(final File src, final File dst,
@@ -446,6 +447,7 @@ public class FileUtils {
         *            the target of the symbolic link
         * @return the path to the symbolic link
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.2
         */
        public static Path createSymLink(File path, String target)
@@ -474,6 +476,7 @@ public class FileUtils {
         *            a {@link java.io.File} object.
         * @return target path of the symlink, or null if it is not a symbolic link
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.0
         */
        public static String readSymLink(File path) throws IOException {
@@ -499,6 +502,7 @@ public class FileUtils {
         *            The parent dir, can be null to use system default temp dir.
         * @return the temp dir created.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 3.4
         */
        public static File createTempDir(String prefix, String suffix, File dir)
@@ -749,7 +753,10 @@ public class FileUtils {
        }
 
        /**
+        * Check if file is a symlink
+        *
         * @param file
+        *            the file to be checked if it is a symbolic link
         * @return {@code true} if the passed file is a symbolic link
         */
        static boolean isSymlink(File file) {
@@ -757,10 +764,14 @@ public class FileUtils {
        }
 
        /**
+        * Get the lastModified attribute for a given file
+        *
         * @param file
+        *            the file
         * @return lastModified attribute for given file, not following symbolic
         *         links
         * @throws IOException
+        *             if an IO error occurred
         * @deprecated use {@link #lastModifiedInstant(Path)} instead which returns
         *             FileTime
         */
@@ -771,7 +782,10 @@ public class FileUtils {
        }
 
        /**
+        * Get last modified timestamp of a file
+        *
         * @param path
+        *            file path
         * @return lastModified attribute for given file, not following symbolic
         *         links
         */
@@ -795,8 +809,10 @@ public class FileUtils {
         * Return all the attributes of a file, without following symbolic links.
         *
         * @param file
+        *            the file
         * @return {@link BasicFileAttributes} of the file
-        * @throws IOException in case of any I/O errors accessing the file
+        * @throws IOException
+        *             in case of any I/O errors accessing the file
         *
         * @since 4.5.6
         */
@@ -808,8 +824,11 @@ public class FileUtils {
         * Set the last modified time of a file system object.
         *
         * @param file
+        *            the file
         * @param time
+        *            last modified timestamp
         * @throws IOException
+        *             if an IO error occurred
         */
        @Deprecated
        static void setLastModified(File file, long time) throws IOException {
@@ -820,8 +839,11 @@ public class FileUtils {
         * Set the last modified time of a file system object.
         *
         * @param path
+        *            file path
         * @param time
+        *            last modified timestamp of the file
         * @throws IOException
+        *             if an IO error occurred
         */
        static void setLastModified(Path path, Instant time)
                        throws IOException {
@@ -830,6 +852,7 @@ public class FileUtils {
 
        /**
         * @param file
+        *            the file
         * @return {@code true} if the given file exists, not following symbolic
         *         links
         */
@@ -838,9 +861,13 @@ public class FileUtils {
        }
 
        /**
+        * Check if file is hidden (on Windows)
+        *
         * @param file
+        *            the file
         * @return {@code true} if the given file is hidden
         * @throws IOException
+        *             if an IO error occurred
         */
        static boolean isHidden(File file) throws IOException {
                return Files.isHidden(toPath(file));
@@ -854,6 +881,7 @@ public class FileUtils {
         * @param hidden
         *            a boolean.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.1
         */
        public static void setHidden(File file, boolean hidden) throws IOException {
@@ -868,6 +896,7 @@ public class FileUtils {
         *            a {@link java.io.File}.
         * @return length of the given file
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.1
         */
        public static long getLength(File file) throws IOException {
@@ -879,7 +908,10 @@ public class FileUtils {
        }
 
        /**
+        * Check if file is directory
+        *
         * @param file
+        *            the file
         * @return {@code true} if the given file is a directory, not following
         *         symbolic links
         */
@@ -888,7 +920,10 @@ public class FileUtils {
        }
 
        /**
+        * Check if File is a file
+        *
         * @param file
+        *            the file
         * @return {@code true} if the given file is a file, not following symbolic
         *         links
         */
@@ -930,7 +965,9 @@ public class FileUtils {
 
        /**
         * @param fs
+        *            a {@link org.eclipse.jgit.util.FS} object.
         * @param file
+        *            the file
         * @return non null attributes object
         */
        static Attributes getFileAttributesBasic(FS fs, File file) {
@@ -1079,6 +1116,7 @@ public class FileUtils {
         * @param f
         *            the file to touch
         * @throws IOException
+        *             if an IO error occurred
         * @since 5.1.8
         */
        public static void touch(Path f) throws IOException {
index e3ba606346ad128411ead648ca68509181c054be..1942342c45af6f254096f7244319590223ba760f 100644 (file)
@@ -321,6 +321,7 @@ public class HttpSupport {
         *            a {@link org.eclipse.jgit.transport.http.HttpConnection}
         *            object.
         * @throws java.io.IOException
+        *             if an IO error occurred
         * @since 4.3
         */
        public static void disableSslVerify(HttpConnection conn)
@@ -346,7 +347,9 @@ public class HttpSupport {
         * that have all available protocols enabled already, up to the one
         * specified.
         * <p>
+        * <br>
         * <table>
+        * <caption>TLS versions</caption>
         * <tr>
         * <td>SSLContext.getInstance()</td>
         * <td>OpenJDK</td>
@@ -354,16 +357,16 @@ public class HttpSupport {
         * </tr>
         * <tr>
         * <td>"TLS"</td>
-        * <td>Supported: TLSv1, TLSV1.1, TLSv1.2 (+ TLSv1.3)<br />
+        * <td>Supported: TLSv1, TLSV1.1, TLSv1.2 (+ TLSv1.3)<br>
         * Enabled: TLSv1, TLSV1.1, TLSv1.2 (+ TLSv1.3)</td>
-        * <td>Supported: TLSv1, TLSV1.1, TLSv1.2<br />
+        * <td>Supported: TLSv1, TLSV1.1, TLSv1.2<br>
         * Enabled: TLSv1</td>
         * </tr>
         * <tr>
         * <td>"TLSv1.2"</td>
-        * <td>Supported: TLSv1, TLSV1.1, TLSv1.2<br />
+        * <td>Supported: TLSv1, TLSV1.1, TLSv1.2<br>
         * Enabled: TLSv1, TLSV1.1, TLSv1.2</td>
-        * <td>Supported: TLSv1, TLSV1.1, TLSv1.2<br />
+        * <td>Supported: TLSv1, TLSV1.1, TLSv1.2<br>
         * Enabled: TLSv1.2</td>
         * </tr>
         * </table>
index 635dd6a1ccee6a5d32f0d14a6cc9ea4450af5a96..6a5190c6a2f713c55c94dd2d4dc7f6ea978f3217 100644 (file)
@@ -204,7 +204,6 @@ public class IntList {
                entries = n;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder r = new StringBuilder();
@@ -232,8 +231,8 @@ public class IntList {
                 *            the first int to compare
                 * @param second
                 *            the second int to compare
-                * @return a negative number if first < second, 0 if first == second, or
-                *         a positive number if first > second
+                * @return a negative number if first &lt; second, 0 if first == second, or
+                *         a positive number if first &gt; second
                 */
                int compare(int first, int second);
        }
index 7456c71f5ff35c3de862acaea72558ca6a8118a3..d0b7b9fd2bf3d92d5029f7ec4572defec41c6bdb 100644 (file)
@@ -105,6 +105,7 @@ public class LfsFactory {
         * @return a loader for the actual data of a blob, or the original loader in
         *         case LFS is not applicable.
         * @throws IOException
+        *             if an IO error occurred
         */
        public ObjectLoader applySmudgeFilter(Repository db,
                        ObjectLoader loader, Attribute attribute) throws IOException {
@@ -117,6 +118,7 @@ public class LfsFactory {
         * @param repo
         *            the {@link Repository} the hook is applied to.
         * @param outputStream
+        *            output stream
         * @return a {@link PrePushHook} implementation or <code>null</code>
         */
        @Nullable
@@ -131,7 +133,9 @@ public class LfsFactory {
         * @param repo
         *            the {@link Repository} the hook is applied to.
         * @param outputStream
+        *            output stream
         * @param errorStream
+        *            error stream
         * @return a {@link PrePushHook} implementation or <code>null</code>
         * @since 5.6
         */
index b2bdfc1fd7d8a33d336ae84e72dbf8248ab03518..47f38f4627b1f2cc98c3ee05188c6bf2289100de 100644 (file)
@@ -140,7 +140,6 @@ public class LongList {
                entries = n;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final StringBuilder r = new StringBuilder();
index 3de7a1587c7ea8792ae15c037c1529752ce03ea1..be4bd9e35624013cc0cd5dd486a8b8fe1b70eef5 100644 (file)
@@ -41,25 +41,21 @@ public final class RawCharSequence implements CharSequence {
                endPtr = end;
        }
 
-       /** {@inheritDoc} */
        @Override
        public char charAt(int index) {
                return (char) (buffer[startPtr + index] & 0xff);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int length() {
                return endPtr - startPtr;
        }
 
-       /** {@inheritDoc} */
        @Override
        public CharSequence subSequence(int start, int end) {
                return new RawCharSequence(buffer, startPtr + start, startPtr + end);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                final int n = length();
index 57464f3c410f7cbcf5898ed4e5f4de168915de13..04fdcd0fa49f4f6c64f09d328e97ed9e7a530231 100644 (file)
@@ -98,7 +98,6 @@ public class RawSubStringPattern {
                return needleString;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return pattern();
index 462bab081a269967d0d7130d00c1b8fb8d1c1f04..2a287cfe78a544ebef434da862b2ce6807844ebf 100644 (file)
@@ -43,6 +43,8 @@ public class RefList<T extends Ref> implements Iterable<Ref> {
        /**
         * Create an empty unmodifiable reference list.
         *
+        * @param <T>
+        *            type of reference being stored.
         * @return an empty unmodifiable reference list.
         */
        @SuppressWarnings("unchecked")
@@ -70,7 +72,6 @@ public class RefList<T extends Ref> implements Iterable<Ref> {
                this.cnt = src.cnt;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Iterator<Ref> iterator() {
                return new Iterator<>() {
@@ -286,7 +287,6 @@ public class RefList<T extends Ref> implements Iterable<Ref> {
                return add(idx, ref);
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder r = new StringBuilder();
@@ -305,6 +305,8 @@ public class RefList<T extends Ref> implements Iterable<Ref> {
        /**
         * Create a {@link Collector} for {@link Ref}.
         *
+        * @param <T>
+        *            type of reference being stored.
         * @param mergeFunction
         *            if specified the result will be sorted and deduped.
         * @return {@link Collector} for {@link Ref}
@@ -390,6 +392,7 @@ public class RefList<T extends Ref> implements Iterable<Ref> {
                 * after additions are complete using {@link #sort()}.
                 *
                 * @param ref
+                *            reference to add
                 */
                public void add(T ref) {
                        if (list.length == size) {
@@ -404,6 +407,7 @@ public class RefList<T extends Ref> implements Iterable<Ref> {
                 * Add all items from another builder.
                 *
                 * @param other
+                *            another builder
                 * @since 5.4
                 */
                public void addAll(Builder other) {
@@ -454,6 +458,7 @@ public class RefList<T extends Ref> implements Iterable<Ref> {
                 * Dedupe the refs in place. Must be called after {@link #sort}.
                 *
                 * @param mergeFunction
+                *            function used for de-duplication
                 */
                @SuppressWarnings("unchecked")
                void dedupe(BinaryOperator<T> mergeFunction) {
index c68a76cef4cf16c95f94711677b6f4ded2ae258c..a4d1fd5b70453a48b6997e0bd5faa029b1a11146 100644 (file)
@@ -119,13 +119,11 @@ public class RefMap extends AbstractMap<String, Ref> {
                this.resolved = (RefList<Ref>) resolved;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean containsKey(Object name) {
                return get(name) != null;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref get(Object key) {
                String name = toRefName((String) key);
@@ -137,7 +135,6 @@ public class RefMap extends AbstractMap<String, Ref> {
                return ref;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref put(String keyName, Ref value) {
                String name = toRefName(keyName);
@@ -165,7 +162,6 @@ public class RefMap extends AbstractMap<String, Ref> {
                return prior;
        }
 
-       /** {@inheritDoc} */
        @Override
        public Ref remove(Object key) {
                String name = toRefName((String) key);
@@ -189,13 +185,11 @@ public class RefMap extends AbstractMap<String, Ref> {
                return res;
        }
 
-       /** {@inheritDoc} */
        @Override
        public boolean isEmpty() {
                return entrySet().isEmpty();
        }
 
-       /** {@inheritDoc} */
        @Override
        public Set<Entry<String, Ref>> entrySet() {
                if (entrySet == null) {
@@ -238,7 +232,6 @@ public class RefMap extends AbstractMap<String, Ref> {
                return entrySet;
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                StringBuilder r = new StringBuilder();
@@ -259,6 +252,7 @@ public class RefMap extends AbstractMap<String, Ref> {
         * Create a {@link Collector} for {@link Ref}.
         *
         * @param mergeFunction
+        *            merge function
         * @return {@link Collector} for {@link Ref}
         * @since 5.4
         */
index e29704158d1601eac6d841004746704e1cf2e358..42a76b5b16f37bd0e96eb2980d4f1d8d9312f094 100644 (file)
@@ -48,6 +48,7 @@ public class SshSupport {
         *            cases.
         * @return The entire output read from stdout.
         * @throws IOException
+        *             if an IO error occurred
         * @throws CommandFailedException
         *             if the ssh command execution failed, error message contains
         *             the content of stderr.
index 917add3609e15038f857a2099358bfb38b7cc886..274706042baae4e026d11f91f82492c83150aff7 100644 (file)
@@ -181,9 +181,9 @@ public final class StringUtils {
         *
         * @param stringValue
         *            the string to parse.
-        * @return the boolean interpretation of {@code value}.
+        * @return the boolean interpretation of {@code stringValue}.
         * @throws java.lang.IllegalArgumentException
-        *             if {@code value} is not recognized as one of the standard
+        *             if {@code stringValue} is not recognized as one of the standard
         *             boolean names.
         */
        public static boolean toBoolean(String stringValue) {
@@ -346,7 +346,7 @@ public final class StringUtils {
         *            allow negative numbers, too
         * @return the value parsed
         * @throws NumberFormatException
-        *             if the {@value} is not parseable, or beyond the range of
+        *             if the {@code value} is not parseable, or beyond the range of
         *             {@link Long}
         * @throws StringIndexOutOfBoundsException
         *             if the string is empty or contains only whitespace, or
@@ -420,7 +420,7 @@ public final class StringUtils {
         *            allow negative numbers, too
         * @return the value parsed
         * @throws NumberFormatException
-        *             if the {@value} is not parseable or beyond the range of
+        *             if the {@code value} is not parseable or beyond the range of
         *             {@link Integer}
         * @throws StringIndexOutOfBoundsException
         *             if the string is empty or contains only whitespace, or
index cedb1598277c30a970989edf228c991d1a43a6ae..ccc19691b165d4ee707e239837f8ee64f2ec617e 100644 (file)
@@ -57,14 +57,12 @@ public class AutoCRLFInputStream extends InputStream {
                this.detectBinary = detectBinary;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                final int read = read(single, 0, 1);
                return read == 1 ? single[0] & 0xff : -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] bs, int off, int len) throws IOException {
                if (len == 0)
@@ -103,7 +101,6 @@ public class AutoCRLFInputStream extends InputStream {
                return n;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                in.close();
index 305ccbd7e69cd0bcb970d6422b81d419c1b52d01..9fb316f28d0b7021542615ca8d1f7cc0f7ba56b4 100644 (file)
@@ -65,14 +65,12 @@ public class AutoCRLFOutputStream extends OutputStream {
                this.detectBinary = detectBinary;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                onebytebuf[0] = (byte) b;
                write(onebytebuf, 0, 1);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b) throws IOException {
                int overflow = buffer(b, 0, b.length);
@@ -80,7 +78,6 @@ public class AutoCRLFOutputStream extends OutputStream {
                        write(b, b.length - overflow, overflow);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b, int startOff, int startLen)
                        throws IOException {
@@ -151,7 +148,6 @@ public class AutoCRLFOutputStream extends OutputStream {
                write(binbuf, 0, cachedLen);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                if (binbufcnt <= binbuf.length) {
@@ -161,7 +157,6 @@ public class AutoCRLFOutputStream extends OutputStream {
                out.flush();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                flush();
index 7db882c0741b4fd4768ae6a6fdd288a67684370f..2385865674bc2bf08252a467071b6a926da95f66 100644 (file)
@@ -185,14 +185,12 @@ public class AutoLFInputStream extends InputStream {
                this.forCheckout = false;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                final int read = read(single, 0, 1);
                return read == 1 ? single[0] & 0xff : -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] bs, int off, int len)
                        throws IOException {
@@ -242,7 +240,6 @@ public class AutoLFInputStream extends InputStream {
                return isBinary;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                in.close();
index a0e9fb68c535777703314d75530a91af3c4266ef..e56991d43a0e880f7a515de46485fdd6d5bfe6bc 100644 (file)
@@ -69,14 +69,12 @@ public class AutoLFOutputStream extends OutputStream {
                this.detectBinary = detectBinary;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                onebytebuf[0] = (byte) b;
                write(onebytebuf, 0, 1);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b) throws IOException {
                int overflow = buffer(b, 0, b.length);
@@ -85,7 +83,6 @@ public class AutoLFOutputStream extends OutputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] b, int startOff, int startLen)
                        throws IOException {
@@ -164,7 +161,6 @@ public class AutoLFOutputStream extends OutputStream {
                write(binbuf, 0, cachedLen);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                if (binbufcnt <= binbuf.length) {
@@ -173,7 +169,6 @@ public class AutoLFOutputStream extends OutputStream {
                out.flush();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                flush();
index 782f3f4ca63f115e793188c2dd2e181397784db1..d0049d29def3bbcb6d7afa4147771be4cb104fe0 100644 (file)
@@ -39,27 +39,23 @@ public class CountingOutputStream extends OutputStream {
                return cnt;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int val) throws IOException {
                out.write(val);
                cnt++;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] buf, int off, int len) throws IOException {
                out.write(buf, off, len);
                cnt += len;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                out.flush();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                out.close();
index f1bfbe29a55e6f339b4b04f0d027fda3da2bbf95..03c25bb7026088cb3ba0e14c7d57a57f0fc52caa 100644 (file)
@@ -27,7 +27,6 @@ public final class DisabledOutputStream extends OutputStream {
                // more than one instance from being created.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                // We shouldn't be writing output at this stage, there
index 2bbdbefd38998390e2e860cc7d84c4d64ae10c6e..1faf6ea9aa040e3ff7a9f784df3cca23bd7f30c4 100644 (file)
@@ -58,13 +58,11 @@ public class IsolatedOutputStream extends OutputStream {
                                new ArrayBlockingQueue<>(1), new NamedThreadFactory());
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int ch) throws IOException {
                write(new byte[] { (byte) ch }, 0, 1);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] buf, int pos, int cnt)
                        throws IOException {
@@ -75,7 +73,6 @@ public class IsolatedOutputStream extends OutputStream {
                });
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                checkClosed();
@@ -85,7 +82,6 @@ public class IsolatedOutputStream extends OutputStream {
                });
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                if (!copier.isShutdown()) {
index 88006242d9e27314bb4c915c6d7645d69811aa00..681a52988eb621dd5fe500295cb65e9531097275 100644 (file)
@@ -47,21 +47,18 @@ public abstract class LimitedInputStream extends FilterInputStream {
                this.limit = limit;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int available() throws IOException {
                return (int) Math.min(in.available(), left);
        }
 
        // it's okay to mark even if mark isn't supported, as reset won't work
-       /** {@inheritDoc} */
        @Override
        public synchronized void mark(int readLimit) {
                in.mark(readLimit);
                mark = left;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                if (left == 0) {
@@ -78,7 +75,6 @@ public abstract class LimitedInputStream extends FilterInputStream {
                return result;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] b, int off, int len) throws IOException {
                if (left == 0) {
@@ -96,7 +92,6 @@ public abstract class LimitedInputStream extends FilterInputStream {
                return result;
        }
 
-       /** {@inheritDoc} */
        @Override
        public synchronized void reset() throws IOException {
                if (!in.markSupported())
@@ -109,7 +104,6 @@ public abstract class LimitedInputStream extends FilterInputStream {
                left = mark;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long skip(long n) throws IOException {
                n = Math.min(n, left);
index 2637766153ebf513ca102d6762a662d02fd28d03..8d5b8fdcbaf1678d589526bb4e8ae894275b58c0 100644 (file)
@@ -51,7 +51,6 @@ public class MessageWriter extends Writer {
                enc = new OutputStreamWriter(getRawStream(), UTF_8);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(char[] cbuf, int off, int len) throws IOException {
                synchronized (buf) {
@@ -71,20 +70,17 @@ public class MessageWriter extends Writer {
                return buf;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                // Do nothing, we are buffered with no resources.
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                // Do nothing, we are buffered with no resources.
        }
 
        /** @return string version of all buffered data. */
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return RawParseUtils.decode(buf.toByteArray());
index c0724e43f22bcc9efff9f059a1c7e87f0b042dff..ed412fa6f5ed07969d0568466b98531a96b42bcf 100644 (file)
@@ -67,7 +67,6 @@ public class StreamCopyThread extends Thread {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void run() {
                try {
index 56d0169f7dbd3c188a2a30c266a93c2fb89cc0d7..96376bfc6a130d9ada06a653347a9b91b4c9a684 100644 (file)
@@ -46,7 +46,6 @@ public class TeeInputStream extends InputStream {
                this.dst = dst;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                byte[] b = skipBuffer();
@@ -54,7 +53,6 @@ public class TeeInputStream extends InputStream {
                return n == 1 ? b[0] & 0xff : -1;
        }
 
-       /** {@inheritDoc} */
        @Override
        public long skip(long count) throws IOException {
                long skipped = 0;
@@ -71,7 +69,6 @@ public class TeeInputStream extends InputStream {
                return skipped;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] b, int off, int len) throws IOException {
                if (len == 0)
@@ -83,7 +80,6 @@ public class TeeInputStream extends InputStream {
                return n;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                byte[] b = skipBuffer();
index e6fdd709b2ac41b3dc6cd68f638765dc8a4ce95e..ab084a66f2f02236eda11e90d07e089bdb240a2b 100644 (file)
@@ -34,35 +34,30 @@ public class TeeOutputStream extends OutputStream {
                this.stream2 = stream2;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] buf) throws IOException {
                this.stream1.write(buf);
                this.stream2.write(buf);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] buf, int off, int len) throws IOException {
                this.stream1.write(buf, off, len);
                this.stream2.write(buf, off, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                this.stream1.write(b);
                this.stream2.write(b);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                this.stream1.flush();
                this.stream2.flush();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                try {
index 3bc92d5bcd7c1711c6503509a199c2349b31bf12..4764676c88c6b9d4f85107c93a68d45a0bf7d9f5 100644 (file)
@@ -41,19 +41,16 @@ public class ThrowingPrintWriter extends Writer {
                                );
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(char[] cbuf, int off, int len) throws IOException {
                out.write(cbuf, off, len);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                out.flush();
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                out.close();
@@ -62,8 +59,10 @@ public class ThrowingPrintWriter extends Writer {
        /**
         * Print a string and terminate with a line feed.
         *
-        * @param s a {@link java.lang.String} object.
+        * @param s
+        *            a {@link java.lang.String} object.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void println(String s) throws IOException {
                print(s + LF);
@@ -73,6 +72,7 @@ public class ThrowingPrintWriter extends Writer {
         * Print a platform dependent new line
         *
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void println() throws IOException {
                print(LF);
@@ -81,8 +81,10 @@ public class ThrowingPrintWriter extends Writer {
        /**
         * Print a char
         *
-        * @param value a char.
+        * @param value
+        *            a char.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void print(char value) throws IOException {
                print(String.valueOf(value));
@@ -94,6 +96,7 @@ public class ThrowingPrintWriter extends Writer {
         * @param value
         *            an int.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void print(int value) throws IOException {
                print(String.valueOf(value));
@@ -102,8 +105,10 @@ public class ThrowingPrintWriter extends Writer {
        /**
         * Print a long as string
         *
-        * @param value a long.
+        * @param value
+        *            a long.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void print(long value) throws IOException {
                print(String.valueOf(value));
@@ -112,8 +117,10 @@ public class ThrowingPrintWriter extends Writer {
        /**
         * Print a short as string
         *
-        * @param value a short.
+        * @param value
+        *            a short.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void print(short value) throws IOException {
                print(String.valueOf(value));
@@ -128,6 +135,7 @@ public class ThrowingPrintWriter extends Writer {
         * @param args
         *            objects.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void format(String fmt, Object... args) throws IOException {
                print(String.format(fmt, args));
@@ -139,6 +147,7 @@ public class ThrowingPrintWriter extends Writer {
         * @param any
         *            an object.
         * @throws java.io.IOException
+        *             if an IO error occurred
         */
        public void print(Object any) throws IOException {
                out.write(String.valueOf(any));
index 1947b3bf04d9ac591adbdc2f7df2392a748f4bfb..4d9f83d233cefe7618cd88e3b6d73abfda9c336e 100644 (file)
@@ -63,7 +63,6 @@ public class TimeoutInputStream extends FilterInputStream {
                timeout = millis;
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                try {
@@ -76,13 +75,11 @@ public class TimeoutInputStream extends FilterInputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] buf) throws IOException {
                return read(buf, 0, buf.length);
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] buf, int off, int cnt) throws IOException {
                try {
@@ -95,7 +92,6 @@ public class TimeoutInputStream extends FilterInputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public long skip(long cnt) throws IOException {
                try {
index 3fbf6ffdcb44daaff518826a1df5f217ef010964..afd798a1a28f76acd656b3667e6070f3a6faad44 100644 (file)
@@ -65,7 +65,6 @@ public class TimeoutOutputStream extends OutputStream {
                timeout = millis;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(int b) throws IOException {
                try {
@@ -78,13 +77,11 @@ public class TimeoutOutputStream extends OutputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] buf) throws IOException {
                write(buf, 0, buf.length);
        }
 
-       /** {@inheritDoc} */
        @Override
        public void write(byte[] buf, int off, int len) throws IOException {
                try {
@@ -97,7 +94,6 @@ public class TimeoutOutputStream extends OutputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void flush() throws IOException {
                try {
@@ -110,7 +106,6 @@ public class TimeoutOutputStream extends OutputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                try {
index 459888190f859bdc25853d9e9aa7c853d93efdbf..b37f28b1618cfebfe7da0e6a0c53b7aa3afd1df2 100644 (file)
@@ -91,7 +91,6 @@ public class UnionInputStream extends InputStream {
                return streams.isEmpty();
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read() throws IOException {
                for (;;) {
@@ -106,7 +105,6 @@ public class UnionInputStream extends InputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public int read(byte[] b, int off, int len) throws IOException {
                if (len == 0)
@@ -123,13 +121,11 @@ public class UnionInputStream extends InputStream {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public int available() throws IOException {
                return head().available();
        }
 
-       /** {@inheritDoc} */
        @Override
        public long skip(long count) throws IOException {
                long skipped = 0;
@@ -163,7 +159,6 @@ public class UnionInputStream extends InputStream {
                return skipped;
        }
 
-       /** {@inheritDoc} */
        @Override
        public void close() throws IOException {
                IOException err = null;
index 56e90d0636fe42af5abc035be73b1e4e08257b88..0a56c830404593923f933b35d8b3d294c9b1206c 100644 (file)
@@ -193,7 +193,6 @@ public abstract class SHA1 {
         * <p>
         * Implementations not supporting collision detection always return
         * {@code false}.
-        * <p>
         *
         * @return {@code true} if a likely collision was detected.
         */
index 66857b5bf83c8a484d69c9f25c68553b755593f4..4e079f08b5e868cea97e2419188bdd0dd672260d 100644 (file)
@@ -37,7 +37,6 @@ public class MonotonicSystemClock implements MonotonicClock {
                }
        }
 
-       /** {@inheritDoc} */
        @Override
        public ProposedTimestamp propose() {
                final long u = nowMicros();
index 8c20423bc6cb78986822f3834b93250f859fef57..a5ee1070d0da3fcf186934597801f9d049864c13 100644 (file)
@@ -162,7 +162,6 @@ public abstract class ProposedTimestamp implements AutoCloseable {
                // Do nothing by default.
        }
 
-       /** {@inheritDoc} */
        @Override
        public String toString() {
                return instant().toString();
diff --git a/pom.xml b/pom.xml
index 5576640d3db875970e5498b18cbc4f32f582f17e..d04ecf572704ca98801d043bee15c40734d6b4a2 100644 (file)
--- a/pom.xml
+++ b/pom.xml
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
         <configuration>
-          <additionalJOption>-Xdoclint:-missing</additionalJOption>
+          <!-- We check javadoc when compiling with ecj (option -Pecj) and configurations
+          set in .settings/org.eclipse.jdt.core.prefs. This allows more fine grained
+          configuration and fails the build on missing javadoc for protected and
+          public but not for private classes, methods and fields. We don't want
+          to check javadoc on tests. We can reconsider to configure this on javadoc
+          when it starts supporting access specifiers so that we can set
+          -Xdoclint:all,-missing/private -->
+          <additionalJOption>-Xdoclint:none</additionalJOption>-->
           <encoding>${project.build.sourceEncoding}</encoding>
           <quiet>true</quiet>
+          <failOnWarnings>true</failOnWarnings>
           <excludePackageNames>org.eclipse.jgit.http.test</excludePackageNames>
           <links>
             <link>https://docs.oracle.com/en/java/javase/11/docs/api</link>
           </links>
+          <tags>
+            <tag>
+              <name>apiNote</name>
+              <placement>a</placement>
+              <head>API Note:</head>
+            </tag>
+            <tag>
+              <name>implSpec</name>
+              <placement>a</placement>
+              <head>Implementation Requirements:</head>
+            </tag>
+            <tag>
+              <name>implNote</name>
+              <placement>a</placement>
+              <head>Implementation Note:</head>
+            </tag>
+          </tags>
         </configuration>
         <executions>
           <execution>
           </reportSet>
         </reportSets>
         <configuration>
-          <additionalJOption>-Xdoclint:-missing</additionalJOption>
+          <failOnWarnings>true</failOnWarnings>
         </configuration>
       </plugin>
       <plugin>