strutil.c: Fix a Doxygen warning.

This commit is contained in:
Uwe Hermann 2016-08-29 18:44:43 +02:00
parent cd04f641a5
commit 5c436a3bad
1 changed files with 5 additions and 4 deletions

View File

@ -212,10 +212,11 @@ SR_PRIV int sr_atof_ascii(const char *str, float *ret)
}
/**
* Convert a string representation of a numeric value to a @sr_rational. The
* conversion is strict and will fail if the complete string does not represent
* a valid number. The function sets errno according to the details of the
* failure. This version ignores the locale.
* Convert a string representation of a numeric value to a sr_rational.
*
* The conversion is strict and will fail if the complete string does not
* represent a valid number. The function sets errno according to the details
* of the failure. This version ignores the locale.
*
* @param str The string representation to convert.
* @param ret Pointer to sr_rational where the result of the conversion will be stored.