From 43686dacd672f024d652f8592e83e0fa4b092b5d Mon Sep 17 00:00:00 2001
From: Oliver Smith <osmith@sysmocom.de>
Date: Fri, 26 Mar 2021 14:33:21 +0100
Subject: stat_item: add comment with struct overview

Related: OS#5088
Change-Id: Ic63a5884da778938197c658c5f478c23a85a4587
---
 src/stat_item.c | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'src')

diff --git a/src/stat_item.c b/src/stat_item.c
index 31298fd7..d4f3b727 100644
--- a/src/stat_item.c
+++ b/src/stat_item.c
@@ -52,6 +52,23 @@
  *
  */
 
+/* Struct overview:
+ * Each osmo_stat_item is attached to an osmo_stat_item_group, which is
+ * attached to the global osmo_stat_item_groups list.
+ *
+ *                       osmo_stat_item_groups
+ *                           /           \
+ *                        group1        group2
+ *                       /      \
+ *                    item1    item2
+ *                      |
+ *                   values
+ *                  /      \
+ *                 1        2
+ *                 |-id     |-id
+ *                 '-value  '-value
+ */
+
 #include <stdint.h>
 #include <string.h>
 
-- 
cgit v1.2.3