victor-dmm: Cosmetics.

[libsigrok.git] / strutil.c

diff --git a/strutil.c b/strutil.c
index 0ddeae0973690ca2ec6535a7758f56a75d34de34..1cb0db39efe1c1eb40870008e69452f83adc74e6 100644 (file)
--- a/strutil.c
+++ b/strutil.c
@@ -24,6 +24,20 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Helper functions for handling or converting libsigrok-related strings.
+ */
+
+/**
+ * @defgroup grp_strutil String utilities
+ *
+ * Helper functions for handling or converting libsigrok-related strings.
+ *
+ * @{
+ */
+
 /**
  * Convert a numeric value value to its "natural" string representation.
  * in SI units
@@ -170,7 +184,9 @@ SR_API char *sr_voltage_string(struct sr_rational *voltage)
 /**
  * Parse a trigger specification string.
  *
- * @param dev The device for which the trigger specification is intended.
+ * @param sdi The device instance for which the trigger specification is
+ *            intended. Must not be NULL. Also, sdi->driver and
+ *            sdi->driver->info_get must not be NULL.
  * @param triggerstring The string containing the trigger specification for
  *        one or more probes of this device. Entries for multiple probes are
  *        comma-separated. Triggers are specified in the form key=value,
@@ -324,16 +340,17 @@ SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size)
  * @param timestring A string containing a (decimal) time value.
  * @return The string's time value as uint64_t, in milliseconds.
  *
- * TODO: Error handling.
- * TODO: Add support for "m" (minutes) and others.
- * TODO: picoseconds?
- * TODO: Allow both lower-case and upper-case.
+ * @todo Add support for "m" (minutes) and others.
+ * @todo Add support for picoseconds?
+ * @todo Allow both lower-case and upper-case? If no, document it.
  */
 SR_API uint64_t sr_parse_timestring(const char *timestring)
 {
        uint64_t time_msec;
        char *s;
 
+       /* TODO: Error handling, logging. */
+
        time_msec = strtoull(timestring, &s, 10);
        if (time_msec == 0 && s == timestring)
                return 0;
@@ -419,4 +436,4 @@ SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r)
        return SR_OK;
 }
 
-
+/** @} */