summaryrefslogtreecommitdiff
path: root/src/music
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2008-05-06 15:11:33 +0000
committerrubidium <rubidium@openttd.org>2008-05-06 15:11:33 +0000
commitd03994098be29bd48f3b715c533ffac3b1315eb0 (patch)
tree6bfd044ea899467ce35f766d2c1c8a4e2df7dea9 /src/music
parentfb938a2cb3fb7cfe6ca447dca5fc28bac78ed2e8 (diff)
downloadopenttd-d03994098be29bd48f3b715c533ffac3b1315eb0.tar.xz
(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.
Diffstat (limited to 'src/music')
-rw-r--r--src/music/bemidi.cpp2
-rw-r--r--src/music/bemidi.h2
-rw-r--r--src/music/dmusic.cpp2
-rw-r--r--src/music/dmusic.h2
-rw-r--r--src/music/extmidi.cpp2
-rw-r--r--src/music/extmidi.h2
-rw-r--r--src/music/libtimidity.cpp2
-rw-r--r--src/music/libtimidity.h2
-rw-r--r--src/music/music_driver.hpp2
-rw-r--r--src/music/null_m.cpp2
-rw-r--r--src/music/null_m.h2
-rw-r--r--src/music/os2_m.cpp2
-rw-r--r--src/music/os2_m.h2
-rw-r--r--src/music/qtmidi.h2
-rw-r--r--src/music/win32_m.cpp2
-rw-r--r--src/music/win32_m.h2
16 files changed, 30 insertions, 2 deletions
diff --git a/src/music/bemidi.cpp b/src/music/bemidi.cpp
index ab5634cca..41bd4ee4f 100644
--- a/src/music/bemidi.cpp
+++ b/src/music/bemidi.cpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file bemidi.cpp */
+/** @file bemidi.cpp Support for BeOS midi. */
#include "../stdafx.h"
#include "../openttd.h"
diff --git a/src/music/bemidi.h b/src/music/bemidi.h
index 096249c24..691159738 100644
--- a/src/music/bemidi.h
+++ b/src/music/bemidi.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file bemidi.h Base of BeOS Midi support. */
+
#ifndef MUSIC_BEMIDI_H
#define MUSIC_BEMIDI_H
diff --git a/src/music/dmusic.cpp b/src/music/dmusic.cpp
index a29af52a8..4c4707257 100644
--- a/src/music/dmusic.cpp
+++ b/src/music/dmusic.cpp
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file dmusic.cpp */
+/** @file dmusic.cpp Playing music via DirectMusic. */
#ifdef WIN32_ENABLE_DIRECTMUSIC_SUPPORT
diff --git a/src/music/dmusic.h b/src/music/dmusic.h
index b04e42d9f..ea16ecb38 100644
--- a/src/music/dmusic.h
+++ b/src/music/dmusic.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file dmusic.h Base of playing music via DirectMusic.
+
#ifndef MUSIC_DMUSIC_H
#define MUSIC_DMUSIC_H
diff --git a/src/music/extmidi.cpp b/src/music/extmidi.cpp
index af33bdb0e..a4c5bfb00 100644
--- a/src/music/extmidi.cpp
+++ b/src/music/extmidi.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file extmidi.cpp Playing music via an external player. */
+
#ifndef __MORPHOS__
#include "../stdafx.h"
#include "../openttd.h"
diff --git a/src/music/extmidi.h b/src/music/extmidi.h
index d5fa2ba2f..b5af27722 100644
--- a/src/music/extmidi.h
+++ b/src/music/extmidi.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file extmidi.h Base support for playing music via an external application. */
+
#ifndef MUSIC_EXTERNAL_H
#define MUSIC_EXTERNAL_H
diff --git a/src/music/libtimidity.cpp b/src/music/libtimidity.cpp
index 2457881fd..ad8fd8390 100644
--- a/src/music/libtimidity.cpp
+++ b/src/music/libtimidity.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file libtimidity.cpp Playing music via the timidity library. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../sound_type.h"
diff --git a/src/music/libtimidity.h b/src/music/libtimidity.h
index 965a19573..43b8ee052 100644
--- a/src/music/libtimidity.h
+++ b/src/music/libtimidity.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file libtimidity.h Base for LibTimidity music playback. */
+
#ifndef MUSIC_LIBTIMIDITY_H
#define MUSIC_LIBTIMIDITY_H
diff --git a/src/music/music_driver.hpp b/src/music/music_driver.hpp
index a8b6ab479..c4cc6bc3f 100644
--- a/src/music/music_driver.hpp
+++ b/src/music/music_driver.hpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file music_driver.hpp Base for all music playback. */
+
#ifndef MUSIC_MUSIC_DRIVER_HPP
#define MUSIC_MUSIC_DRIVER_HPP
diff --git a/src/music/null_m.cpp b/src/music/null_m.cpp
index 063ad2e10..51cd04b26 100644
--- a/src/music/null_m.cpp
+++ b/src/music/null_m.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file null_m.cpp The music playback that is silent. */
+
#include "../stdafx.h"
#include "null_m.h"
diff --git a/src/music/null_m.h b/src/music/null_m.h
index fc5c2bb09..bced36cf3 100644
--- a/src/music/null_m.h
+++ b/src/music/null_m.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file null_m.h Base for the silent music playback. */
+
#ifndef MUSIC_NULL_H
#define MUSIC_NULL_H
diff --git a/src/music/os2_m.cpp b/src/music/os2_m.cpp
index 04add6e95..4461f003f 100644
--- a/src/music/os2_m.cpp
+++ b/src/music/os2_m.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file os2_m.cpp Music playback on OS/2. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "os2_m.h"
diff --git a/src/music/os2_m.h b/src/music/os2_m.h
index 3ba1b5de6..76c0800a3 100644
--- a/src/music/os2_m.h
+++ b/src/music/os2_m.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file os2_m.h Base for OS2 music playback. */
+
#ifndef MUSIC_OS2_H
#define MUSIC_OS2_H
diff --git a/src/music/qtmidi.h b/src/music/qtmidi.h
index 1106b1508..3eeedebd6 100644
--- a/src/music/qtmidi.h
+++ b/src/music/qtmidi.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file qtmidi.h Base of music playback via the QuickTime driver. */
+
#ifndef MUSIC_MACOSX_QUICKTIME_H
#define MUSIC_MACOSX_QUICKTIME_H
diff --git a/src/music/win32_m.cpp b/src/music/win32_m.cpp
index 8ad964977..ef2c826b3 100644
--- a/src/music/win32_m.cpp
+++ b/src/music/win32_m.cpp
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file win32_m.cpp Music playback for Windows. */
+
#include "../stdafx.h"
#include "win32_m.h"
#include <windows.h>
diff --git a/src/music/win32_m.h b/src/music/win32_m.h
index 9d6684738..1fc2f8225 100644
--- a/src/music/win32_m.h
+++ b/src/music/win32_m.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file win32_m.h Base for Windows music playback. */
+
#ifndef MUSIC_WIN32_H
#define MUSIC_WIN32_H