diff options
| author | Mark Harris <mark.hsj@gmail.com> | 2022-07-05 20:12:43 -0700 |
|---|---|---|
| committer | Mark Harris <mark.hsj@gmail.com> | 2022-07-05 20:14:10 -0700 |
| commit | 51fb8955e44ee9ccefd0212f67c7dd6fc7184be0 (patch) | |
| tree | a7c4939cdd6cae153449b63869175e8ced2dc24a | |
| parent | 99afa9c48e934711f5b07a917b68411353453338 (diff) | |
| download | opus-51fb8955e44ee9ccefd0212f67c7dd6fc7184be0.tar.gz | |
doc: Use consistent alternative notation
Signed-off-by: Mark Harris <mark.hsj@gmail.com>
| -rw-r--r-- | include/opus.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/opus.h b/include/opus.h index 0a4e508a..0c69c627 100644 --- a/include/opus.h +++ b/include/opus.h @@ -198,7 +198,7 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_encoder_get_size(int channels); * This must be one of 8000, 12000, 16000, * 24000, or 48000. * @param [in] channels <tt>int</tt>: Number of channels (1 or 2) in input signal - * @param [in] application <tt>int</tt>: Coding mode (@ref OPUS_APPLICATION_VOIP|@ref OPUS_APPLICATION_AUDIO|@ref OPUS_APPLICATION_RESTRICTED_LOWDELAY) + * @param [in] application <tt>int</tt>: Coding mode (one of @ref OPUS_APPLICATION_VOIP, @ref OPUS_APPLICATION_AUDIO, or @ref OPUS_APPLICATION_RESTRICTED_LOWDELAY) * @param [out] error <tt>int*</tt>: @ref opus_errorcodes * @note Regardless of the sampling rate and number channels selected, the Opus encoder * can switch to a lower audio bandwidth or number of channels if the bitrate @@ -222,7 +222,7 @@ OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusEncoder *opus_encoder_create( * This must be one of 8000, 12000, 16000, * 24000, or 48000. * @param [in] channels <tt>int</tt>: Number of channels (1 or 2) in input signal - * @param [in] application <tt>int</tt>: Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO/OPUS_APPLICATION_RESTRICTED_LOWDELAY) + * @param [in] application <tt>int</tt>: Coding mode (one of OPUS_APPLICATION_VOIP, OPUS_APPLICATION_AUDIO, or OPUS_APPLICATION_RESTRICTED_LOWDELAY) * @retval #OPUS_OK Success or @ref opus_errorcodes */ OPUS_EXPORT int opus_encoder_init( |