Minor doxygen improvements.
authorAndre Noll <maan@systemlinux.org>
Sat, 24 Nov 2007 23:10:19 +0000 (00:10 +0100)
committerAndre Noll <maan@systemlinux.org>
Sat, 24 Nov 2007 23:10:19 +0000 (00:10 +0100)
afs.h
server.h
signal.c
vss.c

diff --git a/afs.h b/afs.h
index 977fc40..eed1776 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -116,11 +116,11 @@ void make_empty_status_items(char *buf);
  * Data about the current audio file, passed from afs to server.
  */
 struct audio_file_data {
-       /* Same info as ls -lv -p <current audio file>. */
+       /** Same info as ls -lv -p <current audio file>. */
        char verbose_ls_output[VERBOSE_LS_OUTPUT_SIZE];
-       /* The open file descriptor to the current audio file. */
+       /** The open file descriptor to the current audio file. */
        int fd;
-       /* Vss needs this for streaming. */
+       /** Vss needs this for streaming. */
        struct afh_info afhi;
 };
 
index a83aaae..c248f52 100644 (file)
--- a/server.h
+++ b/server.h
@@ -4,41 +4,41 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file server.h common server data structures */
+/** \file server.h Common server data structures. */
 
 
-/** size of the selector_info and audio_file info strings of struct misc_meta_data */
+/** Size of the selector_info and audio_file info strings of struct misc_meta_data. */
 #define MMD_INFO_SIZE 16384
 
 /**
- * defines one command of para_server
+ * Defines one command of para_server.
  */
 struct server_command {
-/** the name of the command */
+       /** The name of the command. */
        const char *name;
-/** pointer to the function that handles the command */
+       /** Pointer to the function that handles the command. */
        int (*handler)(int, int, char * const * const);
-/** the privileges a user must have to execute this command */
+       /** The privileges a user must have to execute this command. */
        unsigned int perms;
-/** one-line description of the command */
+       /** One-line description of the command. */
        const char *description;
-/** summary of the command line options */
+       /** Summary of the command line options. */
        const char *usage;
-/** the long help text */
+       /** The long help text. */
        const char *help;
 };
 
-/** holds the arguments for the para_server's sender command */
+/** Holds the arguments for the para_server's sender command. */
 struct sender_command_data{
-/** greater than 0 indicates that a sender cmd is already queued */
+       /** Greater than 0 indicates that a sender cmd is already queued. */
        int cmd_num;
-/** the number of the sender in question */
+       /** The number of the sender in question. */
        int sender_num;
-/** used for the allow/deny/add/remove subcommands */
+       /** Used for the allow/deny/add/remove subcommands. */
        struct in_addr addr;
-/** used for allow/deny */
+       /** Used for allow/deny. */
        int netmask;
-/** the portnumber for add/remove */
+       /** The port number for add/remove. */
        int port;
 };
 
@@ -59,23 +59,23 @@ struct sender_command_data{
  *     date.
  */
 struct misc_meta_data {
-       /** the size of the current audio file in bytes */
+       /** The size of the current audio file in bytes. */
        size_t size;
-       /** the last modification time of the current audio file */
+       /** The last modification time of the current audio file. */
        time_t mtime;
-       /** the "old" status flags -- commands may only read them */
+       /** The "old" status flags -- commands may only read them. */
        unsigned int vss_status_flags;
        /** The new status flags -- commands may set them. */
        unsigned int new_vss_status_flags;
-       /** the number of data chunks sent for the current audio file */
+       /** The number of data chunks sent for the current audio file. */
        long unsigned chunks_sent;
-       /** set by the jmp/ff commands to the new position in chunks */
+       /** Set by the jmp/ff commands to the new position in chunks. */
        long unsigned repos_request;
        /** The number of the chunk currently sent out. */
        long unsigned current_chunk;
-       /** the milliseconds that have been skipped of the current audio file */
+       /** The milliseconds that have been skipped of the current audio file. */
        long offset;
-       /** the time para_server started to stream */
+       /** The time para_server started to stream. */
        struct timeval stream_start;
        /**
         * The event counter.
@@ -84,25 +84,28 @@ struct misc_meta_data {
         * connected clients.
         */
        unsigned int events;
-       /** the number of audio files already sent */
+       /** The number of audio files already sent. */
        unsigned int num_played;
-       /** the number of executed commands */
+       /** The number of executed commands. */
        unsigned int num_commands;
-       /** the number of connections para_server received so far */
+       /** The number of connections para_server received so far. */
        unsigned int num_connects;
-       /** the number of connections currently active */
+       /** The number of connections currently active. */
        unsigned int active_connections;
-       /** the process id of para_server */
+       /** The process id of para_server. */
        pid_t server_pid;
        /** This gets updated by afs and contains its current mode. */
        char afs_mode_string[MAXLINE];
-       /** used by the sender command */
+       /** Used by the sender command. */
        struct sender_command_data sender_cmd_data;
        /** Describes the current audio file. */
        struct audio_file_data afd;
 };
 
+/** Command line options for para_server. */
 extern struct server_args_info conf;
+
+/** Socket for afs-server communication. */
 extern int afs_socket;
 
 int handle_connect(int fd, struct sockaddr_in *addr);
index 3f3dbf6..5549979 100644 (file)
--- a/signal.c
+++ b/signal.c
@@ -144,6 +144,9 @@ int para_next_signal(void)
        return r < 0 && (errno != EAGAIN)? 0 : -E_SIGNAL_READ;
 }
 
+/**
+ * Close the signal pipe.
+ */
 void para_signal_shutdown(void)
 {
        close(signal_pipe[1]);
diff --git a/vss.c b/vss.c
index efd0c5e..b18c731 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -261,9 +261,13 @@ struct timeval *vss_chunk_time(void)
        return &mmd->afd.afhi.chunk_tv;
 }
 
+/** The possible states of the afs socket. See \ref afs_socket. */
 enum afs_socket_status {
+       /** Socket is inactive. */
        AFS_SOCKET_READY,
+       /** Socket fd was included in the write fd set for select(). */
        AFS_SOCKET_CHECK_FOR_WRITE,
+       /** vss wrote a request to the socket and waits for afs to reply. */
        AFS_SOCKET_AFD_PENDING
 };