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.