From: Florian Forster <octo@collectd.org>
Date: Thu, 14 Dec 2023 20:48:09 +0000 (+0100)
Subject: src/daemon/metric.h: Improve doc comment for `metric_family_append`.
X-Git-Tag: 6.0.0-rc0~35^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F4191%2Fhead;p=thirdparty%2Fcollectd.git

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

diff --git a/src/daemon/metric.h b/src/daemon/metric.h
index 8ea3b09cd..16289d345 100644
--- 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);