Minor documentation improvements.

diff --git a/afh.c b/afh.c
index 454517f40601e8e19421ed993e17b16a57ae900f..863224220d82360cc1d8fe5b0d262385cbf62a29 100644 (file)
--- a/afh.c
+++ b/afh.c
@@ -120,6 +120,14 @@ static int cat_file(void *audio_file_data, struct afh_info *afhi)
        return 1;
 }
 
        return 1;
 }
 

+/**
+ * The main function of para_afh.
+ *
+ * \param argc Usual argument count.
+ * \param argv Usual argument vector.
+ *
+ * \return \p EXIT_FAILURE or \p EXIT_SUCCESS.
+ */

 int main(int argc, char **argv)
 {
        int ret, audio_format_num, fd;
 int main(int argc, char **argv)
 {
        int ret, audio_format_num, fd;

diff --git a/blob.c b/blob.c
index cdad8d7f268330384a897f19d024fe8a6831d7ef..fd8ddc801ccce343914a2845c1b0c0c96c5b7d6c 100644 (file)
--- a/blob.c
+++ b/blob.c
@@ -55,7 +55,7 @@ enum blob_ls_flags {
 
 /** Structure passed to the \p print_blob function. */
 struct lsblob_action_data {
 
 /** Structure passed to the \p print_blob function. */
 struct lsblob_action_data {

-       /* The flags given at the command line. */
+       /** The flags given at the command line. */

        uint32_t flags;
        /** Message buffer. */
        struct para_buffer pb;
        uint32_t flags;
        /** Message buffer. */
        struct para_buffer pb;

diff --git a/filter.h b/filter.h
index 500a85379bd42b0dabdea4383d875a4f2180b640..8c1c9e0d431c26e20a01fff76a2f3edb5e57c054 100644 (file)
--- a/filter.h
+++ b/filter.h
@@ -34,6 +34,7 @@ struct filter_node {
 
 /** Describes one running instance of a chain of filters */
 struct filter_chain {
 
 /** Describes one running instance of a chain of filters */
 struct filter_chain {

+       /** The length of the filter chain. */

        unsigned int num_filters;
        /**
         * The number of channels of the current stream.
        unsigned int num_filters;
        /**
         * The number of channels of the current stream.

diff --git a/mood.c b/mood.c
index aa220f1e5d53b230b7fc03ef08060828b854fe72..cdc0745a255f994eb1a37c661cbfa1dfe1952221 100644 (file)
--- a/mood.c
+++ b/mood.c
@@ -84,7 +84,7 @@ typedef void mood_cleanup_function(void *);
  * Used for scoring and to determine whether a file is admissible.
  */
 struct mood_method {
  * Used for scoring and to determine whether a file is admissible.
  */
 struct mood_method {

-       /* The name of the method. */
+       /** The name of the method. */

        const char *name;
        /** Pointer to the mood parser. */
        mood_parser *parser;
        const char *name;
        /** Pointer to the mood parser. */
        mood_parser *parser;

diff --git a/send.h b/send.h
index 270affd5279d5bb3c1a00a05833c0859028a0c1f..2fe1cc56ad0c35f773dfc608b8cfd628baf33417 100644 (file)
--- a/send.h
+++ b/send.h
@@ -107,7 +107,7 @@ struct sender_client {
 
 /** Describes the current status of one paraslash sender. */
 struct sender_status {
 
 /** Describes the current status of one paraslash sender. */
 struct sender_status {

-       /* The file descriptor of the socket this sender is listening on. */
+       /** The file descriptor of the socket this sender is listening on. */

        int listen_fd;
        /** The TCP/DCCP port used by this sender. */
        int port;
        int listen_fd;
        /** The TCP/DCCP port used by this sender. */
        int port;

diff --git a/send_common.c b/send_common.c
index c0098b98a833f0cae309aba11a43bec1c2c7d1a6..3d87008850a8ab3c39b3f1711d5aca1b2e2f3a45 100644 (file)
--- a/send_common.c
+++ b/send_common.c
@@ -62,6 +62,8 @@ static int open_sender(unsigned l4type, int port)
  * Close the file descriptor given by \a sc, remove it from the close-on-fork
  * list, destroy the chunk queue of this client, delete the client from the
  * list of connected clients and free the sender_client struct.
  * Close the file descriptor given by \a sc, remove it from the close-on-fork
  * list, destroy the chunk queue of this client, delete the client from the
  * list of connected clients and free the sender_client struct.

+ *
+ * \sa shutdown_clients().

  */
 void shutdown_client(struct sender_client *sc, struct sender_status *ss)
 {
  */
 void shutdown_client(struct sender_client *sc, struct sender_status *ss)
 {


@@ -76,6 +78,14 @@ void shutdown_client(struct sender_client *sc, struct sender_status *ss)
        ss->num_clients--;
 }
 
        ss->num_clients--;
 }
 

+/**
+ * Shut down all clients connected to a paraslash sender.
+ *
+ * \param ss The sender whose clients are to be shut down.
+ *
+ * This just loops over all connected clients and calls shutdown_client()
+ * for each client.
+ */

 void shutdown_clients(struct sender_status *ss)
 {
        struct sender_client *sc, *tmp;
 void shutdown_clients(struct sender_status *ss)
 {
        struct sender_client *sc, *tmp;

diff --git a/time.c b/time.c
index 1fd7b0981584fc4557079ee62a87fbd713554f3a..0ebc6ec0c8f3f10e66f77ffe18d0f8fe05d7210a 100644 (file)
--- a/time.c
+++ b/time.c
@@ -170,6 +170,16 @@ int tv_convex_combination(const long a, const struct timeval *tv1,
        return ret;
 }
 
        return ret;
 }
 

+/**
+ * Compute when to send a chunk of an audio file.
+ *
+ * \param chunk_num The number of the chunk.
+ * \param chunk_tv The duration of one chunk.
+ * \param stream_start When the first chunk was sent.
+ * \param result The time when to send chunk number \a chunk_num.
+ *
+ * This function computes stream_start + chunk_num * chunk_time.
+ */

 void compute_chunk_time(long unsigned chunk_num,
                struct timeval *chunk_tv, struct timeval *stream_start,
                struct timeval *result)
 void compute_chunk_time(long unsigned chunk_num,
                struct timeval *chunk_tv, struct timeval *stream_start,
                struct timeval *result)

diff --git a/write.c b/write.c
index 140e80e54ca6a94372460393d0c6153b332b45bb..78e48dcdaf5637acf5754a00553a28c5d647284e 100644 (file)
--- a/write.c
+++ b/write.c
@@ -34,6 +34,7 @@ struct check_wav_task {
        unsigned channels;
        /** Sample rate specified in wav header given by \a buf. */
        unsigned samplerate;
        unsigned channels;
        /** Sample rate specified in wav header given by \a buf. */
        unsigned samplerate;

+       /** The task structure used by the scheduler. */

        struct task task;
 };
 
        struct task task;
 };