Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/biometrics/fingerprint/2.1/IBiometricsFingerprint.hal b/biometrics/fingerprint/2.1/IBiometricsFingerprint.hal
index 0b92848..14f3005 100644
--- a/biometrics/fingerprint/2.1/IBiometricsFingerprint.hal
+++ b/biometrics/fingerprint/2.1/IBiometricsFingerprint.hal
@@ -19,7 +19,7 @@
import IBiometricsFingerprintClientCallback;
interface IBiometricsFingerprint {
- /*
+ /**
* Set notification callback:
* Registers a user function that must receive notifications from the HAL
* This call must block if the HAL state machine is in busy state until HAL
@@ -32,7 +32,7 @@
setNotify(IBiometricsFingerprintClientCallback clientCallback)
generates (uint64_t deviceId);
- /*
+ /**
* Fingerprint pre-enroll enroll request:
* Generates a unique token to upper layers to indicate the start of
* an enrollment transaction. pre-enroll and post-enroll specify
@@ -47,7 +47,7 @@
@callflow(next={"enroll", "postEnroll"})
preEnroll() generates (uint64_t authChallenge);
- /*
+ /**
* Fingerprint enroll request:
* Switches the HAL state machine to collect and store a new fingerprint
* template. Switches back as soon as enroll is complete, signalled by
@@ -69,7 +69,7 @@
enroll(uint8_t[69] hat, uint32_t gid, uint32_t timeoutSec)
generates (RequestStatus debugErrno);
- /*
+ /**
* Finishes the enroll operation and invalidates the preEnroll() generated
* challenge. This must be called at the end of a multi-finger enrollment
* session to indicate that no more fingers may be added.
@@ -79,7 +79,7 @@
@callflow(next={"authenticate", "setActiveGroup", "enumerate", "remove"})
postEnroll() generates (RequestStatus debugErrno);
- /*
+ /**
* getAuthenticatorId:
* Returns a token associated with the current fingerprint set. This value
* must change whenever a new fingerprint is enrolled, thus creating a new
@@ -91,7 +91,7 @@
@callflow(next={"authenticate"})
getAuthenticatorId() generates (uint64_t AuthenticatorId);
- /*
+ /**
* Cancel pending enroll or authenticate, sending FINGERPRINT_ERROR_CANCELED
* to all running clients. Switches the HAL state machine back to the idle
* state. Unlike enrollDone() doesn't invalidate the preEnroll() challenge.
@@ -102,7 +102,7 @@
"setActiveGroup"})
cancel() generates (RequestStatus debugErrno);
- /*
+ /**
* Enumerate all the fingerprint templates found in the directory set by
* setActiveGroup():
* For each template found a notify() must be called with:
@@ -116,7 +116,7 @@
@callflow(next={"remove", "enroll", "authenticate", "setActiveGroup"})
enumerate() generates (RequestStatus debugErrno);
- /*
+ /**
* Fingerprint remove request:
* Deletes fingerprint template(s).
* Works only within the path set by setActiveGroup().
@@ -136,7 +136,7 @@
"setActiveGroup"})
remove(uint32_t gid, uint32_t fid) generates (RequestStatus debugErrno);
- /*
+ /**
* Restricts the HAL operation to a set of fingerprints belonging to a group
* provided. The caller must provide a path to a storage location within the
* user's data directory.
@@ -150,7 +150,7 @@
setActiveGroup(uint32_t gid, string storePath)
generates (RequestStatus debugErrno);
- /*
+ /**
* Authenticates an operation identified by operationId
*
* @param operationId operation id.
diff --git a/biometrics/fingerprint/2.1/types.hal b/biometrics/fingerprint/2.1/types.hal
index e389773..7402085 100644
--- a/biometrics/fingerprint/2.1/types.hal
+++ b/biometrics/fingerprint/2.1/types.hal
@@ -16,7 +16,7 @@
package android.hardware.biometrics.fingerprint@2.1;
-/*
+/**
* Request status indicates whether the request is accepted by the vendor
* implementation or not. These values are taken from the errno set,
* except for the SYS_UNKNOWN
@@ -37,7 +37,7 @@
SYS_ETIMEDOUT = -110,
};
-/*
+/**
* Fingerprint errors are meant to tell the framework to terminate the current
* operation and ask for the user to correct the situation. These will almost
* always result in messaging and user interaction to correct the problem.
@@ -49,27 +49,27 @@
* followed by ERROR_CANCELED.
*/
enum FingerprintError : int32_t {
- /* Used for testing, no error returned */
+ /** Used for testing, no error returned */
ERROR_NO_ERROR = 0,
- /* The hardware has an error that can't be resolved. */
+ /** The hardware has an error that can't be resolved. */
ERROR_HW_UNAVAILABLE = 1,
- /* Bad data; operation can't continue */
+ /** Bad data; operation can't continue */
ERROR_UNABLE_TO_PROCESS = 2,
- /* The operation has timed out waiting for user input. */
+ /** The operation has timed out waiting for user input. */
ERROR_TIMEOUT = 3,
- /* No space available to store a template */
+ /** No space available to store a template */
ERROR_NO_SPACE = 4,
- /* The current operation has been canceled */
+ /** The current operation has been canceled */
ERROR_CANCELED = 5,
- /* Unable to remove a template */
+ /** Unable to remove a template */
ERROR_UNABLE_TO_REMOVE = 6,
- /* The hardware is in lockout due to too many attempts */
+ /** The hardware is in lockout due to too many attempts */
ERROR_LOCKOUT = 7,
- /* Vendor-specific error message */
+ /** Vendor-specific error message */
ERROR_VENDOR = 8
};
-/*
+/**
* Fingerprint acquisition info is meant as feedback for the current operation.
* Anything but ACQUIRED_GOOD must be shown to the user as feedback on how to
* take action on the current operation. For example, ACQUIRED_IMAGER_DIRTY may
@@ -80,41 +80,43 @@
*/
enum FingerprintAcquiredInfo : int32_t {
ACQUIRED_GOOD = 0,
- /* sensor needs more data, i.e. longer swipe. */
+ /** sensor needs more data, i.e. longer swipe. */
ACQUIRED_PARTIAL = 1,
- /* image doesn't contain enough detail for recognition*/
+ /**
+ * image doesn't contain enough detail for recognition*/
ACQUIRED_INSUFFICIENT = 2,
- /* sensor needs to be cleaned */
+ /** sensor needs to be cleaned */
ACQUIRED_IMAGER_DIRTY = 3,
- /* mostly swipe-type sensors; not enough data collected */
+ /** mostly swipe-type sensors; not enough data collected */
ACQUIRED_TOO_SLOW = 4,
- /* vendor-specific acquisition messages start here */
+ /** vendor-specific acquisition messages start here */
ACQUIRED_TOO_FAST = 5,
- /* vendor-specific acquisition messages */
+ /** vendor-specific acquisition messages */
ACQUIRED_VENDOR = 6
};
struct FingerprintFingerId {
- /* Group ID */
+ /** Group ID */
uint32_t gid;
- /* Fingerprint template ID */
+ /** Fingerprint template ID */
uint32_t fid;
};
struct FingerprintEnroll {
- /* Template ID */
+ /** Template ID */
FingerprintFingerId finger;
- /* samplesRemaining goes from N (no data collected, but N scans needed)
+ /**
+ * samplesRemaining goes from N (no data collected, but N scans needed)
* to 0 (no more data is needed to build a template). */
uint32_t samplesRemaining;
- /* Vendor specific message. Used for user guidance */
+ /** Vendor specific message. Used for user guidance */
uint64_t msg;
};
struct FingerprintIterator {
- /* Template ID */
+ /** Template ID */
FingerprintFingerId finger;
- /* How many templates remain to iterate through */
+ /** How many templates remain to iterate through */
uint32_t remainingTemplates;
};
@@ -122,18 +124,18 @@
typedef FingerprintIterator FingerprintRemoved;
struct FingerprintAcquired {
- /* information about the image */
+ /** information about the image */
FingerprintAcquiredInfo acquiredInfo;
};
struct FingerprintAuthenticated {
- /* Matched template ID */
+ /** Matched template ID */
FingerprintFingerId finger;
- /* Authentication result from the keymaster */
+ /** Authentication result from the keymaster */
uint8_t[69] hat;
};
-/* Run time type identification for the notify() call payload. */
+/** Run time type identification for the notify() call payload. */
enum FingerprintMsgType : int32_t {
ERROR = -1,
ACQUIRED = 1,