aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUwe Hermann <uwe@hermann-uwe.de>2017-03-08 01:10:19 +0100
committerUwe Hermann <uwe@hermann-uwe.de>2017-03-08 01:10:39 +0100
commit9a17c23bc9810206eae7741bc4b35bc4d78999d3 (patch)
tree048556199d5e4a84c15e02c537b8f46933c7fd93
parent6984cfb245811df0f691928a6e4224d4f7ac5786 (diff)
Fix sr_period_string() Doxygen comments.
-rw-r--r--src/strutil.c15
1 files changed, 9 insertions, 6 deletions
diff --git a/src/strutil.c b/src/strutil.c
index 3b0afad..72378d4 100644
--- a/src/strutil.c
+++ b/src/strutil.c
@@ -347,18 +347,21 @@ SR_API char *sr_samplerate_string(uint64_t samplerate)
}
/**
- * Convert a numeric frequency value to the "natural" string representation
- * of its period.
+ * Convert a numeric period value to the "natural" string representation
+ * of its period value.
*
- * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
+ * The period is specified as a rational number's numerator and denominator.
*
- * @param frequency The frequency in Hz.
+ * E.g. a pair of (1, 5) would be converted to "200 ms", (10, 100) to "100 ms".
*
- * @return A newly allocated string representation of the frequency value,
+ * @param v_p The period numerator.
+ * @param v_q The period denominator.
+ *
+ * @return A newly allocated string representation of the period value,
* or NULL upon errors. The caller is responsible to g_free() the
* memory.
*
- * @since 0.1.0
+ * @since 0.5.0
*/
SR_API char *sr_period_string(uint64_t v_p, uint64_t v_q)
{