Add some missing documentation of public functions.

[paraslash.git] / afh_common.c

diff --git a/afh_common.c b/afh_common.c
index 1005139d8365165903ac01b8dac011017346c5c9..c866b4388ab14ac7880e8bcdf4c9bb0a56cf3306 100644 (file)
--- a/afh_common.c
+++ b/afh_common.c
@@ -236,6 +236,13 @@ void afh_get_chunk(long unsigned chunk_num, struct afh_info *afhi,
        *len = afhi->chunk_table[chunk_num + 1] - pos;
 }
 
+/**
+ * Compute the size of the largest chunk of an audio file.
+ *
+ * \param afhi The audio format handler struct containing the chunk table.
+ *
+ * \return The number of bytes of the largest chunk.
+ */
 uint32_t afh_get_largest_chunk_size(struct afh_info *afhi)
 {
        uint32_t n, largest = 0, *ct = afhi->chunk_table;