directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From plusplusjia...@apache.org
Subject [19/46] directory-kerby git commit: Fix javadoc of kerb-common module.
Date Wed, 09 Sep 2015 01:36:40 GMT
Fix javadoc of kerb-common module.


Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/9013961d
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/9013961d
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/9013961d

Branch: refs/heads/pkinit-support
Commit: 9013961df3ab628380290d92275feed74e58e6be
Parents: 024d572
Author: plusplusjiajia <jiajia.li@intel.com>
Authored: Mon Aug 24 13:46:30 2015 +0800
Committer: plusplusjiajia <jiajia.li@intel.com>
Committed: Mon Aug 24 13:46:30 2015 +0800

----------------------------------------------------------------------
 .../java/org/apache/kerby/kerberos/kerb/common/KrbUtil.java | 4 ++--
 .../kerby/kerberos/kerb/transport/KdcUdpTransport.java      | 2 +-
 .../kerby/kerberos/kerb/transport/KrbTcpTransport.java      | 2 +-
 .../apache/kerby/kerberos/kerb/transport/KrbTransport.java  | 9 +++++----
 .../kerby/kerberos/kerb/transport/KrbUdpTransport.java      | 2 +-
 5 files changed, 10 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/9013961d/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/common/KrbUtil.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/common/KrbUtil.java
b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/common/KrbUtil.java
index fba622d..0610807 100644
--- a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/common/KrbUtil.java
+++ b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/common/KrbUtil.java
@@ -27,7 +27,7 @@ public class KrbUtil {
 
     /**
      * Construct TGS principal name.
-     * @param realm
+     * @param realm The realm
      * @return principal
      */
     public static PrincipalName makeTgsPrincipal(String realm) {
@@ -37,7 +37,7 @@ public class KrbUtil {
 
     /**
      * Construct kadmin principal name.
-     * @param realm
+     * @param realm The realm
      * @return principal
      */
     public static PrincipalName makeKadminPrincipal(String realm) {

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/9013961d/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KdcUdpTransport.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KdcUdpTransport.java
b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KdcUdpTransport.java
index f2e67cd..34d38d3 100644
--- a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KdcUdpTransport.java
+++ b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KdcUdpTransport.java
@@ -28,7 +28,7 @@ import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.TimeUnit;
 
 /**
- * Default implementation of {@Link KrbTransport} using UDP.
+ * Default implementation of {@link KrbTransport} using UDP.
  */
 public class KdcUdpTransport extends KrbUdpTransport {
     private BlockingQueue<ByteBuffer> bufferQueue = new ArrayBlockingQueue<ByteBuffer>(2);

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/9013961d/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTcpTransport.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTcpTransport.java
b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTcpTransport.java
index 6b7cdee..4a51611 100644
--- a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTcpTransport.java
+++ b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTcpTransport.java
@@ -27,7 +27,7 @@ import java.net.Socket;
 import java.nio.ByteBuffer;
 
 /**
- * Default implementation of {@Link KrbTransport} using TCP in block mode.
+ * Default implementation of {@link KrbTransport} using TCP in block mode.
  */
 public class KrbTcpTransport
         extends AbstractKrbTransport implements KrbTransport {

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/9013961d/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
index 3c54c27..3ee54a6 100644
--- a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
+++ b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
@@ -30,19 +30,20 @@ public interface KrbTransport {
 
     /**
      * Send out a Kerberos message to remote peer.
-     * @param message
+     * @param message The message to be sent
      */
     void sendMessage(ByteBuffer message) throws IOException;
 
     /**
      * Receive a Kerberos message from remote.
-     * @return
+     * @return The received message
+     * @throws IOException e
      */
     ByteBuffer receiveMessage() throws IOException;
 
     /**
      * Judge the type of transport, return true if it is tcp,
-     * reture false if it is udp.
+     * @return false if it is udp.
      */
 
     boolean isTcp();
@@ -55,7 +56,7 @@ public interface KrbTransport {
 
     /**
      * Set an attachment.
-     * @param attachment
+     * @param attachment The attachment
      */
     void setAttachment(Object attachment);
 

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/9013961d/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbUdpTransport.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbUdpTransport.java
b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbUdpTransport.java
index 906bdc7..72a3c2b 100644
--- a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbUdpTransport.java
+++ b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbUdpTransport.java
@@ -26,7 +26,7 @@ import java.nio.ByteBuffer;
 import java.nio.channels.DatagramChannel;
 
 /**
- * Default implementation of {@Link KrbTransport} using UDP.
+ * Default implementation of {@link KrbTransport} using UDP.
  */
 public class KrbUdpTransport
         extends AbstractKrbTransport implements KrbTransport {


Mime
View raw message