Add/fix some doxygen comments.

diff --git a/afh.h b/afh.h
index a7882729222cf195501bcdbec1632fe50d7f4f3f..0486bd7784151df33c7c755011d270ee3ed905aa 100644 (file)
--- a/afh.h
+++ b/afh.h
@@ -80,7 +80,7 @@ struct audio_format_handler {
        /**
         * Check if this audio format handler can handle the file.
         *
-        * This is a  pointer to a function returning whether a given file is
+        * This is a pointer to a function returning whether a given file is
         * valid for this audio format. A negative return value indicates that
         * this audio format handler is unable to decode the given file. On
         * success, the function must return a positive value and fill in the
@@ -90,7 +90,7 @@ struct audio_format_handler {
         */
        int (*get_file_info)(char *map, size_t numbytes, int fd,
                struct afh_info *afi);
-
+       /** Optional, used for header-rewriting. See \ref afh_get_header(). */
        void (*get_header)(void *map, size_t mapsize, char **buf, size_t *len);
 };
 

diff --git a/afh_common.c b/afh_common.c
index 769674134b0f16d88bbe856d2daf972e54ed4c1b..44a6fd62cbe50c758aba17b33dd45c0e7eb831c6 100644 (file)
--- a/afh_common.c
+++ b/afh_common.c
@@ -213,7 +213,7 @@ success:
  *
  * \param i The audio format number.
  *
- * This returns a pointer to statically allocated memory so it
+ * \return This returns a pointer to statically allocated memory so it
  * must not be freed by the caller.
  */
 const char *audio_format_name(int i)

diff --git a/client.h b/client.h
index 2d63c4109460764d4fa5e3a6aa9c694044775afb..28b786a4ce091e132863a0076c6473b645dd60d2 100644 (file)
--- a/client.h
+++ b/client.h
@@ -42,6 +42,7 @@ struct client_task {
        char *user;
        /** The client task structure. */
        struct task task;
+       /** The buffer tree node of the client task. */
        struct btr_node *btrn;
 };
 

diff --git a/filter_common.c b/filter_common.c
index 4b1a45de933847267d247660dc8445ea24fe9863..1233c9ad80ac5c76d8d50c7b52a6abfe0f4a1219 100644 (file)
--- a/filter_common.c
+++ b/filter_common.c
@@ -169,6 +169,8 @@ void generic_filter_pre_select(struct sched *s, struct task *t)
  * \param sample_rate Known to the decoder.
  * \param channels Known to the decoder.
  * \param result Ascii representation on the answer is stored here.
+ *
+ * \return Standard.
  */
 int decoder_execute(const char *cmd, unsigned sample_rate, unsigned channels,
                char **result)

diff --git a/net.c b/net.c
index ae596e5a7007260dd3a2954932f3927e88ea3bdd..9b58e22539e8277c674425f689d1f3c261c2d48a 100644 (file)
--- a/net.c
+++ b/net.c
@@ -576,8 +576,12 @@ static inline int estimated_header_overhead(const int af_type)
 }
 
 /**
- * Maximum transport-layer message size (MMS_S) as per RFC 1122, 3.3.3
- * Socket must be connected.
+ * Get the maximum transport-layer message size (MMS_S).
+ *
+ * The socket must be connected. See RFC 1122, 3.3.3.
+ *
+ * \return If the protocol familiy could not be determined, \p AF_INET is
+ * assumed.
  */
 int generic_max_transport_msg_size(int sockfd)
 {