From: Andre Noll <maan@systemlinux.org>
Date: Sat, 5 May 2012 10:48:27 +0000 (+0200)
Subject: Merge branch 't/doc'
X-Git-Tag: v0.4.11~22
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=39ec52d7bfec591dcad0d41bcdbdf6d980bf5913;hp=e44d3f1b40bc98f15421b49fe0f5f19c679de007

Merge branch 't/doc'
---

diff --git a/NEWS b/NEWS
index 4863abe4..dfe779ee 100644
--- a/NEWS
+++ b/NEWS
@@ -2,6 +2,7 @@
 0.4.11 (to be announced "mutual diversity")
 -------------------------------------------
 
+	- Documentation improvements.
 ------------------------------------------
 0.4.10 (2012-03-30) "heterogeneous vacuum"
 ------------------------------------------
diff --git a/audiod.c b/audiod.c
index d7765e21..8e117e92 100644
--- a/audiod.c
+++ b/audiod.c
@@ -77,6 +77,12 @@ enum vss_status_flags {
 	VSS_STATUS_FLAG_PLAYING = 2,
 };
 
+/**
+ * The scheduler instance of para_audiod.
+ *
+ * This is needed also in audiod_command.c (for the tasks command), so it can
+ * not be made static.
+ */
 struct sched sched = {.max_fileno = 0};
 
 /**
diff --git a/bitstream.c b/bitstream.c
index 1139edc0..ddad67bb 100644
--- a/bitstream.c
+++ b/bitstream.c
@@ -27,6 +27,7 @@
 #include "wma.h"
 #include "bitstream.h"
 
+/** Read an 8, 16, or 32 bit entity from a VLC table. */
 #define GET_DATA(v, table, i, size) \
 {\
 	const uint8_t *ptr = (const uint8_t *)table + i * size; \
@@ -160,6 +161,14 @@ void init_vlc(struct vlc *vlc, int nb_bits, int nb_codes, const void *bits,
 	build_table(vlc, nb_bits, nb_codes, bits, codes, codes_size, 0, 0);
 }
 
+/**
+ * Deallocate all resources of a VLC table.
+ *
+ * \param vlc Pointer to an initialized vlc structure.
+ *
+ * The table given by \a vlc must have been initialized earlier via \ref
+ * init_vlc().
+ */
 void free_vlc(struct vlc *vlc)
 {
 	freep(&vlc->table);
diff --git a/daemon.c b/daemon.c
index c47aa954..7f710175 100644
--- a/daemon.c
+++ b/daemon.c
@@ -65,8 +65,6 @@ void daemon_set_default_log_colors(void)
  * \param arg The loglevel/color specifier.
  *
  * \a arg must be of the form "ll:[fg [bg]] [attr]".
- *
- * \return 1 On success, -1 on errors.
  */
 void daemon_set_log_color_or_die(char const *arg)
 {
diff --git a/ggo.h b/ggo.h
index d1105ef8..936fb107 100644
--- a/ggo.h
+++ b/ggo.h
@@ -7,7 +7,7 @@
 /** \file ggo.h Functions and structures for help text handling. */
 
 /**
- * Used by exexutables that can not use gengetopt's generated help function.
+ * Used by executables that can not use gengetopt's generated help function.
  */
 struct ggo_help {
 	/** The lines of the short help text. */
diff --git a/para.h b/para.h
index 3b9559e1..0a14b99a 100644
--- a/para.h
+++ b/para.h
@@ -71,6 +71,11 @@ extern __printf_2_3 void (*para_log)(int, const char*, ...);
 		vfprintf(stderr, fmt, argp); \
 		va_end(argp); \
 	}
+/**
+ * Define the standard log function and activate it.
+ *
+ * \param loglevel_barrier See \ref DEFINE_STDERR_LOGGER.
+ */
 #define INIT_STDERR_LOGGING(loglevel_barrier) \
 	DEFINE_STDERR_LOGGER(stderr_log, loglevel_barrier); \
 	__printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
diff --git a/recv.h b/recv.h
index ef2a596b..c69520e4 100644
--- a/recv.h
+++ b/recv.h
@@ -108,9 +108,9 @@ struct receiver {
 	 * Evaluate the result from select().
 	 *
 	 * This hook gets called after the call to select(). It should check
-	 * all file descriptors which were added to any of the the fd sets
-	 * during the previous call to pre_select. According to the result, it
-	 * may then use any non-blocking I/O to establish a connection or to
+	 * all file descriptors which were added to any of the fd sets during
+	 * the previous 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.
diff --git a/sched.c b/sched.c
index 74f6a1b8..2b54ce19 100644
--- a/sched.c
+++ b/sched.c
@@ -192,6 +192,8 @@ void register_task(struct sched *s, struct task *t)
 /**
  * Unregister all tasks.
  *
+ * \param s The scheduler instance to shut down.
+ *
  * This will cause \a schedule() to return immediately because both the
  * \a pre_select_list and the \a post_select_list are empty. This function
  * must be called from the post_select (rather than the pre_select) method.
@@ -213,6 +215,8 @@ void sched_shutdown(struct sched *s)
 /**
  * Get the list of all registered tasks.
  *
+ * \param s The scheduler instance to get the task list from.
+ *
  * \return The task list.
  *
  * Each entry of the list contains an identifier which is simply a hex number.
diff --git a/server.c b/server.c
index d3a9a5ae..8e8cb5fd 100644
--- a/server.c
+++ b/server.c
@@ -17,7 +17,8 @@
  *	  \ref audioc.c, \ref afh.c
  *	- Server: \ref server_command, \ref sender,
  *	- Audio file selector: \ref audio_format_handler, \ref afs_table,
- *	- Client: \ref receiver, \ref receiver_node, \ref filter, \ref filter_node.
+ *	- Client: \ref receiver, \ref receiver_node, \ref filter,
+ *	  \ref filter_node, \ref writer_node.
  *
  *
  * The gory details, listed by topic:
@@ -26,6 +27,7 @@
  *	  \ref ogg_afh.c, \ref aac_afh.c, \ref wma_afh.c, \ref spx_afh.c
  * 	- Decoders: \ref mp3dec_filter.c, \ref oggdec_filter.c,
  *	  \ref aacdec_filter.c, \ref wmadec_filter.c, spxdec_filter.c,
+ *	  \ref flacdec_filter.c,
  *	- Volume normalizer: \ref compress_filter.c,
  *	- Output: \ref alsa_write.c, \ref osx_write.c, \ref oss_write.c,
  * 	- http: \ref http_recv.c, \ref http_send.c,
@@ -50,9 +52,10 @@
  *	- Spawning processes: \ref exec.c,
  *	- Inter process communication: \ref ipc.c,
  *	- Blob tables: \ref blob.c,
- *	- The error subssystem: \ref error.h.
+ *	- The error subsystem: \ref error.h.
  *	- Access control for paraslash senders: \ref acl.c, \ref acl.h.
  *	- Internal crypto API: \ref crypt.h.
+ *	- interactive sessions (libreadline): \ref interactive.c.
  *
  * Low-level data structures:
  *