From e47240931ae6e9267025a26c970d68cbe04519fb Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Tue, 25 Sep 2012 11:58:16 +0200 Subject: [PATCH] command: add documentation for "enum command_return" --- src/command.h | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/src/command.h b/src/command.h index c59614b5f..6d8a13be1 100644 --- a/src/command.h +++ b/src/command.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2003-2011 The Music Player Daemon Project + * Copyright (C) 2003-2012 The Music Player Daemon Project * http://www.musicpd.org * * This program is free software; you can redistribute it and/or modify @@ -25,9 +25,26 @@ #include enum command_return { + /** + * The command has succeeded, but the "OK" response was not + * yet sent to the client. + */ COMMAND_RETURN_OK, + + /** + * There was an error. The "ACK" response was sent to the + * client. + */ COMMAND_RETURN_ERROR, + + /** + * The connection to this client shall be closed. + */ COMMAND_RETURN_CLOSE, + + /** + * The MPD process shall be shut down. + */ COMMAND_RETURN_KILL, };