zqz/platform-external-webrtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Echo cancellation functions docs: Follow style guide w.r.t. placement of *

Browse Source 
The style guide says to use "void* x", not void *x", and the code in
these files already do so, but the comments do not. Fix that.

Also, in the interest of reducing eye strain, I fixed the vertical
alignment in a small number of cases.

BUG=
R=aluebs@webrtc.org, andrew@webrtc.org

Review URL: https://webrtc-codereview.appspot.com/12509004

git-svn-id: http://webrtc.googlecode.com/svn/trunk@6101 4adac7df-926f-26a2-2b94-8c16560cd09d
This commit is contained in:
kwiberg@webrtc.org
2014-05-12 09:55:19 +00:00
parent 66021e0fa2
commit 924e81f797
2 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
webrtc/modules/audio_processing/aec/include/echo_cancellation.h
View File

@ -68,7 +68,7 @@ extern "C" {
*
* Inputs Description
* -------------------------------------------------------------------
* void **aecInst Pointer to the AEC instance to be created
* void** aecInst Pointer to the AEC instance to be created
* and initialized
*
* Outputs Description
@ -83,7 +83,7 @@ int32_t WebRtcAec_Create(void** aecInst);
*
* Inputs Description
* -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance
* void* aecInst Pointer to the AEC instance
*
* Outputs Description
* -------------------------------------------------------------------
@ -97,7 +97,7 @@ int32_t WebRtcAec_Free(void* aecInst);
*
* Inputs Description
* -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance
* void* aecInst Pointer to the AEC instance
* int32_t sampFreq Sampling frequency of data
* int32_t scSampFreq Soundcard sampling frequency
*
@ -113,8 +113,8 @@ int32_t WebRtcAec_Init(void* aecInst, int32_t sampFreq, int32_t scSampFreq);
*
* Inputs Description
* -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance
* int16_t *farend In buffer containing one frame of
* void* aecInst Pointer to the AEC instance
* int16_t* farend In buffer containing one frame of
* farend signal for L band
* int16_t nrOfSamples Number of samples in farend buffer
*
@ -132,10 +132,10 @@ int32_t WebRtcAec_BufferFarend(void* aecInst,
*
* Inputs Description
* -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance
* int16_t *nearend In buffer containing one frame of
* void* aecInst Pointer to the AEC instance
* int16_t* nearend In buffer containing one frame of
* nearend+echo signal for L band
* int16_t *nearendH In buffer containing one frame of
* int16_t* nearendH In buffer containing one frame of
* nearend+echo signal for H band
* int16_t nrOfSamples Number of samples in nearend buffer
* int16_t msInSndCardBuf Delay estimate for sound card and
@ -146,9 +146,9 @@ int32_t WebRtcAec_BufferFarend(void* aecInst,
*
* Outputs Description
* -------------------------------------------------------------------
* int16_t *out Out buffer, one frame of processed nearend
* int16_t* out Out buffer, one frame of processed nearend
* for L band
* int16_t *outH Out buffer, one frame of processed nearend
* int16_t* outH Out buffer, one frame of processed nearend
* for H band
* int32_t return 0: OK
* -1: error
@ -167,7 +167,7 @@ int32_t WebRtcAec_Process(void* aecInst,
*
* Inputs Description
* -------------------------------------------------------------------
* void *handle Pointer to the AEC instance
* void* handle Pointer to the AEC instance
* AecConfig config Config instance that contains all
* properties to be set
*
@ -183,11 +183,11 @@ int WebRtcAec_set_config(void* handle, AecConfig config);
*
* Inputs Description
* -------------------------------------------------------------------
* void *handle Pointer to the AEC instance
* void* handle Pointer to the AEC instance
*
* Outputs Description
* -------------------------------------------------------------------
* int *status 0: Almost certainly nearend single-talk
* int* status 0: Almost certainly nearend single-talk
* 1: Might not be neared single-talk
* int return 0: OK
* -1: error
@ -199,11 +199,11 @@ int WebRtcAec_get_echo_status(void* handle, int* status);
*
* Inputs Description
* -------------------------------------------------------------------
* void *handle Pointer to the AEC instance
* void* handle Pointer to the AEC instance
*
* Outputs Description
* -------------------------------------------------------------------
* AecMetrics *metrics Struct which will be filled out with the
* AecMetrics* metrics Struct which will be filled out with the
* current echo metrics.
* int return 0: OK
* -1: error
@ -232,7 +232,7 @@ int WebRtcAec_GetDelayMetrics(void* handle, int* median, int* std);
*
* Inputs Description
* -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance
* void* aecInst Pointer to the AEC instance
*
* Outputs Description
* -------------------------------------------------------------------