From 755bbd9fa36e16f266467bed60b158e5737bd838 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sat, 15 Sep 2007 23:33:52 +0200 Subject: [PATCH] Some documentation fixes. MAke doxygen happy again and add documentation for com_setatt(). --- afs.cmd | 34 +++++++++++++++++++++------------- attribute.c | 2 +- net.h | 5 +++-- osl.c | 5 +---- time.c | 5 ++--- 5 files changed, 28 insertions(+), 23 deletions(-) diff --git a/afs.cmd b/afs.cmd index 79cb84ee..019bcc9c 100644 --- a/afs.cmd +++ b/afs.cmd @@ -28,9 +28,10 @@ H: -v Verbose mode. Print what is being done. --- N: init P: AFS_READ | AFS_WRITE -D: FIXME -U: FIXME -H: FIXME +D: Initialize the osl tables for the audio file selector. +U: init [table_name ...] +H: When invoked without arguments, this command creates all tables. Otherwise +H: only the tables given by table_name... are created. --- N: afs_ls P: AFS_READ @@ -70,21 +71,28 @@ N: lsatt P: AFS_READ D: List attributes U: lsatt [-a] [-l] -H: +H: H: Print the list of all defined attributes. -H: +H: H: Options: -H: -a Sort attributes alphabetically by name. The default is to sort by attribute -H: identifier. -H: -H: -l Print a long listing containing both identifier and attribute name. The -H: default is to print only the name. +H: -a Sort attributes alphabetically by name. The default is to sort by +H: identifier. +H: +H: -l Print a long listing containing both identifier and attribute name. The +H: default is to print only the name. --- N: setatt P: AFS_READ | AFS_WRITE D: FIXME -U: FIXME -H: FIXME +U: setatt attribute1{+|-} [attribute2{+|-}...] pattern + +H: Set ('+') or unset ('-') the given attributes for all audio files matching +H: pattern. Example: +H: +H: sa rock+ punk+ classic- '*foo.mp3' +H: +H: sets the 'rock' and the 'punk' attribute but unsets the 'classic' +H: attribute of all files ending with 'foo.mp3'. --- N: addatt P: AFS_READ | AFS_WRITE @@ -123,7 +131,7 @@ N: ls@member@ O: int com_ls@member@(int fd, int argc, char * const * const argv); P: AFS_READ D: FIXME -U: cat@member@ +U: ls@member@ pattern H: FIXME --- T: rm diff --git a/attribute.c b/attribute.c index 66312b2a..9a7cb45a 100644 --- a/attribute.c +++ b/attribute.c @@ -373,7 +373,7 @@ int com_rmatt(__a_unused int fd, int argc, char * const * const argv) * \param buf Result. * * This function prints a string of at most 64 characters plus the terminating - * \p NULL character into \buf which must be provided by the caller and at + * \p NULL character into \a buf which must be provided by the caller and at * least 65 bytes long. The "x" character is used for set attributes and "-" is * used for unset attributes. * diff --git a/net.h b/net.h index 8fdaa3ee..d42031e8 100644 --- a/net.h +++ b/net.h @@ -45,7 +45,8 @@ void disable_crypt(int fd); * A wrapper around connect(2). * * \param fd The file descriptor. - * \param their_addr The address to connect. + * \param addr The address to connect. + * \param len The size of \a addr. * * This should not be called directly. Always use the PARA_CONNECT macro. * @@ -53,7 +54,7 @@ void disable_crypt(int fd); * * \sa connect(2), PARA_CONNECT. */ -_static_inline_ int _para_connect(int fd, void *addr, socklen_t len) +static inline int _para_connect(int fd, void *addr, socklen_t len) { if (connect(fd, (struct sockaddr *)addr, len) == -1) return -E_CONNECT; diff --git a/osl.c b/osl.c index 6743b66b..b1aaf3e5 100644 --- a/osl.c +++ b/osl.c @@ -12,9 +12,6 @@ #include /* readdir() */ #include -//#define FMT_OFF_T "%li" - - /** * A wrapper for lseek(2). * @@ -41,7 +38,7 @@ int para_lseek(int fd, off_t *offset, int whence) } /** - * Waraper for the write system call. + * Wrapper for the write system call. * * \param fd The file descriptor to write to. * \param buf The buffer to write. diff --git a/time.c b/time.c index 809cefc9..b7713829 100644 --- a/time.c +++ b/time.c @@ -53,7 +53,7 @@ void d2tv(double x, struct timeval *tv) * If \a diff is not \p NULL, it contains the absolute value |\a b - \a a| on * return. * - * \return If \a b < \a, this function returns -1, otherwise it returns 1. + * \return If \a b < \a a, this function returns -1, otherwise it returns 1. */ int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *diff) { @@ -82,8 +82,7 @@ int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *di * * \param a First addend. * \param b Second addend. - * - * \param \a Sum contains the sum \a + \a b on return. + * \param sum Contains the sum \a + \a b on return. */ void tv_add(const struct timeval *a, const struct timeval *b, struct timeval *sum) -- 2.39.2