config: Explicit state return value for error cases in parse_uint32_* functions

Developer should know what is ther return value for error cases.
Improved doxydoc may be used eg. by IDE to speed-up code development.

Signed-off-by: Karol Trzcinski <karolx.trzcinski@linux.intel.com>
This commit is contained in:
Karol Trzcinski 2021-08-31 18:13:53 +02:00 committed by Liam Girdwood
parent de9177b841
commit ada30c15b5
1 changed files with 2 additions and 2 deletions

View File

@ -119,7 +119,7 @@ static int assert_everything_parsed(const toml_table_t *table, struct parse_ctx
* @param key field name
* @param def is default value or -1 when value don't have default value
* @param error code, 0 when success
* @return default, parsed, or UINT32_MAX value
* @return default, parsed, or UINT32_MAX value for error cases
*/
static uint32_t parse_uint32_hex_key(const toml_table_t *table, struct parse_ctx *ctx,
const char *key, int64_t def, int *error)
@ -167,7 +167,7 @@ static uint32_t parse_uint32_hex_key(const toml_table_t *table, struct parse_ctx
* @param key field name
* @param def is default value or -1 when value don't have default value
* @param error code, 0 when success
* @return default, parsed, or UINT32_MAX value
* @return default, parsed, or UINT32_MAX value for error cases
*/
static uint32_t parse_uint32_key(const toml_table_t *table, struct parse_ctx *ctx, const char *key,
int64_t def, int *error)