Merge branch 'refs/heads/t/doxygen'

[paraslash.git] / aft.c

diff --git a/aft.c b/aft.c
index 0c4c93280a3f409b7a791aa0b33c5e82369da732..c2642ed3d13ceb139335cdef0c06c6999cd2ae7b 100644 (file)
--- a/aft.c
+++ b/aft.c
@@ -138,7 +138,7 @@ struct ls_options {
 /**
  * Describes the layout of the mmapped-afs info struct.
  *
 /**
  * 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. */
  */
 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.
  *
  * \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)
 {
  */
 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.
  *
  *
  * \return Standard.
  *

- * \sa save_afsi().
+ * \sa \ref save_afsi().

  */
 static int load_afsi(struct afs_info *afsi, struct osl_object *obj)
 {
  */
 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;
        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;
        p += sprintf(p, "%s", afhi->techinfo) + 1;
        p += sprintf(p, "%s", afhi->tags.artist) + 1;
        p += sprintf(p, "%s", afhi->tags.title) + 1;


@@ -529,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.
  *
  * \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.
  * to free it.
  *
  * \return Standard.


@@ -553,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().
  *
  *
  * \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)
  */
 static int get_hash_object_of_aft_row(const struct osl_row *row,
                struct osl_object *obj)


@@ -594,8 +597,6 @@ static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
  * 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().
  * 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().

- *
- * \sa get_chunk_table_of_row().

  */
 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 {
  */
 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 {


@@ -1912,11 +1913,7 @@ out:
 }
 EXPORT_SERVER_CMD_HANDLER(add);
 
 }
 EXPORT_SERVER_CMD_HANDLER(add);
 

-/**
- * Flags used by the touch command.
- *
- * \sa com_touch().
- */
+/** Flags used by the touch command. */

 enum touch_flags {
        /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
        TOUCH_FLAG_FNM_PATHNAME = 1,
 enum touch_flags {
        /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
        TOUCH_FLAG_FNM_PATHNAME = 1,


@@ -2402,8 +2399,6 @@ static int check_audio_file(struct osl_row *row, void *data)
  * \param aca Only ->pbout is used for diagnostics.
  *
  * \return Standard. Inconsistencies are reported but not regarded as an error.
  * \param aca Only ->pbout is used for diagnostics.
  *
  * \return Standard. Inconsistencies are reported but not regarded as an error.

- *
- * \sa com_check().

  */
 int aft_check_callback(struct afs_callback_arg *aca)
 {
  */
 int aft_check_callback(struct afs_callback_arg *aca)
 {


@@ -2472,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().
  *
  *
  * \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)
 {
  */
 static void aft_close(void)
 {


@@ -2487,7 +2482,7 @@ static void aft_close(void)
  *
  * \return Standard.
  *
  *
  * \return Standard.
  *

- * \sa osl_open_table().
+ * \sa \ref osl_open_table().

  */
 static int aft_open(const char *dir)
 {
  */
 static int aft_open(const char *dir)
 {