diff options
| author | Max Kellermann <max@duempel.org> | 2012-09-25 11:58:16 +0200 |
|---|---|---|
| committer | Max Kellermann <max@duempel.org> | 2012-09-25 12:02:08 +0200 |
| commit | e47240931ae6e9267025a26c970d68cbe04519fb (patch) | |
| tree | ee609847ae4286d821fe242d1aaa43b4e1d0fb72 /src/command.h | |
| parent | a84874426d3a73993e858d6582a7b94bddb8dfba (diff) | |
| download | mpd-e47240931ae6e9267025a26c970d68cbe04519fb.tar.gz mpd-e47240931ae6e9267025a26c970d68cbe04519fb.tar.xz mpd-e47240931ae6e9267025a26c970d68cbe04519fb.zip | |
command: add documentation for "enum command_return"
Diffstat (limited to 'src/command.h')
| -rw-r--r-- | src/command.h | 19 |
1 files changed, 18 insertions, 1 deletions
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 <stdbool.h> 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, }; |