Improve documentation of set_max_chunk_size().

The old text implied that the function could be removed at some point, which
is not the case. Remove this part of the documentation and clarify what the
function actually does.

diff --git a/afh_common.c b/afh_common.c
index 0f17a67b3a699c0a1aba8567fab0bac200abd2d5..11b45c7f6ad5b52ee6d26e0c2f2ec309a6442f16 100644 (file)
--- a/afh_common.c
+++ b/afh_common.c
@@ -424,15 +424,14 @@ unsigned afh_get_afhi_txt(int audio_format_num, struct afh_info *afhi, char **re
 }
 
 /**
- * Determine the maximal chunk size by investigating the chunk table.
+ * Determine the maximal chunk size by iterating the chunk table.
  *
  * \param afhi Value/result.
  *
- * This function iterates over the chunk table and sets ->max_chunk_size
- * accordingly. The function exists only for backward compatibility since as of
- * version 0.6.0, para_server stores the maximal chunk size in its database.
- * This function is only called if the database value is zero, indicating that
- * the file was added by an older server version.
+ * This function is called by the audio format handlers, for example when a
+ * new audio file is added to the afs database. The chunk table is determined
+ * from the given afhi pointer, and the maximal chunk size is returned via
+ * the ->max_chunk_size member of the same pointer.
  */
 void set_max_chunk_size(struct afh_info *afhi)
 {