From: Florian Forster <octo@noris.net>
Date: Wed, 9 Jun 2010 11:10:52 +0000 (+0200)
Subject: src/common.h: Add some documentation for "strtoderive".
X-Git-Tag: collectd-4.10.1~4
X-Git-Url: https://git.octo.it/?p=collectd.git;a=commitdiff_plain;h=3fc9dd157bb761c82718e1bc48543394da14db00

src/common.h: Add some documentation for "strtoderive".
---

diff --git a/src/common.h b/src/common.h
index c0bea36e..229f7098 100644
--- a/src/common.h
+++ b/src/common.h
@@ -291,6 +291,8 @@ counter_t counter_diff (counter_t old_value, counter_t new_value);
  * (in the range [1-65535]). Returns less than zero on error. */
 int service_name_to_port_number (const char *service_name);
 
+/** Parse a string to a derive_t value. Returns zero on success or non-zero on
+ * failure. If failure is returned, ret_value is not touched. */
 int strtoderive (const char *string, derive_t *ret_value);
 
 #endif /* COMMON_H */