more doxygen docu, some small cleanups

diff --git a/para.h b/para.h
index f22157d8ae6063969ffabfd29e3e0ecb21cf0af1..869749d15058ed2835c69e38588f8f619e067eee 100644 (file)
--- a/para.h
+++ b/para.h
@@ -48,15 +48,22 @@
 /** compute the absolute value of \a a */
 #define PARA_ABS(a) ((a) > 0 ? (a) : -(a))
 
 /** compute the absolute value of \a a */
 #define PARA_ABS(a) ((a) > 0 ? (a) : -(a))
 

-/* Loglevels */
+/** debug loglevel, gets really noisy */

 #define DEBUG 1
 #define DEBUG 1

+/** still noisy, but won't fill your disk */

 #define INFO  2
 #define INFO  2

+/** normal, but significant event */

 #define NOTICE 3
 #define NOTICE 3

+/** unexpected event that can be handled */

 #define WARNING 4
 #define WARNING 4

+/** unhandled error condition */

 #define ERROR 5
 #define ERROR 5

+/** system might be unreliable */

 #define CRIT 6
 #define CRIT 6

+/** last message before exit */

 #define EMERG 7
 
 #define EMERG 7
 

+/** log messages with lower proirity than that will not be compiled in*/

 #define COMPILE_TIME_LOGLEVEL 0
 
 #if DEBUG > COMPILE_TIME_LOGLEVEL
 #define COMPILE_TIME_LOGLEVEL 0
 
 #if DEBUG > COMPILE_TIME_LOGLEVEL


@@ -119,7 +126,7 @@
                va_end(argp); \
        }
 
                va_end(argp); \
        }
 

-
+/** version text used by various commands if -V switch was given */

 #define VERSION_TEXT(prefix) "para_" prefix " " PACKAGE_VERSION "\n" \
        "Copyright (C) 2007 Andre Noll\n" \
        "This is free software with ABSOLUTELY NO WARRANTY." \
 #define VERSION_TEXT(prefix) "para_" prefix " " PACKAGE_VERSION "\n" \
        "Copyright (C) 2007 Andre Noll\n" \
        "This is free software with ABSOLUTELY NO WARRANTY." \


@@ -127,16 +134,21 @@
        "Written by Andre Noll.\n" \
        "Report bugs to <maan@systemlinux.org>.\n"
 
        "Written by Andre Noll.\n" \
        "Report bugs to <maan@systemlinux.org>.\n"
 

+/** print out \p VERSION_TEXT and exit if version flag was given */

 #define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
        if (_args_info_struct.version_given) { \
                printf("%s", VERSION_TEXT(_prefix)); \
                exit(EXIT_SUCCESS); \
        }
 #define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
        if (_args_info_struct.version_given) { \
                printf("%s", VERSION_TEXT(_prefix)); \
                exit(EXIT_SUCCESS); \
        }

-
+/** sent by para_server for commands that expect a data file */

 #define AWAITING_DATA_MSG "\nAwaiting Data."
 #define AWAITING_DATA_MSG "\nAwaiting Data."

+/** sent by para_server if authentication was successful */

 #define PROCEED_MSG "\nProceed.\n"
 #define PROCEED_MSG "\nProceed.\n"

+/** length of the \p PROCEED_MSG string */

 #define PROCEED_MSG_LEN strlen(PROCEED_MSG)
 #define PROCEED_MSG_LEN strlen(PROCEED_MSG)

+/** sent by para_client to indicate the end of the command line */

 #define EOC_MSG "\nEnd of Command."
 #define EOC_MSG "\nEnd of Command."

+/** sent by para_client, followed by the decrypted challenge number */

 #define CHALLENGE_RESPONSE_MSG "challenge_response:"
 
 /* gui_common */
 #define CHALLENGE_RESPONSE_MSG "challenge_response:"
 
 /* gui_common */

diff --git a/playlist_selector.c b/playlist_selector.c
index d0c64cc232d2b75b9abc524156e79a35e4252c2a..8d1d45165983b494ab4db26acd91ccf05c99c943 100644 (file)
--- a/playlist_selector.c
+++ b/playlist_selector.c
@@ -279,25 +279,27 @@ static void pls_update_audio_file(char *audio_file)
 /**
  * the init function for the playlist selector
  *
 /**
  * the init function for the playlist selector
  *

- * Init all function pointers of \a db
+ * \param afs pointer to the struct to initialize
+ *
+ * Init all function pointers of \a afs

  *
  * \sa struct audio_file_selector, misc_meta_data::selector_info, mysql.c
  * random_selector.c.
  */
  *
  * \sa struct audio_file_selector, misc_meta_data::selector_info, mysql.c
  * random_selector.c.
  */

-int playlist_selector_init(struct audio_file_selector *db)
+int playlist_selector_init(struct audio_file_selector *afs)

 {
        int ret;
        struct private_pls_data *ppd = NULL;
        void *shm = NULL;
 
 {
        int ret;
        struct private_pls_data *ppd = NULL;
        void *shm = NULL;
 

-       self = db;
-       db->cmd_list = playlist_selector_cmds;
-       db->get_audio_file_list = pls_get_audio_file_list;
-       db->shutdown = pls_shutdown;
-       db->post_select = pls_post_select;
-       db->update_audio_file = pls_update_audio_file;
+       self = afs;
+       afs->cmd_list = playlist_selector_cmds;
+       afs->get_audio_file_list = pls_get_audio_file_list;
+       afs->shutdown = pls_shutdown;
+       afs->post_select = pls_post_select;
+       afs->update_audio_file = pls_update_audio_file;

        ppd = para_calloc(sizeof(struct private_pls_data));
        ppd = para_calloc(sizeof(struct private_pls_data));

-       db->private_data = ppd;
+       afs->private_data = ppd;

 
        ppd->client_mutex = -1;
        ppd->server_mutex = -1;
 
        ppd->client_mutex = -1;
        ppd->server_mutex = -1;

diff --git a/random_selector.c b/random_selector.c
index c7cfdb1519cd266007ce86a3b53c428b3a8e4b3a..5d8b386c6f433d68ef55b589bbe077df41c9331b 100644 (file)
--- a/random_selector.c
+++ b/random_selector.c
@@ -122,10 +122,11 @@ static void random_shutdown(void)
 }
 
 /**
 }
 
 /**

- *  the init function for the random audio file selector
+ * the init function for the random audio file selector

  *
  *

- * Init all function pointers of \a s, init the info text and seed the
- * PRNG.
+ * \param s pointer ro the struct to iniitalize
+ *
+ * Init all function pointers of \a s, init the info text and seed the PRNG.

  *
  * \sa struct audio_file_selector, misc_meta_data::selector_info, mysql.c
  */
  *
  * \sa struct audio_file_selector, misc_meta_data::selector_info, mysql.c
  */

diff --git a/recv.h b/recv.h
index 573dccc9dfcb112e737d81a410973ea8abd0a326..63624b6a7bab31c2efda9f5f4f3e0d896456c56f 100644 (file)
--- a/recv.h
+++ b/recv.h
@@ -16,7 +16,7 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 

-/** \file recv.h receiver-relates structures and exported symbols of recv_common.c */
+/** \file recv.h receiver-related structures and exported symbols of recv_common.c */

 
 /**
  * describes one instance of a receiver
 
 /**
  * describes one instance of a receiver


@@ -47,14 +47,10 @@ struct receiver_node {
  */
 struct receiver {
 /**
  */
 struct receiver {
 /**

- *
- *

  * the name of the receiver
  */
        const char *name;
 /**
  * the name of the receiver
  */
        const char *name;
 /**

- *
- *

  * the receiver init function
  *
  * It must fill in all other function pointers and is assumed to succeed.
  * the receiver init function
  *
  * It must fill in all other function pointers and is assumed to succeed.


@@ -63,8 +59,6 @@ struct receiver {
  */
        void (*init)(struct receiver *r);
 /**
  */
        void (*init)(struct receiver *r);
 /**

- *
- *

  * the command line parser of the receiver
  *
  * It should check whether the command line options given by \a argc and \a
  * the command line parser of the receiver
  *
  * It should check whether the command line options given by \a argc and \a


@@ -72,12 +66,9 @@ struct receiver {
  * receiver-specific configuration data determined by \a argc and \a argv.
  * Note that this might be called more than once with different values of
  * \a argc and \a argv.
  * receiver-specific configuration data determined by \a argc and \a argv.
  * Note that this might be called more than once with different values of
  * \a argc and \a argv.

- *

  */
        void * (*parse_config)(int argc, char **argv);
 /**
  */
        void * (*parse_config)(int argc, char **argv);
 /**

- *
- *

  * open one instance of the receiver
  *
  * This should allocate the output buffer of \a rn. and may also perform any
  * open one instance of the receiver
  *
  * This should allocate the output buffer of \a rn. and may also perform any


@@ -90,9 +81,7 @@ struct receiver {
  */
        int (*open)(struct receiver_node *rn);
 /**
  */
        int (*open)(struct receiver_node *rn);
 /**

- *
- *
- * close one instance of the receiver
+ * close this instance of the receiver

  *
  * It should free all resources associated with given receiver node that were
  * allocated during the corresponding open call.
  *
  * It should free all resources associated with given receiver node that were
  * allocated during the corresponding open call.


@@ -101,29 +90,22 @@ struct receiver {
  */
        void (*close)(struct receiver_node *rn);
 /**
  */
        void (*close)(struct receiver_node *rn);
 /**

- *
- *

  * deactivate the receiver
  *
  * Clean up what init has allocated.
  */
        void (*shutdown)(void);
 /**
  * deactivate the receiver
  *
  * Clean up what init has allocated.
  */
        void (*shutdown)(void);
 /**

- *
- *

  * add file descriptors to fd_sets and compute timeout for select(2)
  *
  * The pre_select function gets called from the driving application before
  * entering its select loop. The receiver may use this hook to add any file
  * descriptors to the sets of file descriptors given by \a s.
  *
  * add file descriptors to fd_sets and compute timeout for select(2)
  *
  * The pre_select function gets called from the driving application before
  * entering its select loop. The receiver may use this hook to add any file
  * descriptors to the sets of file descriptors given by \a s.
  *

- *

  * \sa select(2), time.c struct task, struct sched
  */
        void (*pre_select)(struct sched *s, struct task *t);
 /**
  * \sa select(2), time.c struct task, struct sched
  */
        void (*pre_select)(struct sched *s, struct task *t);
 /**

- *
- *

  * evaluate the result from select()
  *
  * This hook gets called after the call to select(). It should check all file
  * evaluate the result from select()
  *
  * This hook gets called after the call to select(). It should check all file


@@ -131,7 +113,6 @@ struct receiver {
  * call to pre_select. According to the result, it may then use any
  * non-blocking I/O to establish a connection or to receive the audio data.
  *
  * call to pre_select. According to the result, it may then use any
  * non-blocking I/O to establish a connection or to receive the audio data.
  *

- *

  * \sa select(2), struct receiver
  */
        void (*post_select)(struct sched *s, struct task *t);
  * \sa select(2), struct receiver
  */
        void (*post_select)(struct sched *s, struct task *t);


@@ -152,7 +133,6 @@ extern void ortp_recv_init(struct receiver *r);
 #endif
 
 extern struct receiver receivers[];
 #endif
 
 extern struct receiver receivers[];

-extern void (*crypt_function_recv)(unsigned long len, const unsigned char *indata, unsigned char *outdata);

 /** \endcond */
 
 /** define an array of all available receivers */
 /** \endcond */
 
 /** define an array of all available receivers */


@@ -163,7 +143,3 @@ extern void (*crypt_function_recv)(unsigned long len, const unsigned char *indat
        {.name = NULL}};
 
 void *check_receiver_arg(char *ra, int *receiver_num);
        {.name = NULL}};
 
 void *check_receiver_arg(char *ra, int *receiver_num);

-
-
-extern void (*crypt_function_send)(unsigned long len, const unsigned char *indata, unsigned char *outdata);
-