From adec423b50f97888553fcfe58459eee151ac4184 Mon Sep 17 00:00:00 2001
From: Andre Noll <maan@systemlinux.org>
Date: Fri, 28 Nov 2008 22:29:14 +0100
Subject: [PATCH] afh_common.c: Add missing source code documentation.
Document afh_get_chunk() and make_taginfo().
---
afh_common.c | 34 +++++++++++++++++++++++++++++++---
1 file changed, 31 insertions(+), 3 deletions(-)
diff --git a/afh_common.c b/afh_common.c
index 47104500..bec99bf4 100644
--- a/afh_common.c
+++ b/afh_common.c
@@ -91,7 +91,6 @@ void afh_init(void)
}
}
-
/**
* Guess the audio format judging from filename.
*
@@ -122,11 +121,29 @@ int guess_audio_format(const char *name)
return -E_AUDIO_FORMAT;
}
+/**
+ * Pretty-print the given meta-info.
+ *
+ * \param title The title of the audio file.
+ * \param artist The artist.
+ * \param album The name of the album.
+ * \param year Year of release.
+ * \param comment Further comments.
+ *
+ * This function is called by each audio format handler to produce the tag info
+ * status items. Usually, the audio format handlers read this info from the
+ * audio file (id3 tags, vorbis comments, ...).
+ *
+ * It is OK to pass \p NULL pointers for any argument in which case a suitable
+ * string is inserted which indicates that this information is not available.
+ *
+ * \return The status item string. It must be freed by the caller.
+ */
char *make_taginfo(char *title, char *artist, char *album, char *year,
char *comment)
{
return make_message("%s: %s, by %s\n" /* taginfo1 */
- "%s: A: %s, Y: %s, C: %s\n", /* taginfo 2*/
+ "%s: A: %s, Y: %s, C: %s\n", /* taginfo2 */
status_item_list[SI_TAGINFO1],
(title && *title)? title : "(title tag not set)",
(artist && *artist)? artist : "(artist tag not set)",
@@ -196,7 +213,18 @@ const char *audio_format_name(int i)
return i >= 0? afl[i].name : "(none)";
}
-
+/**
+ * Get one chunk of audio data.
+ *
+ * \param chunk_num The number of the chunk to get.
+ * \param afhi Describes the audio file.
+ * \param map The memory mapped audio file.
+ * \param buf Result pointer.
+ * \param len The length of the chunk in bytes.
+ *
+ * Upon return, \a buf will point so memory inside \a map. The returned buffer
+ * must therefore not be freed by the caller.
+ */
void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
void *map, const char **buf, size_t *len)
{
--
2.39.5