Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/audio/effect/2.0/IAcousticEchoCancelerEffect.hal b/audio/effect/2.0/IAcousticEchoCancelerEffect.hal
index 9e2e0c3..b5f94a5 100644
--- a/audio/effect/2.0/IAcousticEchoCancelerEffect.hal
+++ b/audio/effect/2.0/IAcousticEchoCancelerEffect.hal
@@ -20,12 +20,12 @@
import IEffect;
interface IAcousticEchoCancelerEffect extends IEffect {
- /*
+ /**
* Sets echo delay value in milliseconds.
*/
setEchoDelay(uint32_t echoDelayMs) generates (Result retval);
- /*
+ /**
* Gets echo delay value in milliseconds.
*/
getEchoDelay() generates (Result retval, uint32_t echoDelayMs);
diff --git a/audio/effect/2.0/IAutomaticGainControlEffect.hal b/audio/effect/2.0/IAutomaticGainControlEffect.hal
index a02002d..b8ca7e3 100644
--- a/audio/effect/2.0/IAutomaticGainControlEffect.hal
+++ b/audio/effect/2.0/IAutomaticGainControlEffect.hal
@@ -20,32 +20,32 @@
import IEffect;
interface IAutomaticGainControlEffect extends IEffect {
- /*
+ /**
* Sets target level in millibels.
*/
setTargetLevel(int16_t targetLevelMb) generates (Result retval);
- /*
+ /**
* Gets target level.
*/
getTargetLevel() generates (Result retval, int16_t targetLevelMb);
- /*
+ /**
* Sets gain in the compression range in millibels.
*/
setCompGain(int16_t compGainMb) generates (Result retval);
- /*
+ /**
* Gets gain in the compression range.
*/
getCompGain() generates (Result retval, int16_t compGainMb);
- /*
+ /**
* Enables or disables limiter.
*/
setLimiterEnabled(bool enabled) generates (Result retval);
- /*
+ /**
* Returns whether limiter is enabled.
*/
isLimiterEnabled() generates (Result retval, bool enabled);
@@ -56,12 +56,12 @@
bool limiterEnabled;
};
- /*
+ /**
* Sets all properties at once.
*/
setAllProperties(AllProperties properties) generates (Result retval);
- /*
+ /**
* Gets all properties at once.
*/
getAllProperties() generates (Result retval, AllProperties properties);
diff --git a/audio/effect/2.0/IBassBoostEffect.hal b/audio/effect/2.0/IBassBoostEffect.hal
index bcf7b7d..db6a297 100644
--- a/audio/effect/2.0/IBassBoostEffect.hal
+++ b/audio/effect/2.0/IBassBoostEffect.hal
@@ -20,7 +20,7 @@
import IEffect;
interface IBassBoostEffect extends IEffect {
- /*
+ /**
* Returns whether setting bass boost strength is supported.
*/
isStrengthSupported() generates (Result retval, bool strengthSupported);
@@ -30,7 +30,7 @@
MAX = 1000
};
- /*
+ /**
* Sets bass boost strength.
*
* @param strength strength of the effect. The valid range for strength
@@ -41,7 +41,7 @@
*/
setStrength(uint16_t strength) generates (Result retval);
- /*
+ /**
* Gets virtualization strength.
*/
getStrength() generates (Result retval, uint16_t strength);
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.
diff --git a/audio/effect/2.0/IEffectBufferProviderCallback.hal b/audio/effect/2.0/IEffectBufferProviderCallback.hal
index 53f4d6e..6ab33c3 100644
--- a/audio/effect/2.0/IEffectBufferProviderCallback.hal
+++ b/audio/effect/2.0/IEffectBufferProviderCallback.hal
@@ -16,12 +16,12 @@
package android.hardware.audio.effect@2.0;
-/*
+/**
* This callback interface contains functions that can be used by the effect
* engine 'process' function to exchange input and output audio buffers.
*/
interface IEffectBufferProviderCallback {
- /*
+ /**
* Called to retrieve a buffer where data should read from by 'process'
* function.
*
@@ -29,7 +29,7 @@
*/
getBuffer() generates (AudioBuffer buffer);
- /*
+ /**
* Called to provide a buffer with the data written by 'process' function.
*
* @param buffer audio buffer for processing
diff --git a/audio/effect/2.0/IEffectsFactory.hal b/audio/effect/2.0/IEffectsFactory.hal
index c82b4a2..3d300ec 100644
--- a/audio/effect/2.0/IEffectsFactory.hal
+++ b/audio/effect/2.0/IEffectsFactory.hal
@@ -20,7 +20,7 @@
import IEffect;
interface IEffectsFactory {
- /*
+ /**
* Returns descriptors of different effects in all loaded libraries.
*
* @return retval operation completion status.
@@ -28,7 +28,7 @@
*/
getAllDescriptors() generates(Result retval, vec<EffectDescriptor> result);
- /*
+ /**
* Returns a descriptor of a particular effect.
*
* @return retval operation completion status.
@@ -36,7 +36,7 @@
*/
getDescriptor(Uuid uid) generates(Result retval, EffectDescriptor result);
- /*
+ /**
* Creates an effect engine of the specified type. To release the effect
* engine, it is necessary to release references to the returned effect
* object.
@@ -56,7 +56,7 @@
createEffect(Uuid uid, AudioSession session, AudioIoHandle ioHandle)
generates (Result retval, IEffect result, uint64_t effectId);
- /*
+ /**
* Dumps information about effects into the provided file descriptor.
* This is used for the dumpsys facility.
*
diff --git a/audio/effect/2.0/IEnvironmentalReverbEffect.hal b/audio/effect/2.0/IEnvironmentalReverbEffect.hal
index d9b1ee6..dca89f9 100644
--- a/audio/effect/2.0/IEnvironmentalReverbEffect.hal
+++ b/audio/effect/2.0/IEnvironmentalReverbEffect.hal
@@ -20,12 +20,12 @@
import IEffect;
interface IEnvironmentalReverbEffect extends IEffect {
- /*
+ /**
* Sets whether the effect should be bypassed.
*/
setBypass(bool bypass) generates (Result retval);
- /*
+ /**
* Gets whether the effect should be bypassed.
*/
getBypass() generates (Result retval, bool bypass);
@@ -53,102 +53,102 @@
DENSITY_MAX = 1000
};
- /*
+ /**
* Sets the room level.
*/
setRoomLevel(int16_t roomLevel) generates (Result retval);
- /*
+ /**
* Gets the room level.
*/
getRoomLevel() generates (Result retval, int16_t roomLevel);
- /*
+ /**
* Sets the room high frequences level.
*/
setRoomHfLevel(int16_t roomHfLevel) generates (Result retval);
- /*
+ /**
* Gets the room high frequences level.
*/
getRoomHfLevel() generates (Result retval, int16_t roomHfLevel);
- /*
+ /**
* Sets the room decay time.
*/
setDecayTime(uint32_t decayTime) generates (Result retval);
- /*
+ /**
* Gets the room decay time.
*/
getDecayTime() generates (Result retval, uint32_t decayTime);
- /*
+ /**
* Sets the ratio of high frequences decay.
*/
setDecayHfRatio(int16_t decayHfRatio) generates (Result retval);
- /*
+ /**
* Gets the ratio of high frequences decay.
*/
getDecayHfRatio() generates (Result retval, int16_t decayHfRatio);
- /*
+ /**
* Sets the level of reflections in the room.
*/
setReflectionsLevel(int16_t reflectionsLevel) generates (Result retval);
- /*
+ /**
* Gets the level of reflections in the room.
*/
getReflectionsLevel() generates (Result retval, int16_t reflectionsLevel);
- /*
+ /**
* Sets the reflections delay in the room.
*/
setReflectionsDelay(uint32_t reflectionsDelay) generates (Result retval);
- /*
+ /**
* Gets the reflections delay in the room.
*/
getReflectionsDelay() generates (Result retval, uint32_t reflectionsDelay);
- /*
+ /**
* Sets the reverb level of the room.
*/
setReverbLevel(int16_t reverbLevel) generates (Result retval);
- /*
+ /**
* Gets the reverb level of the room.
*/
getReverbLevel() generates (Result retval, int16_t reverbLevel);
- /*
+ /**
* Sets the reverb delay of the room.
*/
setReverbDelay(uint32_t reverDelay) generates (Result retval);
- /*
+ /**
* Gets the reverb delay of the room.
*/
getReverbDelay() generates (Result retval, uint32_t reverbDelay);
- /*
+ /**
* Sets room diffusion.
*/
setDiffusion(int16_t diffusion) generates (Result retval);
- /*
+ /**
* Gets room diffusion.
*/
getDiffusion() generates (Result retval, int16_t diffusion);
- /*
+ /**
* Sets room wall density.
*/
setDensity(int16_t density) generates (Result retval);
- /*
+ /**
* Gets room wall density.
*/
getDensity() generates (Result retval, int16_t density);
@@ -166,12 +166,12 @@
int16_t density; // in permilles, range 0 to 1000
};
- /*
+ /**
* Sets all properties at once.
*/
setAllProperties(AllProperties properties) generates (Result retval);
- /*
+ /**
* Gets all properties at once.
*/
getAllProperties() generates (Result retval, AllProperties properties);
diff --git a/audio/effect/2.0/IEqualizerEffect.hal b/audio/effect/2.0/IEqualizerEffect.hal
index b8fa177..1528e0d 100644
--- a/audio/effect/2.0/IEqualizerEffect.hal
+++ b/audio/effect/2.0/IEqualizerEffect.hal
@@ -20,58 +20,58 @@
import IEffect;
interface IEqualizerEffect extends IEffect {
- /*
+ /**
* Gets the number of frequency bands that the equalizer supports.
*/
getNumBands() generates (Result retval, uint16_t numBands);
- /*
+ /**
* Returns the minimum and maximum band levels supported.
*/
getLevelRange()
generates (Result retval, int16_t minLevel, int16_t maxLevel);
- /*
+ /**
* Sets the gain for the given equalizer band.
*/
setBandLevel(uint16_t band, int16_t level) generates (Result retval);
- /*
+ /**
* Gets the gain for the given equalizer band.
*/
getBandLevel(uint16_t band) generates (Result retval, int16_t level);
- /*
+ /**
* Gets the center frequency of the given band, in milliHertz.
*/
getBandCenterFrequency(uint16_t band)
generates (Result retval, uint32_t centerFreqmHz);
- /*
+ /**
* Gets the frequency range of the given frequency band, in milliHertz.
*/
getBandFrequencyRange(uint16_t band)
generates (Result retval, uint32_t minFreqmHz, uint32_t maxFreqmHz);
- /*
+ /**
* Gets the band that has the most effect on the given frequency
* in milliHertz.
*/
getBandForFrequency(uint32_t freqmHz)
generates (Result retval, uint16_t band);
- /*
+ /**
* Gets the names of all presets the equalizer supports.
*/
getPresetNames() generates (Result retval, vec<string> names);
- /*
+ /**
* Sets the current preset using the index of the preset in the names
* vector returned via 'getPresetNames'.
*/
setCurrentPreset(uint16_t preset) generates (Result retval);
- /*
+ /**
* Gets the current preset.
*/
getCurrentPreset() generates (Result retval, uint16_t preset);
@@ -81,12 +81,12 @@
vec<int16_t> bandLevels;
};
- /*
+ /**
* Sets all properties at once.
*/
setAllProperties(AllProperties properties) generates (Result retval);
- /*
+ /**
* Gets all properties at once.
*/
getAllProperties() generates (Result retval, AllProperties properties);
diff --git a/audio/effect/2.0/ILoudnessEnhancerEffect.hal b/audio/effect/2.0/ILoudnessEnhancerEffect.hal
index 3e1ee4e..adeb1c8 100644
--- a/audio/effect/2.0/ILoudnessEnhancerEffect.hal
+++ b/audio/effect/2.0/ILoudnessEnhancerEffect.hal
@@ -20,12 +20,12 @@
import IEffect;
interface ILoudnessEnhancerEffect extends IEffect {
- /*
+ /**
* Sets target gain expressed in millibels.
*/
setTargetGain(int32_t targetGainMb) generates (Result retval);
- /*
+ /**
* Gets target gain expressed in millibels.
*/
getTargetGain() generates (Result retval, int32_t targetGainMb);
diff --git a/audio/effect/2.0/INoiseSuppressionEffect.hal b/audio/effect/2.0/INoiseSuppressionEffect.hal
index ae2bfb5..6617a1e 100644
--- a/audio/effect/2.0/INoiseSuppressionEffect.hal
+++ b/audio/effect/2.0/INoiseSuppressionEffect.hal
@@ -26,12 +26,12 @@
HIGH
};
- /*
+ /**
* Sets suppression level.
*/
setSuppressionLevel(Level level) generates (Result retval);
- /*
+ /**
* Gets suppression level.
*/
getSuppressionLevel() generates (Result retval, Level level);
@@ -41,12 +41,12 @@
MULTI_CHANNEL
};
- /*
+ /**
* Set suppression type.
*/
setSuppressionType(Type type) generates (Result retval);
- /*
+ /**
* Get suppression type.
*/
getSuppressionType() generates (Result retval, Type type);
@@ -56,12 +56,12 @@
Type type;
};
- /*
+ /**
* Sets all properties at once.
*/
setAllProperties(AllProperties properties) generates (Result retval);
- /*
+ /**
* Gets all properties at once.
*/
getAllProperties() generates (Result retval, AllProperties properties);
diff --git a/audio/effect/2.0/IVirtualizerEffect.hal b/audio/effect/2.0/IVirtualizerEffect.hal
index 2b7116c..49b49a0 100644
--- a/audio/effect/2.0/IVirtualizerEffect.hal
+++ b/audio/effect/2.0/IVirtualizerEffect.hal
@@ -20,7 +20,7 @@
import IEffect;
interface IVirtualizerEffect extends IEffect {
- /*
+ /**
* Returns whether setting virtualization strength is supported.
*/
isStrengthSupported() generates (bool strengthSupported);
@@ -30,7 +30,7 @@
MAX = 1000
};
- /*
+ /**
* Sets virtualization strength.
*
* @param strength strength of the effect. The valid range for strength
@@ -41,7 +41,7 @@
*/
setStrength(uint16_t strength) generates (Result retval);
- /*
+ /**
* Gets virtualization strength.
*/
getStrength() generates (Result retval, uint16_t strength);
@@ -56,19 +56,19 @@
int16_t elevation; // 0 is the horizontal plane
// +90 is above the listener, -90 is below
};
- /*
+ /**
* Retrieves virtual speaker angles for the given channel mask on the
* specified device.
*/
getVirtualSpeakerAngles(AudioChannelMask mask, AudioDevice device)
generates (Result retval, vec<SpeakerAngle> speakerAngles);
- /*
+ /**
* Forces the virtualizer effect for the given output device.
*/
forceVirtualizationMode(AudioDevice device) generates (Result retval);
- /*
+ /**
* Returns audio device reflecting the current virtualization mode,
* AUDIO_DEVICE_NONE when not virtualizing.
*/
diff --git a/audio/effect/2.0/IVisualizerEffect.hal b/audio/effect/2.0/IVisualizerEffect.hal
index 79dc9ee..fd3edbd 100644
--- a/audio/effect/2.0/IVisualizerEffect.hal
+++ b/audio/effect/2.0/IVisualizerEffect.hal
@@ -25,12 +25,12 @@
MIN = 128 // minimum capture size in samples
};
- /*
+ /**
* Sets the number PCM samples in the capture.
*/
setCaptureSize(uint16_t captureSize) generates (Result retval);
- /*
+ /**
* Gets the number PCM samples in the capture.
*/
getCaptureSize() generates (Result retval, uint16_t captureSize);
@@ -42,22 +42,22 @@
AS_PLAYED = 1
};
- /*
+ /**
* Specifies the way the captured data is scaled.
*/
setScalingMode(ScalingMode scalingMode) generates (Result retval);
- /*
+ /**
* Retrieves the way the captured data is scaled.
*/
getScalingMode() generates (Result retval, ScalingMode scalingMode);
- /*
+ /**
* Informs the visualizer about the downstream latency.
*/
setLatency(uint32_t latencyMs) generates (Result retval);
- /*
+ /**
* Gets the downstream latency.
*/
getLatency() generates (Result retval, uint32_t latencyMs);
@@ -69,19 +69,19 @@
PEAK_RMS = 0x1
};
- /*
+ /**
* Specifies which measurements are to be made.
*/
setMeasurementMode(MeasurementMode measurementMode)
generates (Result retval);
- /*
+ /**
* Retrieves which measurements are to be made.
*/
getMeasurementMode() generates (
Result retval, MeasurementMode measurementMode);
- /*
+ /**
* Retrieves the latest PCM snapshot captured by the visualizer engine. The
* number of samples to capture is specified by 'setCaptureSize' parameter.
*
@@ -99,7 +99,7 @@
} peakAndRms;
} value;
};
- /*
+ /**
* Retrieves the lastest measurements. The measurements to be made
* are specified by 'setMeasurementMode' parameter.
*
diff --git a/audio/effect/2.0/types.hal b/audio/effect/2.0/types.hal
index 0626ec5..2c5e4ef 100644
--- a/audio/effect/2.0/types.hal
+++ b/audio/effect/2.0/types.hal
@@ -27,7 +27,7 @@
RESULT_TOO_BIG
};
-/*
+/**
* Effect engine capabilities/requirements flags.
*
* Definitions for flags field of effect descriptor.
@@ -195,7 +195,7 @@
NO_PROCESS = 1 << NO_PROCESS_SHIFT
};
-/*
+/**
* The effect descriptor contains necessary information to facilitate the
* enumeration of the effect engines present in a library.
*/
@@ -212,7 +212,7 @@
uint8_t[64] implementor; // human readable effect implementor name
};
-/*
+/**
* A buffer is a chunk of audio data for processing. Multi-channel audio is
* always interleaved. The channel order is from LSB to MSB with regard to the
* channel mask definition in audio.h, audio_channel_mask_t, e.g.:
@@ -235,7 +235,7 @@
ACCESS_ACCUMULATE
};
-/*
+/**
* Determines what fields of EffectBufferConfig need to be considered.
*/
@export(name="", value_prefix="EFFECT_CONFIG_")
@@ -248,7 +248,7 @@
ALL = BUFFER | SMP_RATE | CHANNELS | FORMAT | ACC_MODE
};
-/*
+/**
* The buffer config structure specifies the input or output audio format
* to be used by the effect engine.
*/
@@ -285,7 +285,7 @@
// the effect is attached to
};
-/*
+/**
* The message queue flags used to synchronize reads and writes from
* the status message queue used by effects.
*/