Doxygen fixes.
authorAndre Noll <maan@systemlinux.org>
Wed, 24 Oct 2007 23:44:51 +0000 (01:44 +0200)
committerAndre Noll <maan@systemlinux.org>
Wed, 24 Oct 2007 23:44:51 +0000 (01:44 +0200)
Doxyfile
attribute.c
fd.c
score.c
server.c
signal.c

index 22c39e2..1b7f078 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -506,7 +506,7 @@ RECURSIVE              = NO
 # excluded from the INPUT source files. This way you can easily exclude a 
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = 
+EXCLUDE                = error2.h
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
 # directories that are symbolic links (a Unix filesystem feature) are excluded 
index b130ab2..f6ed0bb 100644 (file)
@@ -556,8 +556,6 @@ err:
 /**
  * Close the attribute table.
  *
- * \param flags Ususal flags that are passed to osl_close_table().
- *
  * \sa osl_close_table().
  */
 void attribute_close(void)
diff --git a/fd.c b/fd.c
index f9b3d9d..ecd87cd 100644 (file)
--- a/fd.c
+++ b/fd.c
@@ -281,11 +281,17 @@ int para_mkdir(const char *path, mode_t mode)
 }
 
 /**
- * Map a file into memory.
+ * Open a file and map it into memory.
  *
  * \param path Name of the regular file to map.
  * \param open_mode Either \p O_RDONLY or \p O_RDWR.
- * \param obj On success, the mapping is returned here.
+ * \param map On success, the mapping is returned here.
+ * \param size size of the mapping.
+ * \param fd_ptr The file descriptor of the mapping.
+ *
+ * If \a fd_ptr is \p NULL, the file descriptor resulting from the underlying
+ * open call is closed after mmap().  Otherwise the file is kept open and the
+ * file descriptor is returned in \a fd_ptr.
  *
  * \return Positive on success, negative on errors. Possible errors include: \p
  * E_FSTAT, any errors returned by para_open(), \p E_EMPTY, \p E_MMAP.
diff --git a/score.c b/score.c
index 6cfa647..2707e6a 100644 (file)
--- a/score.c
+++ b/score.c
@@ -377,7 +377,7 @@ static int score_event_handler(__a_unused enum afs_events event,
 /**
  * Initialize the scoring subsystem.
  *
- * \param t The members of \t are filled in by the function.
+ * \param t The members of \t are filled in by the function.
  */
 void score_init(struct afs_table *t)
 {
index f435104..c324413 100644 (file)
--- a/server.c
+++ b/server.c
@@ -4,14 +4,60 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file server.c Paraslash's main server */
+/** \file server.c Paraslash's main server. */
 
 
 /** \mainpage Paraslash API Reference
  *
- *  Good starting points for reading are probably \ref audio_file_selector,
- *  \ref sender, \ref receiver, \ref receiver_node, \ref filter, \ref
- *  filter_node.
+ * Starting points for getting an overview are
+ *
+ * probably:
+ *
+ *     - The main programs: \ref server.c, \ref audiod.c, \ref client.c,
+ *       \ref audioc.c, \ref fsck.c
+ *     - Server: \ref server_command, \ref sender,
+ *     - Audio file selector: \ref audio_format_handler, \ref mood, \ref afs_table,
+ *     - Client: \ref receiver, \ref receiver_node, \ref filter, \ref filter_node
+ *
+ *
+ * The gory details, listed by topic:
+ *
+ *     - Audio format handlers: \ref mp3_afh.c, \ref ogg_afh.c \ref aac_afh.c
+ *     - Decoders: \ref mp3dec.c, \ref \ref oggdec.c, \ref aacdec.c
+ *     - Volume normalizer: \ref compress.c
+ *     - Output: \ref alsa_write.c, \ref osx_write.c
+ *     - http: \ref http_recv.c, \ref http_send.c
+ *     - ortp: \ref ortp_recv.c, \ref ortp_send.c
+ *     - dccp: \ref dccp_recv.c, \ref dccp_send.c
+ *     - Audio file selector: \ref afs.c, \ref aft.c, \ref mood.c
+ *     - Afs structures: \ref afs_table, \ref audio_file_data,
+ *       \ref afs_info \ref audio_format_info,
+ *     - Afs tables: \ref aft.c, \ref mood.c, \ref playlist.c,
+ *       \ref attribute.c, \ref score.c.
+ *
+ * Lower levels:
+ *
+ *     - Scheduling: \ref sched.c, \ref sched.h
+ *     - Networking: \ref net.c,
+ *     - File descriptors: \ref fd.c,
+ *     - Signals: \ref signal.c,
+ *     - Daemons: \ref daemon.c,
+ *     - Strings: \ref string.c, string.h
+ *     - Time: \ref time.c, time.h
+ *     - Spawning processes: \ref exec.c
+ *     - Inter process communication: ipc.c,
+ *     - The object storage layer: \ref osl.c,
+ *     - Blob tables: blob.c,
+ *     - Queueing chunks of audio data: \ref chunk_queue.c
+ *     - The error subssystem: \ref error.h
+ *
+ * Lov-level data structures:
+ *
+ *     - Doubly linked lists: \ref list.h,
+ *     - Red-black trees: \ref rbtree.h, \ref rbtree.c
+ *     - Ring buffer: \ref ringbuffer.c, \ref ringbuffer.h
+ *     - Hashing: \ref hash.h, \ref sha1.h, \ref sha1.c
+ *     - Crypto: \ref crypt.c
  *
  */
 
@@ -46,16 +92,16 @@ INIT_SERVER_ERRLISTS;
 #define ALARM_TIMEOUT 10
 
 /**
- * pointer to shared memory area for communication between para_server
- * and its children. exported to vss.c. command.c and to all selectors.
+ * Pointer to shared memory area for communication between para_server
+ * and its children. Exported to vss.c. command.c and to afs.
  */
 struct misc_meta_data *mmd;
 
 /**
  * the configuration of para_server
  *
- * It also contains the options for all audio file selectors, audio format handler
- * and all supported senders.
+ * It also contains the options for the audio file selector, audio format
+ * handler and all supported senders.
  */
 struct server_args_info conf;
 
@@ -165,7 +211,7 @@ err_out:
 /**
  * lock the shared memory area containing the mmd struct
  *
- * \sa semop(2), struct misc_meta_data
+ * \sa semop(2), struct misc_meta_data.
  */
 void mmd_lock(void)
 {
index 128f6bb..92f76c7 100644 (file)
--- a/signal.c
+++ b/signal.c
@@ -64,7 +64,7 @@ static void generic_signal_handler(int s)
 /**
  * Reap one child.
  *
- * \para, pid In case a child died, its pid is returned here.
+ * \param pid In case a child died, its pid is returned here.
  *
  * Call waitpid() and print a log message containing the pid and the cause of
  * the child's death.