Require javadoc on protected methods in jgit core
commitc05bd5fc5ac4c184cf4c070fda198f908739daaa
authorRobin Rosenberg <robin.rosenberg@dewire.com>
Mon, 16 Mar 2009 20:14:34 +0000 (16 21:14 +0100)
committerShawn O. Pearce <spearce@spearce.org>
Mon, 16 Mar 2009 20:20:21 +0000 (16 13:20 -0700)
tree89b314828ea159098ed36317e7a231b5cb6686f0
parentf35aa8d952c6d66c81c487a3fd89828e63ccdee5
Require javadoc on protected methods in jgit core

In general protected methods are part of a public API since they grant
access to code outside of the package that declares the method or field.

A few protected fields and methods do not have javadocs, but it turns
out all but one are not used outside the package that declares them so
we can simply make them package private. This doesn't mean they aren't
supposed to be an API, but we can upgrade them if necessary.

A few places are actually used outside the package and are valid uses. For
those appropriate javadocs are added.

Signed-off-by: Robin Rosenberg <robin.rosenberg@dewire.com>
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
22 files changed:
org.spearce.jgit.pgm/.settings/org.eclipse.jdt.core.prefs
org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/TextBuiltin.java
org.spearce.jgit/.settings/org.eclipse.jdt.core.prefs
org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheBuildIterator.java
org.spearce.jgit/src/org/spearce/jgit/dircache/DirCacheIterator.java
org.spearce.jgit/src/org/spearce/jgit/lib/ObjectId.java
org.spearce.jgit/src/org/spearce/jgit/lib/PackIndex.java
org.spearce.jgit/src/org/spearce/jgit/lib/PackWriter.java
org.spearce.jgit/src/org/spearce/jgit/lib/TreeVisitorWithCurrentDirectory.java
org.spearce.jgit/src/org/spearce/jgit/lib/WorkDirCheckout.java
org.spearce.jgit/src/org/spearce/jgit/merge/StrategyOneSided.java
org.spearce.jgit/src/org/spearce/jgit/patch/FileHeader.java
org.spearce.jgit/src/org/spearce/jgit/patch/HunkHeader.java
org.spearce.jgit/src/org/spearce/jgit/revplot/PlotCommitList.java
org.spearce.jgit/src/org/spearce/jgit/revplot/PlotWalk.java
org.spearce.jgit/src/org/spearce/jgit/transport/DaemonService.java
org.spearce.jgit/src/org/spearce/jgit/transport/OpenSshConfig.java
org.spearce.jgit/src/org/spearce/jgit/transport/OperationResult.java
org.spearce.jgit/src/org/spearce/jgit/transport/PackedObjectInfo.java
org.spearce.jgit/src/org/spearce/jgit/transport/PushResult.java
org.spearce.jgit/src/org/spearce/jgit/transport/RemoteRefUpdate.java
org.spearce.jgit/src/org/spearce/jgit/treewalk/WorkingTreeIterator.java