Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/audio/2.0/IStreamOut.hal b/audio/2.0/IStreamOut.hal
index 9ee32c5..84b7447 100644
--- a/audio/2.0/IStreamOut.hal
+++ b/audio/2.0/IStreamOut.hal
@@ -23,14 +23,14 @@
interface IStreamOut extends IStream {
typedef android.hardware.audio@2.0::Result Result;
- /*
+ /**
* Return the audio hardware driver estimated latency in milliseconds.
*
* @return latencyMs latency in milliseconds.
*/
getLatency() generates (uint32_t latencyMs);
- /*
+ /**
* This method is used in situations where audio mixing is done in the
* hardware. This method serves as a direct interface with hardware,
* allowing to directly set the volume as apposed to via the framework.
@@ -43,7 +43,7 @@
*/
setVolume(float left, float right) generates (Result retval);
- /*
+ /**
* Commands that can be executed on the driver writer thread.
*/
enum WriteCommand : int32_t {
@@ -52,7 +52,7 @@
GET_LATENCY
};
- /*
+ /**
* Data structure passed back to the client via status message queue
* of 'write' operation.
*
@@ -75,7 +75,7 @@
} reply;
};
- /*
+ /**
* Set up required transports for passing audio buffers to the driver.
*
* The transport consists of three message queues:
@@ -112,7 +112,7 @@
fmq_sync<WriteStatus> statusMQ,
ThreadInfo threadInfo);
- /*
+ /**
* Return the number of audio frames written by the audio DSP to DAC since
* the output has exited standby.
*
@@ -121,7 +121,7 @@
*/
getRenderPosition() generates (Result retval, uint32_t dspFrames);
- /*
+ /**
* Get the local time at which the next write to the audio driver will be
* presented. The units are microseconds, where the epoch is decided by the
* local audio HAL.
@@ -131,7 +131,7 @@
*/
getNextWriteTimestamp() generates (Result retval, int64_t timestampUs);
- /*
+ /**
* Set the callback interface for notifying completion of non-blocking
* write and drain.
*
@@ -146,7 +146,7 @@
*/
setCallback(IStreamOutCallback callback) generates (Result retval);
- /*
+ /**
* Clears the callback previously set via 'setCallback' method.
*
* Warning: failure to call this method results in callback implementation
@@ -156,7 +156,7 @@
*/
clearCallback() generates (Result retval);
- /*
+ /**
* Returns whether HAL supports pausing and resuming of streams.
*
* @return supportsPause true if pausing is supported.
@@ -179,7 +179,7 @@
*/
pause() generates (Result retval);
- /*
+ /**
* Notifies to the audio driver to resume playback following a pause.
* Returns error INVALID_STATE if called without matching pause.
*
@@ -189,7 +189,7 @@
*/
resume() generates (Result retval);
- /*
+ /**
* Returns whether HAL supports draining of streams.
*
* @return supports true if draining is supported.
@@ -220,7 +220,7 @@
*/
drain(AudioDrain type) generates (Result retval);
- /*
+ /**
* Notifies to the audio driver to flush the queued data. Stream must
* already be paused before calling 'flush'.
*
@@ -230,7 +230,7 @@
*/
flush() generates (Result retval);
- /*
+ /**
* Return a recent count of the number of audio frames presented to an
* external observer. This excludes frames which have been written but are
* still in the pipeline. The count is not reset to zero when output enters