src/daemon/metric.h: Improve doc comment for `metric_family_append`.

diff --git a/src/daemon/metric.h b/src/daemon/metric.h
index 8ea3b09cdc815edbf53a1a785cf5df20d6d1971a..16289d34575909c8084ce0273cf6d9f93f82af8a 100644 (file)
--- a/src/daemon/metric.h
+++ b/src/daemon/metric.h
@@ -170,6 +170,9 @@ int metric_family_resource_attribute_update(metric_family_t *fam,
  *   m.value = v;
  *   metric_label_set(&m, lname, lvalue);
  *   metric_family_metric_append(fam, m);
+ *
+ * templ may be NULL. In that case the function behaves as if &(metric_t){0} had
+ * been passed in.
  */
 int metric_family_append(metric_family_t *fam, char const *lname,
                          char const *lvalue, value_t v, metric_t const *templ);