From 0ba96b399d70eac60ece03f4e438125736169d5b Mon Sep 17 00:00:00 2001 From: Tobias Kellner Date: Tue, 27 Oct 2015 20:12:12 +0100 Subject: JavaDoc fixes --- smcc/src/main/java/at/gv/egiz/smcc/PINConfirmationException.java | 2 +- smcc/src/main/java/at/gv/egiz/smcc/PINFormatException.java | 2 +- .../main/java/at/gv/egiz/smcc/PINOperationAbortedException.java | 2 +- smcc/src/main/java/at/gv/egiz/smcc/SignatureCard.java | 4 ++-- smcc/src/main/java/at/gv/egiz/smcc/conf/SMCCConfiguration.java | 2 +- smcc/src/main/java/at/gv/egiz/smcc/pin/gui/ModifyPINProvider.java | 4 ++-- smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINGUI.java | 3 ++- smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINProvider.java | 4 ++-- smcc/src/main/java/at/gv/egiz/smcc/reader/CardReader.java | 2 +- smcc/src/main/java/at/gv/egiz/smcc/reader/DefaultCardReader.java | 2 +- smcc/src/main/java/at/gv/egiz/smcc/reader/PinpadCardReader.java | 2 +- smcc/src/main/java/at/gv/egiz/smcc/reader/ReaderFactory.java | 2 +- smcc/src/main/java/at/gv/egiz/smcc/util/LinuxLibraryFinder.java | 4 ++-- smcc/src/main/java/org/openecard/scio/osx/PlatformPCSC.java | 4 ++-- smcc/src/main/java/org/openecard/scio/osx/SunOSXPCSC.java | 8 ++++---- smcc/src/main/java/org/openecard/scio/osx/package-info.java | 2 +- 16 files changed, 25 insertions(+), 24 deletions(-) (limited to 'smcc') diff --git a/smcc/src/main/java/at/gv/egiz/smcc/PINConfirmationException.java b/smcc/src/main/java/at/gv/egiz/smcc/PINConfirmationException.java index 2299061e..9aee4ca8 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/PINConfirmationException.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/PINConfirmationException.java @@ -28,7 +28,7 @@ package at.gv.egiz.smcc; * TODO check whether card readers distinguish specific reason (pin too short?) * and add getters/setters * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class PINConfirmationException extends SignatureCardException { diff --git a/smcc/src/main/java/at/gv/egiz/smcc/PINFormatException.java b/smcc/src/main/java/at/gv/egiz/smcc/PINFormatException.java index ef861b23..272ce69d 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/PINFormatException.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/PINFormatException.java @@ -28,7 +28,7 @@ package at.gv.egiz.smcc; * TODO check whether card readers distinguish specific reason (pin too short?) * and add getters/setters * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class PINFormatException extends SignatureCardException { diff --git a/smcc/src/main/java/at/gv/egiz/smcc/PINOperationAbortedException.java b/smcc/src/main/java/at/gv/egiz/smcc/PINOperationAbortedException.java index 1f3055e4..3c5f201b 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/PINOperationAbortedException.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/PINOperationAbortedException.java @@ -28,7 +28,7 @@ package at.gv.egiz.smcc; * TODO check whether card readers distinguish specific reason (pin too short?) * and add getters/setters * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class PINOperationAbortedException extends SignatureCardException { diff --git a/smcc/src/main/java/at/gv/egiz/smcc/SignatureCard.java b/smcc/src/main/java/at/gv/egiz/smcc/SignatureCard.java index b3cbaec8..b7c2b9a6 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/SignatureCard.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/SignatureCard.java @@ -102,7 +102,7 @@ public interface SignatureCard { /** * * @param infobox - * @param provider + * @param pinGUI * @param domainId may be null. * @return * @throws SignatureCardException @@ -115,7 +115,7 @@ public interface SignatureCard { * * @param input * @param keyboxName - * @param provider + * @param pinGUI * @param alg TODO * @return * @throws at.gv.egiz.smcc.SignatureCardException diff --git a/smcc/src/main/java/at/gv/egiz/smcc/conf/SMCCConfiguration.java b/smcc/src/main/java/at/gv/egiz/smcc/conf/SMCCConfiguration.java index a1801da5..58872409 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/conf/SMCCConfiguration.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/conf/SMCCConfiguration.java @@ -27,7 +27,7 @@ package at.gv.egiz.smcc.conf; /** * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class SMCCConfiguration { diff --git a/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/ModifyPINProvider.java b/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/ModifyPINProvider.java index 2d1ec970..dd24599b 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/ModifyPINProvider.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/ModifyPINProvider.java @@ -35,13 +35,13 @@ import at.gv.egiz.smcc.PinInfo; *
  • new pin (pin activation, no current pin) *
  • puk and new pin (probably verify only?) * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public interface ModifyPINProvider { /** * - * @param spec + * @param pinInfo * @param retries * @return null if no old value for this pin * @throws at.gv.egiz.smcc.CancelledException if cancelled by user diff --git a/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINGUI.java b/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINGUI.java index 06d5df60..dcf99a09 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINGUI.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINGUI.java @@ -39,7 +39,8 @@ public interface PINGUI extends PINProvider { throws CancelledException, InterruptedException; /** - * @throws CancelledException, InterruptedException if signature-data dialog is interrupted or cancelled + * @throws CancelledException if signature-data dialog is cancelled + * @throws InterruptedException if signature-data dialog is interrupted */ void enterPIN(PinInfo pinInfo, int retries) throws CancelledException, InterruptedException; diff --git a/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINProvider.java b/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINProvider.java index ef954dd8..b740c0ad 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINProvider.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/pin/gui/PINProvider.java @@ -37,7 +37,7 @@ import at.gv.egiz.smcc.PinInfo; * * (ACOS: reload counter: between 0 and 15, where 15 meens deactivated) * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public interface PINProvider { @@ -45,7 +45,7 @@ public interface PINProvider { * TODO change interface to void providePIN(char[] pin, pinspec, retries) * to allow caller to clear pin afterwards. * - * @param spec + * @param pinSpec * @param retries num of remaining retries or -1 if unknown * (a positive value does not necessarily signify that there was * already an unsuccessful PIN verification) diff --git a/smcc/src/main/java/at/gv/egiz/smcc/reader/CardReader.java b/smcc/src/main/java/at/gv/egiz/smcc/reader/CardReader.java index c3d950a7..b05fd8eb 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/reader/CardReader.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/reader/CardReader.java @@ -41,7 +41,7 @@ import javax.smartcardio.Card; /** * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public interface CardReader { diff --git a/smcc/src/main/java/at/gv/egiz/smcc/reader/DefaultCardReader.java b/smcc/src/main/java/at/gv/egiz/smcc/reader/DefaultCardReader.java index 06d3d133..6560e73f 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/reader/DefaultCardReader.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/reader/DefaultCardReader.java @@ -46,7 +46,7 @@ import at.gv.egiz.smcc.util.ISO7816Utils; /** * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class DefaultCardReader implements CardReader { diff --git a/smcc/src/main/java/at/gv/egiz/smcc/reader/PinpadCardReader.java b/smcc/src/main/java/at/gv/egiz/smcc/reader/PinpadCardReader.java index 9a7206ec..48331278 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/reader/PinpadCardReader.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/reader/PinpadCardReader.java @@ -54,7 +54,7 @@ import at.gv.egiz.smcc.util.SMCCHelper; /** * - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class PinpadCardReader extends DefaultCardReader { diff --git a/smcc/src/main/java/at/gv/egiz/smcc/reader/ReaderFactory.java b/smcc/src/main/java/at/gv/egiz/smcc/reader/ReaderFactory.java index 8b49f1a9..5cb28908 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/reader/ReaderFactory.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/reader/ReaderFactory.java @@ -38,7 +38,7 @@ import org.slf4j.LoggerFactory; /** * TODO - * @author Clemens Orthacker + * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at> */ public class ReaderFactory { diff --git a/smcc/src/main/java/at/gv/egiz/smcc/util/LinuxLibraryFinder.java b/smcc/src/main/java/at/gv/egiz/smcc/util/LinuxLibraryFinder.java index 5aed2c2d..94d964c2 100644 --- a/smcc/src/main/java/at/gv/egiz/smcc/util/LinuxLibraryFinder.java +++ b/smcc/src/main/java/at/gv/egiz/smcc/util/LinuxLibraryFinder.java @@ -37,7 +37,7 @@ import org.slf4j.LoggerFactory; * There is one exception to this rule, the ELF variables DT_RPATH and * DT_RUNPATH are not evaluated, because they are not available in java. * - * @author Tobias Wich + * @author Tobias Wich <tobias.wich@ecsec.de> */ public class LinuxLibraryFinder { @@ -51,6 +51,7 @@ public class LinuxLibraryFinder { *

    * The algorithm to find the library can be found in the ld.so(8) manpage and * is as follows: + *

    *
      *
    1. Check paths in {@code LD_LIBRARY_PATH} environment variable.
      2. *
    2. Check for library in {@code /etc/ld.so.cache} by executing @@ -58,7 +59,6 @@ public class LinuxLibraryFinder { *
    3. Check the base library paths {@code /lib} and {@code /usr/lib} or * {@code /lib64} and {@code /usr/lib64} depending on the architecture.
      4. *
    - *

    * * @param name * Name of the library, such as pcsclite. diff --git a/smcc/src/main/java/org/openecard/scio/osx/PlatformPCSC.java b/smcc/src/main/java/org/openecard/scio/osx/PlatformPCSC.java index e7b048f0..929e5a77 100644 --- a/smcc/src/main/java/org/openecard/scio/osx/PlatformPCSC.java +++ b/smcc/src/main/java/org/openecard/scio/osx/PlatformPCSC.java @@ -34,9 +34,9 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * OS X specific PlatformPCSC. For more information see {@link package-info}. + * OS X specific PlatformPCSC. For more information see {@link org.openecard.scio.osx}. * - * @author Benedikt Biallowons + * @author Benedikt Biallowons <benedikt.biallowons@ecsec.de> */ public class PlatformPCSC { diff --git a/smcc/src/main/java/org/openecard/scio/osx/SunOSXPCSC.java b/smcc/src/main/java/org/openecard/scio/osx/SunOSXPCSC.java index f05d0373..ef98b341 100644 --- a/smcc/src/main/java/org/openecard/scio/osx/SunOSXPCSC.java +++ b/smcc/src/main/java/org/openecard/scio/osx/SunOSXPCSC.java @@ -29,9 +29,9 @@ import javax.smartcardio.CardTerminals; import javax.smartcardio.TerminalFactorySpi; /** - * OS X PC/SC provider. For more information see {@link package-info}. + * OS X PC/SC provider. For more information see {@link org.openecard.scio.osx}. * - * @author Benedikt Biallowons + * @author Benedikt Biallowons <benedikt.biallowons@ecsec.de> */ public final class SunOSXPCSC extends Provider { @@ -55,11 +55,11 @@ public final class SunOSXPCSC extends Provider { * Internal provider factory. For more information see * {@link TerminalFactorySpi} * - * @author Benedikt Biallowons + * @author Benedikt Biallowons <benedikt.biallowons@ecsec.de> */ public static final class Factory extends TerminalFactorySpi { /** - * Constructor checking availability & initializing context. + * Constructor checking availability & initializing context. * * @param obj * provider parameters diff --git a/smcc/src/main/java/org/openecard/scio/osx/package-info.java b/smcc/src/main/java/org/openecard/scio/osx/package-info.java index 5d066a40..7208e9c0 100644 --- a/smcc/src/main/java/org/openecard/scio/osx/package-info.java +++ b/smcc/src/main/java/org/openecard/scio/osx/package-info.java @@ -22,7 +22,7 @@ /** * This package contains a OS X specific SmartcardIO implementation. We've to do - * this, because the current PC/SC JNI libraries on OS X (jre6 & jre7) are too buggy + * this, because the current PC/SC JNI libraries on OS X (jre6 & jre7) are too buggy * to be useful and the design of the sun.security.smartcardio package doesn't allow * to specify another JNI library path. */ -- cgit v1.2.3