Skip to content
Snippets Groups Projects
Commit 48069bf9 authored by Gregory Maxwell's avatar Gregory Maxwell
Browse files

Documentation and build script updates.

parent 25f7f355
No related branches found
No related tags found
No related merge requests found
......@@ -112,7 +112,7 @@ extern "C" {
/** @endcond */
/** @defgroup encoderctls Encoder related CTLs
* @see opus_encoder_ctl
* @see genericctls,opusencoder
* @{
*/
/** @cond DOXYGEN_EXCLUDE */
......@@ -135,7 +135,7 @@ extern "C" {
/** Configures the encoder's computational complexity.
* The supported range is 0-10 inclusive with 10 representing the highest complexity.
* The default value is inconsistent between modes
* The default value is 10.
* @param[in] x <tt>int</tt>: 0-10, inclusive
* @hideinitializer */
#define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
......@@ -201,7 +201,7 @@ extern "C" {
* @hideinitializer */
#define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
/** Configures the encoder's bandpass.
/** Configures the encoder's bandpass, @see OPUS_GET_BANDWIDTH
* The supported values are:
* - OPUS_BANDWIDTH_AUTO (default)
* - OPUS_BANDWIDTH_NARROWBAND 4kHz passband
......@@ -212,10 +212,6 @@ extern "C" {
* @param[in] x <tt>int</tt>: Bandwidth value
* @hideinitializer */
#define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
/** Gets the encoder's configured bandpass, @see OPUS_SET_BANDWIDTH
* @param[out] x <tt>int*</tt>: Bandwidth value
* @hideinitializer */
#define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
/** Configures the type of signal being encoded.
* This is a hint which helps the encoder's mode selection.
......@@ -328,7 +324,7 @@ extern "C" {
/**@}*/
/** @defgroup genericctls Generic CTLs
* @see opus_encoder_ctl,opus_decoder_ctl
* @see opus_encoder_ctl,opusencoder,opusdecoder
* @{
*/
......@@ -359,6 +355,11 @@ extern "C" {
* @hideinitializer */
#define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
/** Gets the encoder's configured bandpass or the decoder's last bandpass, @see OPUS_SET_BANDWIDTH
* @param[out] x <tt>int*</tt>: Bandwidth value
* @hideinitializer */
#define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
/**@}*/
/** @defgroup libinfo Opus library information functions
......
......@@ -240,7 +240,7 @@ AC_MSG_RESULT([
Fixed point debugging: ......... ${ac_enable_fixed_debug}
Custom modes: .................. ${ac_enable_custom_modes}
Assertion checking: ............ ${ac_enable_assertions}
Fuzzing: .. .......... ${ac_enable_fuzzing}
Fuzzing: ....................... ${ac_enable_fuzzing}
API documentation: ............. ${ac_enable_doc}
------------------------------------------------------------------------
......
......@@ -1420,13 +1420,13 @@ ENABLE_PREPROCESSING = YES
# compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES.
MACRO_EXPANSION = NO
MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
# PREDEFINED and EXPAND_AS_DEFINED tags.
EXPAND_ONLY_PREDEF = NO
EXPAND_ONLY_PREDEF = YES
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# pointed to by INCLUDE_PATH will be searched when a #include is found.
......@@ -1454,7 +1454,7 @@ INCLUDE_FILE_PATTERNS =
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED =
PREDEFINED = OPUS_EXPORT=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment