X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=aft.c;h=c2642ed3d13ceb139335cdef0c06c6999cd2ae7b;hp=2d5bbe8da4115ce3a9d3df3b304375904083164b;hb=6811b2f8ea8b7a8c77046285c9432aee6327da80;hpb=99ada213156df87aa7723c48c80d662a54458f09

diff --git a/aft.c b/aft.c
index 2d5bbe8d..c2642ed3 100644
--- a/aft.c
+++ b/aft.c
@@ -138,7 +138,7 @@ struct ls_options {
 /**
  * Describes the layout of the mmapped-afs info struct.
  *
- * \sa struct afs_info.
+ * \sa struct \ref afs_info.
  */
 enum afsi_offsets {
 	/** Where .last_played is stored. */
@@ -167,7 +167,7 @@ enum afsi_offsets {
  * \param afsi Pointer to the audio file info to be converted.
  * \param obj Result pointer.
  *
- * \sa load_afsi().
+ * \sa \ref load_afsi().
  */
 static void save_afsi(struct afs_info *afsi, struct osl_object *obj)
 {
@@ -192,7 +192,7 @@ static void save_afsi(struct afs_info *afsi, struct osl_object *obj)
  *
  * \return Standard.
  *
- * \sa save_afsi().
+ * \sa \ref save_afsi().
  */
 static int load_afsi(struct afs_info *afsi, struct osl_object *obj)
 {
@@ -365,7 +365,10 @@ static void save_afhi(struct afh_info *afhi, char *buf)
 	write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
 	write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
 	p = buf + AFHI_INFO_STRING_OFFSET;
-	/* The sprintf's below are OK as our caller made sure that buf is large enough */
+	/*
+	 * The below sprintf(3) calls are OK because our caller already made
+	 * sure that buf is large enough.
+	 */
 	p += sprintf(p, "%s", afhi->techinfo) + 1;
 	p += sprintf(p, "%s", afhi->tags.artist) + 1;
 	p += sprintf(p, "%s", afhi->tags.title) + 1;
@@ -374,6 +377,7 @@ static void save_afhi(struct afh_info *afhi, char *buf)
 	sprintf(p, "%s", afhi->tags.comment);
 }
 
+/* does not load the chunk table */
 static void load_afhi(const char *buf, struct afh_info *afhi)
 {
 	afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
@@ -528,7 +532,7 @@ static int get_afsi_of_path(const char *path, struct afs_info *afsi)
  * \param row Pointer to a row in the audio file table.
  * \param path Result pointer.
  *
- * The result is a pointer to mmapped data. The caller must not attempt
+ * The result is a pointer to memory-mapped data. The caller must not attempt
  * to free it.
  *
  * \return Standard.
@@ -552,7 +556,7 @@ int get_audio_file_path_of_row(const struct osl_row *row, char **path)
  *
  * \return The return value of the underlying call to osl_get_object().
  *
- * \sa get_hash_of_row().
+ * \sa \ref get_hash_of_row().
  */
 static int get_hash_object_of_aft_row(const struct osl_row *row,
 		struct osl_object *obj)
@@ -589,6 +593,10 @@ static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
  * \param afhi Result pointer.
  *
  * \return The return value of the underlying call to osl_get_object().
+ *
+ * After the call the members of the afhi structure point to mapped memory
+ * which is owned by the osl table, Hence the caller must not attempt to free
+ * this memory by calling \ref clear_afhi().
  */
 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 {
@@ -692,7 +700,7 @@ static int get_local_time(uint64_t *seconds, char *buf, size_t size,
 	/*
 	 * If the given time is more than six month away from the current time,
 	 * we print only the year. The additional space character in the format
-	 * string below makes the formated date align nicely with dates that
+	 * string below makes the formatted date align nicely with dates that
 	 * contain the time (those written by the above strftime() statement).
 	 */
 	if (!strftime(buf, size, "%b %e  %Y", tm))
@@ -2459,7 +2467,7 @@ int aft_check_attributes(uint64_t att_mask, struct para_buffer *pb)
  *
  * \param flags Usual flags that are passed to osl_close_table().
  *
- * \sa osl_close_table().
+ * \sa \ref osl_close_table().
  */
 static void aft_close(void)
 {
@@ -2474,7 +2482,7 @@ static void aft_close(void)
  *
  * \return Standard.
  *
- * \sa osl_open_table().
+ * \sa \ref osl_open_table().
  */
 static int aft_open(const char *dir)
 {