From dea6048849024664901abbce673c7f0a21d86460 Mon Sep 17 00:00:00 2001 From: Thomas Harte Date: Thu, 15 Jul 2021 22:00:10 -0400 Subject: [PATCH] Add documentation. --- Activity/Observer.hpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Activity/Observer.hpp b/Activity/Observer.hpp index bffc58693..307b404be 100644 --- a/Activity/Observer.hpp +++ b/Activity/Observer.hpp @@ -23,7 +23,10 @@ namespace Activity { */ class Observer { public: + /// Provides hints as to the sort of information presented on an LED. enum LEDPresentation: uint8_t { + /// This LED informs the user of some sort of persistent state, e.g. scroll lock. + /// If this flag is absent then the LED describes an ephemeral state, such as media access. Persistent = (1 << 0), };