Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/audio/effect/2.0/IEffect.hal b/audio/effect/2.0/IEffect.hal
index d254e8c..332e2df 100644
--- a/audio/effect/2.0/IEffect.hal
+++ b/audio/effect/2.0/IEffect.hal
@@ -20,7 +20,7 @@
import IEffectBufferProviderCallback;
interface IEffect {
- /*
+ /**
* Initialize effect engine--all configurations return to default.
*
* @return retval operation completion status.
@@ -29,7 +29,7 @@
@callflow(next={"*"})
init() generates (Result retval);
- /*
+ /**
* Apply new audio parameters configurations for input and output buffers.
* The provider callbacks may be empty, but in this case the buffer
* must be provided in the EffectConfig structure.
@@ -45,7 +45,7 @@
IEffectBufferProviderCallback outputBufferProvider)
generates (Result retval);
- /*
+ /**
* Reset the effect engine. Keep configuration but resets state and buffer
* content.
*
@@ -54,7 +54,7 @@
@callflow(next={"*"})
reset() generates (Result retval);
- /*
+ /**
* Enable processing.
*
* @return retval operation completion status.
@@ -62,7 +62,7 @@
@callflow(next={"prepareForProcessing"})
enable() generates (Result retval);
- /*
+ /**
* Disable processing.
*
* @return retval operation completion status.
@@ -70,7 +70,7 @@
@callflow(next={"close"})
disable() generates (Result retval);
- /*
+ /**
* Set the rendering device the audio output path is connected to. The
* effect implementation must set EFFECT_FLAG_DEVICE_IND flag in its
* descriptor to receive this command when the device changes.
@@ -84,7 +84,7 @@
@callflow(next={"*"})
setDevice(AudioDevice device) generates (Result retval);
- /*
+ /**
* Set and get volume. Used by audio framework to delegate volume control to
* effect engine. The effect implementation must set EFFECT_FLAG_VOLUME_CTRL
* flag in its descriptor to receive this command. The effect engine must
@@ -103,7 +103,7 @@
setAndGetVolume(vec<uint32_t> volumes)
generates (Result retval, vec<uint32_t> result);
- /*
+ /**
* Notify the effect of the volume change. The effect implementation must
* set EFFECT_FLAG_VOLUME_IND flag in its descriptor to receive this
* command.
@@ -116,7 +116,7 @@
volumeChangeNotification(vec<uint32_t> volumes)
generates (Result retval);
- /*
+ /**
* Set the audio mode. The effect implementation must set
* EFFECT_FLAG_AUDIO_MODE_IND flag in its descriptor to receive this command
* when the audio mode changes.
@@ -127,7 +127,7 @@
@callflow(next={"*"})
setAudioMode(AudioMode mode) generates (Result retval);
- /*
+ /**
* Apply new audio parameters configurations for input and output buffers of
* reverse stream. An example of reverse stream is the echo reference
* supplied to an Acoustic Echo Canceler.
@@ -143,7 +143,7 @@
IEffectBufferProviderCallback outputBufferProvider)
generates (Result retval);
- /*
+ /**
* Set the capture device the audio input path is connected to. The effect
* implementation must set EFFECT_FLAG_DEVICE_IND flag in its descriptor to
* receive this command when the device changes.
@@ -157,7 +157,7 @@
@callflow(next={"*"})
setInputDevice(AudioDevice device) generates (Result retval);
- /*
+ /**
* Read audio parameters configurations for input and output buffers.
*
* @return retval operation completion status.
@@ -166,7 +166,7 @@
@callflow(next={"*"})
getConfig() generates (Result retval, EffectConfig config);
- /*
+ /**
* Read audio parameters configurations for input and output buffers of
* reverse stream.
*
@@ -176,7 +176,7 @@
@callflow(next={"*"})
getConfigReverse() generates (Result retval, EffectConfig config);
- /*
+ /**
* Queries for supported combinations of main and auxiliary channels
* (e.g. for a multi-microphone noise suppressor).
*
@@ -190,7 +190,7 @@
getSupportedAuxChannelsConfigs(uint32_t maxConfigs)
generates (Result retval, vec<EffectAuxChannelsConfig> result);
- /*
+ /**
* Retrieves the current configuration of main and auxiliary channels.
*
* @return retval absence of the feature support is indicated using
@@ -201,7 +201,7 @@
getAuxChannelsConfig()
generates (Result retval, EffectAuxChannelsConfig result);
- /*
+ /**
* Sets the current configuration of main and auxiliary channels.
*
* @return retval operation completion status; absence of the feature
@@ -211,7 +211,7 @@
setAuxChannelsConfig(EffectAuxChannelsConfig config)
generates (Result retval);
- /*
+ /**
* Set the audio source the capture path is configured for (Camcorder, voice
* recognition...).
*
@@ -224,7 +224,7 @@
@callflow(next={"*"})
setAudioSource(AudioSource source) generates (Result retval);
- /*
+ /**
* This command indicates if the playback thread the effect is attached to
* is offloaded or not, and updates the I/O handle of the playback thread
* the effect is attached to.
@@ -235,7 +235,7 @@
@callflow(next={"*"})
offload(EffectOffloadParameter param) generates (Result retval);
- /*
+ /**
* Returns the effect descriptor.
*
* @return retval operation completion status.
@@ -244,7 +244,7 @@
@callflow(next={"*"})
getDescriptor() generates (Result retval, EffectDescriptor descriptor);
- /*
+ /**
* Set up required transports for passing audio buffers to the effect.
*
* The transport consists of shared memory and a message queue for reporting
@@ -270,7 +270,7 @@
@callflow(next={"setProcessBuffers"})
prepareForProcessing() generates (Result retval, fmq_sync<Result> statusMQ);
- /*
+ /**
* Set up input and output buffers for processing audio data. The effect
* may modify both the input and the output buffer during the operation.
* Buffers may be set multiple times during effect lifetime.
@@ -289,7 +289,7 @@
setProcessBuffers(AudioBuffer inBuffer, AudioBuffer outBuffer) generates (
Result retval);
- /*
+ /**
* Execute a vendor specific command on the effect. The command code
* and data, as well as result data are not interpreted by Android
* Framework and are passed as-is between the application and the effect.
@@ -310,7 +310,7 @@
command(uint32_t commandId, vec<uint8_t> data, uint32_t resultMaxSize)
generates (int32_t status, vec<uint8_t> result);
- /*
+ /**
* Set a vendor-specific parameter and apply it immediately. The parameter
* code and data are not interpreted by Android Framework and are passed
* as-is between the application and the effect.
@@ -331,7 +331,7 @@
setParameter(vec<uint8_t> parameter, vec<uint8_t> value)
generates (Result retval);
- /*
+ /**
* Get a vendor-specific parameter value. The parameter code and returned
* data are not interpreted by Android Framework and are passed as-is
* between the application and the effect.
@@ -353,7 +353,7 @@
getParameter(vec<uint8_t> parameter, uint32_t valueMaxSize)
generates (Result retval, vec<uint8_t> value);
- /*
+ /**
* Get supported configs for a vendor-specific feature. The configs returned
* are not interpreted by Android Framework and are passed as-is between the
* application and the effect.
@@ -384,7 +384,7 @@
uint32_t configsCount,
vec<uint8_t> configsData);
- /*
+ /**
* Get the current config for a vendor-specific feature. The config returned
* is not interpreted by Android Framework and is passed as-is between the
* application and the effect.
@@ -406,7 +406,7 @@
getCurrentConfigForFeature(uint32_t featureId, uint32_t configSize)
generates (Result retval, vec<uint8_t> configData);
- /*
+ /**
* Set the current config for a vendor-specific feature. The config data
* is not interpreted by Android Framework and is passed as-is between the
* application and the effect.
@@ -426,7 +426,7 @@
setCurrentConfigForFeature(uint32_t featureId, vec<uint8_t> configData)
generates (Result retval);
- /*
+ /**
* Called by the framework to deinitialize the effect and free up
* all the currently allocated resources. It is recommended to close
* the effect on the client side as soon as it is becomes unused.