Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: make
Change-Id: Ic77394d4d2e1ccedba3a28230d870c5d6108bd40
diff --git a/tests/msgq/1.0/IBenchmarkMsgQ.hal b/tests/msgq/1.0/IBenchmarkMsgQ.hal
index 81754a4..6ee3485 100644
--- a/tests/msgq/1.0/IBenchmarkMsgQ.hal
+++ b/tests/msgq/1.0/IBenchmarkMsgQ.hal
@@ -17,7 +17,7 @@
package android.hardware.tests.msgq@1.0;
interface IBenchmarkMsgQ {
- /*
+ /**
* This method requests the service to set up Synchronous read/write
* wait-free FMQ with the client as reader.
* @return ret Will be true if the setup was successful, false otherwise.
@@ -27,7 +27,7 @@
configureClientInboxSyncReadWrite()
generates(bool ret, fmq_sync<uint8_t> mqDescIn);
- /*
+ /**
* This method requests the service to set up Synchronous read/write
* wait-free FMQ with the client as writer.
* @return ret Will be true if the setup was successful, false otherwise.
@@ -37,7 +37,7 @@
configureClientOutboxSyncReadWrite()
generates(bool ret, fmq_sync<uint8_t> mqDescOut);
- /*
+ /**
* This method request the service to write into the FMQ.
* @param count Number to messages to write.
* @return ret Will be true if the write operation was successful,
@@ -45,14 +45,14 @@
*/
requestWrite(int32_t count) generates (bool ret);
- /*
+ /**
* This method request the service to read from the FMQ.
* @param count Number to messages to read.
* @ret Will be true if the read operation was successful, false otherwise.
*/
requestRead(int32_t count) generates (bool ret);
- /*
+ /**
* This method kicks off a benchmarking experiment where
* the client writes a message into its outbox FMQ,
* the service reads it and writes it into the client's
@@ -62,14 +62,14 @@
*/
benchmarkPingPong(uint32_t numIter);
- /*
+ /**
* This method kicks off a benchmarking experiment where
* the service writes into an FMQ and the client reads the same.
* @param numIter The number of iterations to run the experiment.
*/
benchmarkServiceWriteClientRead(uint32_t numIter);
- /*
+ /**
* This method sends a vector of time duration(in ns).
* @param timeData vector of time instants measured by client.
* Each entry is the number of ns between the epoch and a
diff --git a/tests/msgq/1.0/ITestMsgQ.hal b/tests/msgq/1.0/ITestMsgQ.hal
index dfb9be4..350e26d 100644
--- a/tests/msgq/1.0/ITestMsgQ.hal
+++ b/tests/msgq/1.0/ITestMsgQ.hal
@@ -22,7 +22,7 @@
FMQ_NOT_FULL = 1 << 1,
};
- /*
+ /**
* This method requests the service to set up a synchronous read/write
* wait-free FMQ with the client as reader.
*
@@ -33,7 +33,7 @@
configureFmqSyncReadWrite()
generates(bool ret, fmq_sync<uint16_t> mqDesc);
- /*
+ /**
* This method requests the service to return an MQDescriptor to
* an unsynchronized FMQ set up by the server. If 'configureFmq' is
* true, then the server sets up a new unsynchronized FMQ. This
@@ -48,7 +48,7 @@
*/
getFmqUnsyncWrite(bool configureFmq) generates(bool ret, fmq_unsync<uint16_t> mqDesc);
- /*
+ /**
* This method request the service to write into the synchronized read/write
* flavor of the FMQ.
*
@@ -58,7 +58,7 @@
*/
requestWriteFmqSync(int32_t count) generates(bool ret);
- /*
+ /**
* This method request the service to read from the synchronized read/write
* FMQ.
*
@@ -68,7 +68,7 @@
*/
requestReadFmqSync(int32_t count) generates(bool ret);
- /*
+ /**
* This method request the service to write into the unsynchronized flavor
* of FMQ.
*
@@ -78,7 +78,7 @@
*/
requestWriteFmqUnsync(int32_t count) generates(bool ret);
- /*
+ /**
* This method request the service to read from the unsynchronized flavor of
* FMQ.
*
@@ -88,7 +88,7 @@
*/
requestReadFmqUnsync(int32_t count) generates(bool ret);
- /*
+ /**
* This method requests the service to trigger a blocking read.
*
* @param count Number of messages to read.
@@ -96,7 +96,7 @@
*/
oneway requestBlockingRead(int32_t count);
- /*
+ /**
* This method requests the service to trigger a blocking read using
* default Event Flag notification bits defined by the MessageQueue class.
*
@@ -105,7 +105,7 @@
*/
oneway requestBlockingReadDefaultEventFlagBits(int32_t count);
- /*
+ /**
* This method requests the service to repeatedly trigger blocking reads.
*
* @param count Number of messages to read in a single blocking read.