diff options
author | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-19 11:55:51 +0100 |
---|---|---|
committer | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-20 22:10:09 +0100 |
commit | 781e106a2607665a7a47b626fd5b67fa8b491d18 (patch) | |
tree | de19ed5137ce0e3fde078566dfa98ca09e6e7c95 /org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java | |
parent | c1a02f497a945d51b205c13a71f94c539ef0079b (diff) | |
download | jgit-781e106a2607665a7a47b626fd5b67fa8b491d18.tar.gz jgit-781e106a2607665a7a47b626fd5b67fa8b491d18.zip |
Fix javadoc in org.eclipse.jgit transport package
Change-Id: Id70e2c27e38bf12f87e66b28fbd0b06908494764
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java')
-rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java index 745e813c41..5eb1661738 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java @@ -67,7 +67,10 @@ import org.eclipse.jgit.lib.RefComparator; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.util.RefMap; -/** Support for the start of {@link UploadPack} and {@link ReceivePack}. */ +/** + * Support for the start of {@link org.eclipse.jgit.transport.UploadPack} and + * {@link org.eclipse.jgit.transport.ReceivePack}. + */ public abstract class RefAdvertiser { /** Advertiser which frames lines in a {@link PacketLineOut} format. */ public static class PacketLineOutRefAdvertiser extends RefAdvertiser { @@ -247,7 +250,6 @@ public abstract class RefAdvertiser { * The symbolic ref, e.g. "HEAD" * @param to * The real ref it points to, e.g. "refs/heads/master" - * * @since 3.6 */ public void addSymref(String from, String to) { @@ -262,7 +264,7 @@ public abstract class RefAdvertiser { * sorted before display if necessary, and therefore may appear * in any order. * @return set of ObjectIds that were advertised to the client. - * @throws IOException + * @throws java.io.IOException * the underlying output stream failed to write out an * advertisement record. */ @@ -305,7 +307,7 @@ public abstract class RefAdvertiser { * * @param id * identity of the object that is assumed to exist. - * @throws IOException + * @throws java.io.IOException * the underlying output stream failed to write out an * advertisement record. */ @@ -313,7 +315,11 @@ public abstract class RefAdvertiser { advertiseAnyOnce(id, ".have"); //$NON-NLS-1$ } - /** @return true if no advertisements have been sent yet. */ + /** + * Whether no advertisements have been sent yet. + * + * @return true if no advertisements have been sent yet. + */ public boolean isEmpty() { return first; } @@ -341,7 +347,7 @@ public abstract class RefAdvertiser { * @param refName * name of the reference to advertise the object as, can be any * string not including the NUL byte. - * @throws IOException + * @throws java.io.IOException * the underlying output stream failed to write out an * advertisement record. */ @@ -372,7 +378,7 @@ public abstract class RefAdvertiser { * @param line * the advertisement line to be written. The line always ends * with LF. Never null or the empty string. - * @throws IOException + * @throws java.io.IOException * the underlying output stream failed to write out an * advertisement record. */ @@ -381,7 +387,7 @@ public abstract class RefAdvertiser { /** * Mark the end of the advertisements. * - * @throws IOException + * @throws java.io.IOException * the underlying output stream failed to write out an * advertisement record. */ |