diff options
author | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-18 16:52:40 +0100 |
---|---|---|
committer | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-19 13:43:54 +0100 |
commit | 8a6af368c4129ef35520ec72cc9f55a3f685bfb8 (patch) | |
tree | 3c11f7c6517247c66fd87bf87571e150d064a84d /org.eclipse.jgit/src/org/eclipse/jgit/lib/FileMode.java | |
parent | d0342be42d65621e1136936cea9e5072bcfd17a4 (diff) | |
download | jgit-8a6af368c4129ef35520ec72cc9f55a3f685bfb8.tar.gz jgit-8a6af368c4129ef35520ec72cc9f55a3f685bfb8.zip |
Fix javadoc in org.eclipse.jgit lib package
Change-Id: I1e85a951488177993521ce177fdea212615e6164
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/lib/FileMode.java')
-rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/lib/FileMode.java | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/FileMode.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/FileMode.java index edbc709f48..7852371648 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/FileMode.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/FileMode.java @@ -82,7 +82,9 @@ public abstract class FileMode { /** Bit pattern for {@link #TYPE_MASK} matching {@link #MISSING}. */ public static final int TYPE_MISSING = 0000000; - /** Mode indicating an entry is a tree (aka directory). */ + /** + * Mode indicating an entry is a tree (aka directory). + */ public static final FileMode TREE = new FileMode(TYPE_TREE, Constants.OBJ_TREE) { @Override @@ -197,9 +199,11 @@ public abstract class FileMode { } /** - * Test a file mode for equality with this {@link FileMode} object. + * Test a file mode for equality with this + * {@link org.eclipse.jgit.lib.FileMode} object. * * @param modebits + * a int. * @return true if the mode bits represent the same mode as this object */ public abstract boolean equals(final int modebits); @@ -215,7 +219,7 @@ public abstract class FileMode { * * @param os * stream to copy the mode to. - * @throws IOException + * @throws java.io.IOException * the stream encountered an error during the copy. */ public void copyTo(final OutputStream os) throws IOException { @@ -240,6 +244,8 @@ public abstract class FileMode { } /** + * Copy the number of bytes written by {@link #copyTo(OutputStream)}. + * * @return the number of bytes written by {@link #copyTo(OutputStream)}. */ public int copyToLength() { @@ -249,7 +255,7 @@ public abstract class FileMode { /** * Get the object type that should appear for this type of mode. * <p> - * See the object type constants in {@link Constants}. + * See the object type constants in {@link org.eclipse.jgit.lib.Constants}. * * @return one of the well known object type constants. */ @@ -257,13 +263,19 @@ public abstract class FileMode { return objectType; } - /** Format this mode as an octal string (for debugging only). */ + /** + * {@inheritDoc} + * <p> + * Format this mode as an octal string (for debugging only). + */ @Override public String toString() { return Integer.toOctalString(modeBits); } /** + * Get the mode bits as an integer. + * * @return The mode bits as an integer. */ public int getBits() { |