directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From plusplusjia...@apache.org
Subject directory-kerby git commit: Fix some javadocs.
Date Thu, 28 Jul 2016 02:26:36 GMT
Repository: directory-kerby
Updated Branches:
  refs/heads/trunk c689c6671 -> b1861e4bf


Fix some javadocs.


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

Branch: refs/heads/trunk
Commit: b1861e4bfd80bc9409399e3cf8a96c77a4273fe7
Parents: c689c66
Author: plusplusjiajia <jiajia.li@intel.com>
Authored: Thu Jul 28 10:32:35 2016 +0800
Committer: plusplusjiajia <jiajia.li@intel.com>
Committed: Thu Jul 28 10:32:35 2016 +0800

----------------------------------------------------------------------
 .../src/main/java/org/apache/kerby/xdr/XdrFieldInfo.java     | 5 +++--
 .../src/main/java/org/apache/kerby/xdr/type/XdrInteger.java  | 2 +-
 .../src/main/java/org/apache/kerby/xdr/type/XdrSimple.java   | 3 ++-
 .../src/main/java/org/apache/kerby/xdr/type/XdrString.java   | 4 ++--
 .../src/main/java/org/apache/kerby/xdr/type/XdrType.java     | 3 +++
 .../src/main/java/org/apache/kerby/xdr/type/XdrUnion.java    | 2 +-
 .../java/org/apache/kerby/xdr/type/XdrUnsignedInteger.java   | 2 +-
 .../src/main/java/org/apache/kerby/xdr/util/HexUtil.java     | 1 +
 .../org/apache/kerby/kerberos/kdc/impl/NettyKdcHandler.java  | 2 +-
 .../kerby/kerberos/kdc/impl/NettyKdcUdpServerHandler.java    | 2 +-
 .../kerby/kerberos/kerb/type/ad/AuthorizationDataEntry.java  | 7 ++++---
 .../kerberos/kerb/type/ad/AuthorizationDataWrapper.java      | 8 ++++----
 .../apache/kerby/kerberos/kerb/identity/IdentityService.java | 3 ++-
 .../kerb/identity/backend/AbstractIdentityBackend.java       | 2 +-
 14 files changed, 27 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/XdrFieldInfo.java
----------------------------------------------------------------------
diff --git a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/XdrFieldInfo.java b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/XdrFieldInfo.java
index 2ab727c..1f43197 100644
--- a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/XdrFieldInfo.java
+++ b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/XdrFieldInfo.java
@@ -29,8 +29,9 @@ public class XdrFieldInfo {
 
     /**
      * Constructor.
-     * @param index
-     * @param dataType
+     * @param index The index
+     * @param dataType The data type
+     * @param value The value
      *
      */
     public XdrFieldInfo(int index, XdrDataType dataType, Object value) {

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrInteger.java
----------------------------------------------------------------------
diff --git a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrInteger.java
b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrInteger.java
index 478cf80..a40f0e6 100644
--- a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrInteger.java
+++ b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrInteger.java
@@ -35,7 +35,7 @@ import java.nio.ByteBuffer;
  *      +-------+-------+-------+-------+
  *      |byte 0 |byte 1 |byte 2 |byte 3 |
  *      +-------+-------+-------+-------+
- *      <------------32 bits------------>
+ *      |------------32 bits------------|
  */
 public class XdrInteger extends XdrSimple<Integer> {
     public XdrInteger() {

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrSimple.java
----------------------------------------------------------------------
diff --git a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrSimple.java
b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrSimple.java
index 9b62c8e..b5f2a9a 100644
--- a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrSimple.java
+++ b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrSimple.java
@@ -83,7 +83,7 @@ public abstract class XdrSimple<T> extends AbstractXdrType<T>
{
 
     /**
      * Length including null bytes to maintain an multiple of 4.
-     * @return
+     * @return The encoding body length
      */
     @Override
     protected int encodingBodyLength() throws IOException {
@@ -118,6 +118,7 @@ public abstract class XdrSimple<T> extends AbstractXdrType<T>
{
 
     /**
      * Encode simple type to bytes.
+     * @throws IOException e
      */
     protected abstract void toBytes() throws IOException;
 

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrString.java
----------------------------------------------------------------------
diff --git a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrString.java
b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrString.java
index 32b2302..d648e01 100644
--- a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrString.java
+++ b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrString.java
@@ -36,8 +36,8 @@ import java.util.List;
  *        +-----+-----+-----+-----+-----+-----+...+-----+-----+...+-----+
  *        |        length n       |byte0|byte1|...| n-1 |  0  |...|  0  |
  *        +-----+-----+-----+-----+-----+-----+...+-----+-----+...+-----+
- *        |<-------4 bytes------->|<------n bytes------>|<---r bytes--->|
- *                                |<----n+r (where (n+r) mod 4 = 0)---->|
+ *        |--------4 bytes--------|-------n bytes-------|----r bytes----|
+ *                                |-----n+r (where (n+r) mod 4 = 0)-----|
  *                                                                 STRING
  */
 public class XdrString extends XdrSimple<String> {

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrType.java
----------------------------------------------------------------------
diff --git a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrType.java b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrType.java
index 6840e59..ffc411a 100644
--- a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrType.java
+++ b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrType.java
@@ -31,18 +31,21 @@ public interface XdrType {
      * Get length of encoding bytes by just calculating without real encoding.
      * Generally it's called to prepare for the encoding buffer.
      * @return length of encoding bytes
+     * @throws IOException e
      */
     int encodingLength() throws IOException;
 
     /**
      * Encode the type, by recursively.
      * @return encoded bytes
+     * @throws IOException e
      */
     byte[] encode() throws IOException;
 
     /**
      * Encode the type, by recursively, using the provided buffer.
      * @param buffer The byte buffer
+     * @throws IOException e
      */
     void encode(ByteBuffer buffer) throws IOException;
 

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnion.java
----------------------------------------------------------------------
diff --git a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnion.java
b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnion.java
index 20d4f83..2e3aa01 100644
--- a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnion.java
+++ b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnion.java
@@ -53,7 +53,7 @@ import java.nio.ByteBuffer;
  *                  +---+---+---+---+---+---+---+---+
  *                  |  discriminant |  implied arm  |
  *                  +---+---+---+---+---+---+---+---+
- *                  |<---4 bytes--->|
+ *                  |----4 bytes----|
  */
 public abstract class XdrUnion extends AbstractXdrType<XdrUnion> {
     /**

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnsignedInteger.java
----------------------------------------------------------------------
diff --git a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnsignedInteger.java
b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnsignedInteger.java
index ad1df69..5708cbb 100644
--- a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnsignedInteger.java
+++ b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/type/XdrUnsignedInteger.java
@@ -37,7 +37,7 @@ import java.nio.ByteBuffer;
  *      +-------+-------+-------+-------+
  *      |byte 0 |byte 1 |byte 2 |byte 3 |
  *      +-------+-------+-------+-------+
- *      <------------32 bits------------>
+ *      |------------32 bits------------|
  */
 public class XdrUnsignedInteger extends XdrSimple<Long> {
     public XdrUnsignedInteger() {

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/util/HexUtil.java
----------------------------------------------------------------------
diff --git a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/util/HexUtil.java b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/util/HexUtil.java
index 70a2b1c..eefd25b 100644
--- a/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/util/HexUtil.java
+++ b/kerby-common/kerby-xdr/src/main/java/org/apache/kerby/xdr/util/HexUtil.java
@@ -30,6 +30,7 @@ public class HexUtil {
     /**
      * Convert bytes into friendly format as:
      * 0x02 02 00 80
+     * @param bytes The bytes to be converted
      */
     public static String bytesToHexFriendly(byte[] bytes) {
         int len = bytes.length * 2;

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcHandler.java
----------------------------------------------------------------------
diff --git a/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcHandler.java
b/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcHandler.java
index 1253adf..edaf80d 100644
--- a/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcHandler.java
+++ b/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcHandler.java
@@ -64,7 +64,7 @@ public class NettyKdcHandler extends ChannelInboundHandlerAdapter {
 
     /**
      * Calls {@link ChannelHandlerContext#fireExceptionCaught(Throwable)} to
-     * forward to the next {@link ChannelHandler} in the {@link ChannelPipeline}
+     * forward to the next {ChannelHandler} in the {ChannelPipeline}
      *
      * Sub-classes may override this method to change behavior.
      */

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcUdpServerHandler.java
----------------------------------------------------------------------
diff --git a/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcUdpServerHandler.java
b/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcUdpServerHandler.java
index 04a314a..eedd4ed 100644
--- a/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcUdpServerHandler.java
+++ b/kerby-kdc/src/main/java/org/apache/kerby/kerberos/kdc/impl/NettyKdcUdpServerHandler.java
@@ -66,7 +66,7 @@ public class NettyKdcUdpServerHandler extends SimpleChannelInboundHandler<Datagr
 
     /**
      * Calls {@link ChannelHandlerContext#fireExceptionCaught(Throwable)} to
-     * forward to the next {@link ChannelHandler} in the {@link ChannelPipeline}
+     * forward to the next {ChannelHandler} in the {ChannelPipeline}
      *
      * Sub-classes may override this method to change behavior.
      */

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataEntry.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataEntry.java
b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataEntry.java
index fa9284b..ae16514 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataEntry.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataEntry.java
@@ -83,6 +83,7 @@ public class AuthorizationDataEntry extends KrbSequenceType {
 
     /**
      * Creates an AuthorizationDataEntry instance
+     * @param type The authorization type
      */
     public AuthorizationDataEntry(AuthorizationType type) {
         super(fieldInfos);
@@ -91,6 +92,8 @@ public class AuthorizationDataEntry extends KrbSequenceType {
 
     /**
      * Creates an AuthorizationDataEntry instance
+     * @param type The authorization type
+     * @param authzData The authorization data
      */
     public AuthorizationDataEntry(AuthorizationType type, byte[] authzData) {
         super(fieldInfos);
@@ -131,10 +134,8 @@ public class AuthorizationDataEntry extends KrbSequenceType {
     }
 
     /**
-     * @param <T>
+     * @param <T> type The type
      * @return The AuthorizationData (AD_DATA) field
-     * @throws IllegalAccessException
-     * @throws InstantiationException
      */
     public <T extends Asn1Type> T getAuthzDataAs(Class<T> type) {
         T result = null;

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataWrapper.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataWrapper.java
b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataWrapper.java
index e7c3fa5..86fc524 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataWrapper.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/type/ad/AuthorizationDataWrapper.java
@@ -19,11 +19,11 @@
  */
 package org.apache.kerby.kerberos.kerb.type.ad;
 
-import java.io.IOException;
-
 import org.apache.kerby.asn1.Asn1Dumper;
 import org.apache.kerby.asn1.EnumType;
 
+import java.io.IOException;
+
 /**
  * Contributed to the Apache Kerby Project by: Prodentity - Corrales, NM
  * 
@@ -81,7 +81,7 @@ public class AuthorizationDataWrapper extends AuthorizationDataEntry {
 
     /**
      * @return The AuthorizationType (AD_DATA) field
-     * @throws IOException
+     * @throws IOException e
      */
     public AuthorizationData getAuthorizationData() throws IOException {
         AuthorizationData result;
@@ -98,7 +98,7 @@ public class AuthorizationDataWrapper extends AuthorizationDataEntry {
      * Sets the AuthorizationData (AD_DATA) field
      * 
      * @param authzData The AuthorizationData to set
-     * @throws IOException
+     * @throws IOException e
      */
     public void setAuthorizationData(AuthorizationData authzData) throws IOException {
         setAuthzData(authzData.encode());

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
index e09aeec..3b10072 100644
--- a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
+++ b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
@@ -36,7 +36,8 @@ public interface IdentityService {
 
     /**
      * Start a transaction.
-     * @return xtrans
+     * @return xtrans The batch trans
+     * @throws KrbException e
      */
     BatchTrans startBatchTrans() throws KrbException;
 

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/b1861e4b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
index 5349e43..d5edc12 100644
--- a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
+++ b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
@@ -188,7 +188,7 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Get an identity's Authorization Data, invoked by getIdentityAuthorizationData.
-     * @param krbIdentity The KrbIdentity
+     * @param kdcRequest The kdc request
      * @param encTicketPart The EncTicketPart being built for the KrbIdentity
      * @return The Authorization Data
      * @throws KrbException e


Mime
View raw message