diff options
| author | Max Kellermann <max@duempel.org> | 2009-03-01 20:08:48 +0100 |
|---|---|---|
| committer | Max Kellermann <max@duempel.org> | 2009-03-01 20:08:48 +0100 |
| commit | 4194f4b18b957b4a013a3f50d5fde67770d5ccdb (patch) | |
| tree | 4b2b4ba5f3ec8844d0a71f786235784cb77f4918 /src/audio_parser.h | |
| parent | f48c58d17b1653b6979876ebba66b21cde87ec03 (diff) | |
| download | mpd-4194f4b18b957b4a013a3f50d5fde67770d5ccdb.tar.gz mpd-4194f4b18b957b4a013a3f50d5fde67770d5ccdb.tar.xz mpd-4194f4b18b957b4a013a3f50d5fde67770d5ccdb.zip | |
audio_parser: added API documentation
Diffstat (limited to 'src/audio_parser.h')
| -rw-r--r-- | src/audio_parser.h | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/src/audio_parser.h b/src/audio_parser.h index 251ce7cef..3101ab207 100644 --- a/src/audio_parser.h +++ b/src/audio_parser.h @@ -16,9 +16,9 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -/* - * Parser functions for audio related objects. +/** \file * + * Parser functions for audio related objects. */ #ifndef AUDIO_PARSER_H @@ -30,6 +30,16 @@ struct audio_format; +/** + * Parses a string in the form "SAMPLE_RATE:BITS:CHANNELS" into an + * #audio_format. + * + * @param dest the destination #audio_format struct + * @param src the input string + * @param error location to store the error occuring, or NULL to + * ignore errors + * @return true on success + */ bool audio_format_parse(struct audio_format *dest, const char *src, GError **error); |