summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Göttsche <cgzones@googlemail.com>2020-11-29 15:26:57 +0100
committerBenBE <BenBE@geshi.org>2020-12-02 19:51:43 +0100
commit472f0124cd5a0e0658a145e702737fdf293c9dfc (patch)
treefe37b11b5b09a5c49c7694dd4e0e0363ba75e090
parentc0b50164ddca0048d224082a8f247dc0de059a18 (diff)
Meter: document MeterClass string fields
-rw-r--r--Meter.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/Meter.h b/Meter.h
index 8b0715c5..43518e52 100644
--- a/Meter.h
+++ b/Meter.h
@@ -39,10 +39,10 @@ typedef struct MeterClass_ {
const int defaultMode;
const double total;
const int* const attributes;
- const char* const name;
- const char* const uiName;
- const char* const caption;
- const char* const description;
+ const char* const name; /* internal name of the meter, must not contain any space */
+ const char* const uiName; /* display name in header setup menu */
+ const char* const caption; /* prefix in the actual header */
+ const char* const description; /* optional meter description in header setup menu */
const uint8_t maxItems;
} MeterClass;

© 2014-2024 Faster IT GmbH | imprint | privacy policy