From c9506a85973a9544baa050062bc9782237096f24 Mon Sep 17 00:00:00 2001
From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Mon, 2 Aug 2021 15:03:42 +1000
Subject: [PATCH] doc: basic documentation for the logind media-session module

---
 src/examples/media-session/logind.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/examples/media-session/logind.c b/src/examples/media-session/logind.c
index 2219ac9f1..ae248b88a 100644
--- a/src/examples/media-session/logind.c
+++ b/src/examples/media-session/logind.c
@@ -41,6 +41,13 @@
 #include "media-session.h"
 
 /** \page page_media_session_module_logind Media Session Module: Logind
+ *
+ * The logind module uses systemd logind to keep track of the user's session
+ * and updates the media session's seat state accordingly.
+ *
+ * The session state may be used by other modules, e.g. the \ref
+ * page_media_session_module_bluez_monitor module enables/disables
+ * Bluetooth whenever the session changes between active and inactive.
  */
 
 #define NAME		"logind"