From 924e81f797084e9a4e650ae66f42a5189868ebc9 Mon Sep 17 00:00:00 2001 From: "kwiberg@webrtc.org" Date: Mon, 12 May 2014 09:55:19 +0000 Subject: [PATCH] Echo cancellation functions docs: Follow style guide w.r.t. placement of * 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 --- .../aec/include/echo_cancellation.h | 32 +++++++------- .../aecm/include/echo_control_mobile.h | 44 +++++++++---------- 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/webrtc/modules/audio_processing/aec/include/echo_cancellation.h b/webrtc/modules/audio_processing/aec/include/echo_cancellation.h index 4c852cf64b..9d2bc4ef1b 100644 --- a/webrtc/modules/audio_processing/aec/include/echo_cancellation.h +++ b/webrtc/modules/audio_processing/aec/include/echo_cancellation.h @@ -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 * ------------------------------------------------------------------- diff --git a/webrtc/modules/audio_processing/aecm/include/echo_control_mobile.h b/webrtc/modules/audio_processing/aecm/include/echo_control_mobile.h index 8ea2e87e2f..ac43576dd2 100644 --- a/webrtc/modules/audio_processing/aecm/include/echo_control_mobile.h +++ b/webrtc/modules/audio_processing/aecm/include/echo_control_mobile.h @@ -45,7 +45,7 @@ extern "C" { * * Inputs Description * ------------------------------------------------------------------- - * void **aecmInst Pointer to the AECM instance to be + * void** aecmInst Pointer to the AECM instance to be * created and initialized * * Outputs Description @@ -60,11 +60,11 @@ int32_t WebRtcAecm_Create(void **aecmInst); * * Inputs Description * ------------------------------------------------------------------- - * void *aecmInst Pointer to the AECM instance + * void* aecmInst Pointer to the AECM instance * * Outputs Description * ------------------------------------------------------------------- - * int32_t return 0: OK + * int32_t return 0: OK * -1: error */ int32_t WebRtcAecm_Free(void *aecmInst); @@ -74,7 +74,7 @@ int32_t WebRtcAecm_Free(void *aecmInst); * * Inputs Description * ------------------------------------------------------------------- - * void *aecmInst Pointer to the AECM instance + * void* aecmInst Pointer to the AECM instance * int32_t sampFreq Sampling frequency of data * * Outputs Description @@ -89,8 +89,8 @@ int32_t WebRtcAecm_Init(void* aecmInst, int32_t sampFreq); * * Inputs Description * ------------------------------------------------------------------- - * void *aecmInst Pointer to the AECM instance - * int16_t *farend In buffer containing one frame of + * void* aecmInst Pointer to the AECM instance + * int16_t* farend In buffer containing one frame of * farend signal * int16_t nrOfSamples Number of samples in farend buffer * @@ -106,14 +106,14 @@ int32_t WebRtcAecm_BufferFarend(void* aecmInst, /* * Runs the AECM on an 80 or 160 sample blocks of data. * - * Inputs Description + * Inputs Description * ------------------------------------------------------------------- - * void *aecmInst Pointer to the AECM instance - * int16_t *nearendNoisy In buffer containing one frame of + * void* aecmInst Pointer to the AECM instance + * int16_t* nearendNoisy In buffer containing one frame of * reference nearend+echo signal. If * noise reduction is active, provide * the noisy signal here. - * int16_t *nearendClean In buffer containing one frame of + * int16_t* nearendClean In buffer containing one frame of * nearend+echo signal. If noise * reduction is active, provide the * clean signal here. Otherwise pass a @@ -122,11 +122,11 @@ int32_t WebRtcAecm_BufferFarend(void* aecmInst, * int16_t msInSndCardBuf Delay estimate for sound card and * system buffers * - * Outputs Description + * Outputs Description * ------------------------------------------------------------------- - * int16_t *out Out buffer, one frame of processed nearend - * int32_t return 0: OK - * -1: error + * int16_t* out Out buffer, one frame of processed nearend + * int32_t return 0: OK + * -1: error */ int32_t WebRtcAecm_Process(void* aecmInst, const int16_t* nearendNoisy, @@ -140,8 +140,8 @@ int32_t WebRtcAecm_Process(void* aecmInst, * * Inputs Description * ------------------------------------------------------------------- - * void *aecmInst Pointer to the AECM instance - * AecmConfig config Config instance that contains all + * void* aecmInst Pointer to the AECM instance + * AecmConfig config Config instance that contains all * properties to be set * * Outputs Description @@ -156,11 +156,11 @@ int32_t WebRtcAecm_set_config(void* aecmInst, AecmConfig config); * * Inputs Description * ------------------------------------------------------------------- - * void *aecmInst Pointer to the AECM instance + * void* aecmInst Pointer to the AECM instance * * Outputs Description * ------------------------------------------------------------------- - * AecmConfig *config Pointer to the config instance that + * AecmConfig* config Pointer to the config instance that * all properties will be written to * int32_t return 0: OK * -1: error @@ -178,7 +178,7 @@ int32_t WebRtcAecm_get_config(void *aecmInst, AecmConfig *config); * * Outputs Description * ------------------------------------------------------------------- - * int32_t return 0: OK + * int32_t return 0: OK * -1: error */ int32_t WebRtcAecm_InitEchoPath(void* aecmInst, @@ -197,7 +197,7 @@ int32_t WebRtcAecm_InitEchoPath(void* aecmInst, * * Outputs Description * ------------------------------------------------------------------- - * int32_t return 0: OK + * int32_t return 0: OK * -1: error */ int32_t WebRtcAecm_GetEchoPath(void* aecmInst, @@ -209,7 +209,7 @@ int32_t WebRtcAecm_GetEchoPath(void* aecmInst, * * Outputs Description * ------------------------------------------------------------------- - * size_t return : size in bytes + * size_t return Size in bytes */ size_t WebRtcAecm_echo_path_size_bytes(); @@ -218,7 +218,7 @@ size_t WebRtcAecm_echo_path_size_bytes(); * * Inputs Description * ------------------------------------------------------------------- - * void *aecmInst Pointer to the AECM instance + * void* aecmInst Pointer to the AECM instance * * Outputs Description * -------------------------------------------------------------------