From: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Date: Wed, 21 Dec 2011 20:40:51 +0000 (+0100)
Subject: screen_interface: document the cmd callback
X-Git-Tag: release-0.20~41
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=f6bb989398b1ab8fa4ba5ad9a42958a1c5e866f0;p=ncmpc.git

screen_interface: document the cmd callback
---

diff --git a/src/screen_interface.h b/src/screen_interface.h
index bcf442a..a5b29b9 100644
--- 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);
 };