screen_interface: document the cmd callback

diff --git a/src/screen_interface.h b/src/screen_interface.h
index bcf442a1fefdd668863404a3cc02a68b1b133337..a5b29b90318ac2b8f6f9daa16bbddd3ea8eac70b 100644 (file)
--- a/src/screen_interface.h
+++ b/src/screen_interface.h
@@ -37,7 +37,14 @@ struct screen_functions {
        void (*resize)(int cols, int rows);
        void (*paint)(void);
        void (*update)(struct mpdclient *c);
+
+       /**
+        * Handle a command.
+        *
+        * @returns true if the command should not be handled by the ncmpc core.
+        */
        bool (*cmd)(struct mpdclient *c, command_t cmd);
+
        const char *(*get_title)(char *s, size_t size);
 };