From: Andre Noll <maan@systemlinux.org>
Date: Sat, 14 Apr 2012 21:17:03 +0000 (+0200)
Subject: Add some missing documentation.
X-Git-Tag: v0.4.11~22^2~4
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=460bc598cfeabcdbf7f249061be5af82fd5a4ea9;p=paraslash.git

Add some missing documentation.

This makes doxygen a bit happier.
---

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/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/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.