* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file cgi/login.c
+ * @brief Web login support
+ */
#include "disorder-cgi.h"
/** @brief Client used by CGI
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file clients/authorize.c
+ * @brief Create a new login
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file clients/authorize.h
+ * @brief Create a new login
+ */
#ifndef AUTHORIZE_H
#define AUTHORIZE_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file clients/disorder.c
+ * @brief Command-line client
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file clients/disorderfm.c
+ * @brief DisOrder file manager
+ *
+ * Intended to support encoding conversion, tag extraction, etc. Not yet
+ * complete (and hasn't been worked on for ages).
+ */
#include "common.h"
#include <getopt.h>
-/* Grotty program to print out the bytes making up filenames in some
- * directory */
+/** @file clients/filename-bytes.c
+ * @brief Print out raw bytes of filenames in a directory
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/added.c
+ * @brief List of recently added tracks
+ */
#include "disobedience.h"
#include "popup.h"
#include "queue-generic.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/choose-menu.c
+ * @brief Popup menu for choose screen
+ */
#include "disobedience.h"
#include "popup.h"
#include "choose.h"
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file disobedience/choose-search.c
- * @brief Search support
+ * @brief Search support for Disobedience choose window
*/
#include "disobedience.h"
#include "choose.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/choose.h
+ * @brief Choose window for Disobedience
+ */
#ifndef CHOOSE_H
#define CHOOSE_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/lookup.c
+ * @brief Disobedience server lookups and caching
+ */
#include "disobedience.h"
static int namepart_lookups_outstanding;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/popup.c
+ * @brief Disobedience popup menus
+ */
#include "disobedience.h"
#include "popup.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/popup.h
+ * @brief Disobedience popup menus
+ */
#ifndef POPUP_H
#define POPUP_H
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file disobedience/queue-generic.c
- * @brief Queue widgets
+ * @brief Disobedience queue widgets
*
* This file provides contains code shared between all the queue-like
* widgets - the queue, the recent list and the added tracks list.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/queue-generic.h
+ * @brief Disobedience queue widgets
+ */
#ifndef QUEUE_GENERIC_H
#define QUEUE_GENERIC_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/queue-menu.c
+ * @brief Disobedience queue widget popup menu
+ */
#include "disobedience.h"
#include "popup.h"
#include "queue-generic.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/queue.c
+ * @brief Disobedience queue widget
+ */
#include "disobedience.h"
#include "popup.h"
#include "queue-generic.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file disobedience/recent.c
+ * @brief Disobedience recently-played widget
+ */
#include "disobedience.h"
#include "popup.h"
#include "queue-generic.h"
definitions.h: Makefile
rm -f $@.new
- echo "#define PKGLIBDIR \"${pkglibdir}\"" > $@.new
+ echo "/** @file lib/definitions.h" >> $@.new
+ echo " * @brief Definitions exported from makefile" >> $@.new
+ echo " *" >> $@.new
+ echo " * DO NOT EDIT." >> $@.new
+ echo " */" >> $@.new
+ echo "#define PKGLIBDIR \"${pkglibdir}\"" >> $@.new
echo "#define PKGCONFDIR \"${sysconfdir}/\"PACKAGE" >> $@.new
echo "#define PKGSTATEDIR \"${localstatedir}/\"PACKAGE" >> $@.new
echo "#define PKGDATADIR \"${pkgdatadir}/\"" >> $@.new
* 02110-1301, USA.
*
*/
-
-/* Code from Libgcrypt adapted for gnulib by Simon Josefsson. */
-
-/*
+/** @file lib/arcfour.c
+ * @brief Arcfour (RC4-compatible) stream cipher implementation
+ *
+ * Code from Libgcrypt adapted for gnulib by Simon Josefsson.
+ *
* For a description of the algorithm, see:
+ *
* Bruce Schneier: Applied Cryptography. John Wiley & Sons, 1996.
* ISBN 0-471-11709-9. Pages 397 ff.
*/
* 02110-1301, USA.
*
*/
+/** @file lib/arcfour.h
+ * @brief Arcfour (RC4-compatible) stream cipher implementation
+ */
/* Code from Libgcrypt adapted for gnulib by Simon Josefsson. */
/*
* This file is part of DisOrder.
- * Copyright (C) 2004, 2006, 2007 Richard Kettlewell
+ * Copyright (C) 2004, 2006, 2007, 2008 Richard Kettlewell
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/authhash.h @brief The authorization hash */
#ifndef AUTHHASH_H
#define AUTHHASH_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/basen.h @brief Arbitrary base conversion */
#ifndef BASEN_H
#define BASEN_H
-
/*
* This file is part of DisOrder.
* Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/charset.h @brief Character set conversion */
#ifndef CHARSET_H
#define CHARSET_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/client-common.c
+ * @brief Common code to client APIs
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/client-common.h
+ * @brief Common code to client APIs
+ */
#ifndef CLIENT_COMMON_H
#define CLIENT_COMMON_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/defs.h @brief Definitions chosen by configure */
#ifndef DEFS_H
#define DEFS_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/event.h
+ * @brief DisOrder event loop
+ */
#ifndef EVENT_H
#define EVENT_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/eventdist.c
+ * @brief Event distribution
+ */
#include "common.h"
#include "mem.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/eventdist.h
+ * @brief Event distribution
+ */
#ifndef EVENTDIST_H
#define EVENTDIST_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/eventlog.c
+ * @brief Event logging
+ */
#include "common.h"
#include <stdarg.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/eventlog.h
+ * @brief Event logging
+ */
#ifndef EVENTLOG_H
#define EVENTLOG_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/fprintf.c
+ * @brief UTF-8 workalike for fprintf() and vfprintf()
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/hash.c
+ * @brief A simple hash table
+ */
#include "common.h"
#include "hash.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/hash.h
+ * @brief A simple hash table
+ */
#ifndef HASH_H
#define HASH_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/hex.h @brief Hexadecimal encoding and decoding */
#ifndef HEX_H
#define HEX_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/hostname.c
+ * @brief Get the local hostname
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/hostname.h
+ * @brief Get the local hostname
+ */
#ifndef HOSTNAME_H
#define HOSTNAME_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/inputline.h
+ * @brief Line input
+ */
#ifndef INPUTLINE_H
#define INPUTLINE_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/kvp.c
+ * @brief Linked list of key-value pairs
+ *
+ * Also supports URL encoding/decoding (of raw strings and kvp lists).
+ *
+ * For large sets of keys, see @ref lib/hash.c.
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/kvp.h
+ * @brief Linked list of key-value pairs
+ */
#ifndef KVP_H
#define KVP_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/log.h
+ * @brief Errors and logging
+ */
#ifndef LOG_H
#define LOG_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/logfd.c
+ * @brief Redirect subprocess stderr to DisOrder server's log
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/logfd.h
+ * @brief Redirect subprocess stderr to DisOrder server's log
+ */
#ifndef LOGFD_H
#define LOGFD_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/mem.h
+ * @brief Memory management
+ */
#ifndef MEM_H
#define MEM_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/memgc.c
+ * @brief Memory management with garbage collection
+ */
#define GC 1
#include "mem.c"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/printf.c
+ * @brief UTF-8 *printf workalike (core)
+ */
#define NO_MEMORY_ALLOCATION
/* because byte_snprintf used from log.c */
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/printf.h
+ * @brief UTF-8 *printf workalikes
+ */
#ifndef PRINTF_H
#define PRINTF_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/queue.c
+ * @brief Track queues
+ */
#include "common.h"
#include <errno.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/queue.h
+ * @brief Track queues
+ *
+ * Used for the queue, the recently played list and the currently playing
+ * track, both in the server and in clients.
+ */
#ifndef QUEUE_H
#define QUEUE_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/regsub.c
+ * @brief Regexp substitution
+ */
#include "common.h"
#include <pcre.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/regsub.h
+ * @brief Regexp substitution
+ */
#ifndef REGSUB_H
#define REGSUB_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/rtp.h
+ * @brief RTP packet header format
+ *
+ * See <a href="http://www.ietf.org/rfc/rfc1889.txt">RFC1889</a>.
+ */
#ifndef RTP_H
#define RTP_H
-/* RTP is defined in RFC1889 */
+/** @brief RTP packet header format
+ *
+ * See <a href="http://www.ietf.org/rfc/rfc1889.txt">RFC1889</a> (now obsoleted
+ * by <a href="http://www.ietf.org/rfc/rfc3550.txt">RFC3550</a>).
+ */
struct attribute((packed)) rtp_header {
+ /** @brief Version, padding, extension and CSRC
+ *
+ * Version is bits 6 and 7; currently always 2.
+ *
+ * Padding is bit 5; if set frame includes padding octets.
+ *
+ * eXtension is bit 4; if set there is a header extension.
+ *
+ * CSRC Count is bits 0-3 and is the number of CSRC identifiers following the
+ * header.
+ */
uint8_t vpxcc;
+
+ /** @brief Marker and payload type
+ *
+ * Marker is bit 7. Profile-defined.
+ *
+ * Payload Type is bits 0-6. Profile defined.
+ */
uint8_t mpt;
+
+ /** @brief Sequence number */
uint16_t seq;
+
+ /** @brief Timestamp */
uint32_t timestamp;
+
+ /** @brief Synchronization source */
uint32_t ssrc;
};
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/sendmail.c
+ * @brief Sending email
+ *
+ * Can send email either via a local MTA or by connecting to an SMTP TCP port.
+ * The former is preferred as there is a strong implication that the local MTA
+ * will queue for you than some random TCP SMTP server you found.
+ */
#include "common.h"
#include <errno.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/sendmail.h
+ * @brief Sending email
+ */
#ifndef SENDMAIL_H
#define SENDMAIL_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/signame.c
+ * @brief Signal names
+ */
#include "common.h"
#include <signal.h>
#undef S
};
+/** @brief Map a signal name to its number
+ * @param s Signal name e.g. "SIGINT"
+ * @return Signal value or -1 if not found
+ */
int find_signal(const char *s) {
int n;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/signame.h
+ * @brief Signal names
+ */
#ifndef SIGNAME_H
#define SIGNAME_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/snprintf.c
+ * @brief UTF-8 capable *snprintf workalikes
+ */
#define NO_MEMORY_ALLOCATION
/* because used from log.c */
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/split.c
+ * @brief String splitting
+ */
#include "common.h"
#include <ctype.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/split.h
+ * @brief String splitting
+ */
#ifndef SPLIT_H
#define SPLIT_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/syscalls.c
+ * @brief Error-checking library call wrappers
+ */
#include "common.h"
#include <unistd.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/syscalls.h
+ * @brief Error-checking library call wrappers
+ */
#ifndef SYSCALLS_H
#define SYSCALLS_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/table.c
+ * @brief Generic binary search
+ */
#include "common.h"
#include "table.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/table.h
+ * @brief Generic binary search
+ */
#ifndef TABLE_H
#define TABLE_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/timeval.h
+ * @brief Arithmetic on timeval structures
+ */
#ifndef TIMEVAL_H
#define TIMEVAL_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/trackdb-int.h
+ * @brief Track database internals */
#ifndef TRACKDB_INT_H
#define TRACKDB_INT_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/trackname.c
+ * @brief Track name calculation
+ */
#include "common.h"
#include <pcre.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/trackname.h
+ * @brief Track name calculation
+ */
#ifndef TRACKNAME_H
#define TRACKNAME_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/trackorder.c
+ * @brief Track ordering
+ */
#include "common.h"
#include <pcre.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/tracksort.c
+ * @brief Track ordering
+ */
#include "common.h"
#include "trackname.h"
-/* Automatically generated file, see scripts/make-unidata */
+/** @file lib/unidata.c
+ * @brief Unicode tables
+ *
+ * Automatically generated file, see scripts/make-unidata
+ *
+ * DO NOT EDIT.
+ */
#include "common.h"
#include "unidata.h"
#define Cc unicode_General_Category_Cc
-/* Automatically generated file, see scripts/make-unidata */
+/** @file lib/unidata.h
+ * @brief Unicode tables
+ *
+ * Automatically generated file, see scripts/make-unidata
+ *
+ * DO NOT EDIT.
+ */
#ifndef UNIDATA_H
#define UNIDATA_H
enum unicode_General_Category {
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/vacopy.h
+ * @brief va_copy fixup
+ */
#ifndef VACOPY_H
#define VACOPY_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/vector.c
+ * @brief Dynamic array utilities
+ */
#include "common.h"
#include <stddef.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file lib/version.c
+ * @brief Display version string and exit
+ */
#include "common.h"
#include "syscalls.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file lib/version.h
+ * @brief Display version string and exit
+ */
#ifndef VERSION_H
#define VERSION_H
-/* Derived from getdate.c in glibc 2.3.6. This is pretty much
+/** @file lib/xgetdate.c
+ * @brief Date parsing
+ *
+ * Derived from getdate.c in glibc 2.3.6. This is pretty much
* standard getdate() except that you supply the template in an
* argument, rather than messing around with environment variables and
- * files. */
+ * files.
+ */
/* Convert a string representation of time to a time value.
Copyright (C) 1997,1998,1999,2000,2001,2003 Free Software Foundation, Inc.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file plugins/exec.c
+ * @brief Plugin to play a track by executing a command
+ */
#include <config.h>
#include <unistd.h>
+/** @file plugins/execraw.c
+ * @brief Plugin to play a track by executing a command (raw mode)
+ *
+ * Shares code with @ref exec.c.
+ */
#define TYPE DISORDER_PLAYER_RAW
#include "exec.c"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file plugins/fs.c
+ * @brief Plugin to find tracks in a filesystem
+ */
#include <config.h>
#include <string.h>
-/* This file is a subset of the debian source tarball of mpg321-0.2.10.3/mad.c
- - see http://mpg321.sourceforge.net/ */
+/** @file plugins/mad.c
+ * @brief MP3 Length calculation
+ *
+ * This file is a subset of the debian source tarball of
+ * mpg321-0.2.10.3/mad.c - see http://mpg321.sourceforge.net/
+ */
/*
mpg321 - a fully free clone of mpg123.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file plugins/madshim.h
+ * @brief Integrate code from mpg123
+ */
#ifndef MADSHIM_H
#define MADSHIM_H
-/* shim to integrate code from mpg123 */
-
typedef struct {
int num_frames;
mad_timer_t duration;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file plugins/notify.c
+ * @brief Standard notify plugin
+ *
+ * The arrangements here are not very satisfactory - you wanted to be
+ * able to replace the plugin but still keep its features. So you
+ * wanted a list of plugins really.
+ */
#include "common.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file plugins/shell.c
+ * @brief Plugin to execute track players via the shell.
+ */
#include <config.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file plugins/tracklength.c
+ * @brief Plugin to compute track lengths
+ *
+ * Currently implements MP3, OGG, FLAC and WAV.
+ */
#include <config.h>
print STDERR "Generating unidata.h...\n";
open(STDOUT, ">unidata.h") or die "unidata.h: $!\n";
-out("/* Automatically generated file, see scripts/make-unidata */\n",
+out("/** \@file lib/unidata.h\n",
+ " * \@brief Unicode tables\n",
+ " *\n",
+ " * Automatically generated file, see scripts/make-unidata\n",
+ " *\n",
+ " * DO NOT EDIT.\n",
+ " */\n",
"#ifndef UNIDATA_H\n",
"#define UNIDATA_H\n");
print STDERR "Generating unidata.c...\n";
open(STDOUT, ">unidata.c") or die "unidata.c: $!\n";
-out("/* Automatically generated file, see scripts/make-unidata */\n",
+out("/** \@file lib/unidata.c\n",
+ " * \@brief Unicode tables\n",
+ " *\n",
+ " * Automatically generated file, see scripts/make-unidata\n",
+ " *\n",
+ " * DO NOT EDIT.\n",
+ " */\n",
"#include \"common.h\"\n",
"#include \"unidata.h\"\n");
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file server/api-server.c
+ * @brief Server API functions
+ *
+ * These functions are made available to server-side plugins.
+ */
#include "disorder-server.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file server/api.c
+ * @brief Generic API
+ *
+ * These functions are made available to all kinds of plugins.
+ */
#include "disorder-server.h"
/* shared implementation of vararg functions */
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file server/dbupgrade.c
+ * @brief Database upgrade utility
+ *
+ * Invoked by the server when necessary.
+ */
#include "disorder-server.h"
static DB_TXN *global_tid;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file server/deadlock.c
+ * @brief Deadlock monitor
+ *
+ * Spawned by the server.
+ */
#include "disorder-server.h"
static const struct option options[] = {
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file server/disorder-server.h
+ * @brief Definitions for server and allied utilities
+ */
#ifndef DISORDER_SERVER_H
#define DISORDER_SERVER_H
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file server/disorderd.c
+ * @brief Main DisOrder server
+ */
#include "disorder-server.h"
static ev_source *ev;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file server/dump.c
+ * @brief Dump and restore database contents
+ */
#include "disorder-server.h"
static const struct option options[] = {
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file server/exports.c
+ * @brief Server exports
+ *
+ * Force functions to be included in the server so they can be exported
+ * to plugins.
+ */
#include "disorder.h"
typedef void (*fptr)(void);
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file server/play.c
+ * @brief Playing tracks
+ */
#include "disorder-server.h"
#include <ao/ao.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file server/plugin.c
+ * @brief Server plugin interface
+ */
#include "disorder-server.h"
#include <dlfcn.h>
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file server/queue-ops.c
+ * @brief Track queues (server-specific code)
+ */
#include "disorder-server.h"
static int find_in_list(struct queue_entry *needle,
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file server/rescan.c
+ * @brief Rescanning utility
+ *
+ * Invoked by the server.
+ */
#include "disorder-server.h"
static time_t last_report;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file server/state.c
+ * @brief Global server state
+ */
#include "disorder-server.h"
static const char *current_unix;
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/** @file server/stats.c
+ * @brief Generate server statistics
+ *
+ * This is done in a subprogram because it can be quite slow and we don't want
+ * to wedge the rest of the server for the duration.
+ */
#include "disorder-server.h"
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
+/** @file server/trackname.c
+ * @brief Utility to run the track name calculator in isolation
+ */
#include "disorder-server.h"
static const struct option options[] = {
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
-
+/** @file tests/udplog.c
+ * @brief UDP logging utility
+ *
+ * Intended for low-level debugging.
+ */
#include "common.h"
#include <getopt.h>
~mdw / disorder / commitdiff