From d03994098be29bd48f3b715c533ffac3b1315eb0 Mon Sep 17 00:00:00 2001 From: rubidium Date: Tue, 6 May 2008 15:11:33 +0000 Subject: (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. --- src/sound/cocoa_s.cpp | 2 ++ src/sound/cocoa_s.h | 2 ++ src/sound/null_s.cpp | 2 ++ src/sound/null_s.h | 2 ++ src/sound/sdl_s.cpp | 2 ++ src/sound/sdl_s.h | 2 ++ src/sound/sound_driver.hpp | 2 ++ src/sound/win32_s.cpp | 2 ++ src/sound/win32_s.h | 2 ++ 9 files changed, 18 insertions(+) (limited to 'src/sound') diff --git a/src/sound/cocoa_s.cpp b/src/sound/cocoa_s.cpp index 5642c36a0..9921cb0cf 100644 --- a/src/sound/cocoa_s.cpp +++ b/src/sound/cocoa_s.cpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file cocoa_s.cpp Sound driver for cocoa. */ + /***************************************************************************** * Cocoa sound driver * * Known things left to do: * diff --git a/src/sound/cocoa_s.h b/src/sound/cocoa_s.h index 9ec6ac5cb..079132c2d 100644 --- a/src/sound/cocoa_s.h +++ b/src/sound/cocoa_s.h @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file cocoa_s.h Base for Cocoa sound handling. */ + #ifndef SOUND_COCOA_H #define SOUND_COCOA_H diff --git a/src/sound/null_s.cpp b/src/sound/null_s.cpp index c8fe22ca3..03277ac8b 100644 --- a/src/sound/null_s.cpp +++ b/src/sound/null_s.cpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file null_s.cpp The sound driver that doesn't produce sound. */ + #include "../stdafx.h" #include "null_s.h" diff --git a/src/sound/null_s.h b/src/sound/null_s.h index 27b8d8980..49581fc18 100644 --- a/src/sound/null_s.h +++ b/src/sound/null_s.h @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file null_s.h Base for the sound of silence. */ + #ifndef SOUND_NULL_H #define SOUND_NULL_H diff --git a/src/sound/sdl_s.cpp b/src/sound/sdl_s.cpp index f9f40d4e3..753bce764 100644 --- a/src/sound/sdl_s.cpp +++ b/src/sound/sdl_s.cpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file sdl_s.cpp Playing sound via SDL. */ + #ifdef WITH_SDL #include "../stdafx.h" diff --git a/src/sound/sdl_s.h b/src/sound/sdl_s.h index 83edccc99..e897f8306 100644 --- a/src/sound/sdl_s.h +++ b/src/sound/sdl_s.h @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file sdl_s.h Base fo playing sound via SDL. */ + #ifndef SOUND_SDL_H #define SOUND_SDL_H diff --git a/src/sound/sound_driver.hpp b/src/sound/sound_driver.hpp index 55cc20be8..8f3f08579 100644 --- a/src/sound/sound_driver.hpp +++ b/src/sound/sound_driver.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file sound_driver.hpp Base for all sound drivers. */ + #ifndef SOUND_SOUND_DRIVER_HPP #define SOUND_SOUND_DRIVER_HPP diff --git a/src/sound/win32_s.cpp b/src/sound/win32_s.cpp index 386c6f4a5..66a7fde03 100644 --- a/src/sound/win32_s.cpp +++ b/src/sound/win32_s.cpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file win32_s.cpp Handling of sound for Windows. */ + #include "../stdafx.h" #include "../openttd.h" #include "../driver.h" diff --git a/src/sound/win32_s.h b/src/sound/win32_s.h index 8fbd8b0c1..71859af90 100644 --- a/src/sound/win32_s.h +++ b/src/sound/win32_s.h @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file win32_s.h Base for Windows sound handling. */ + #ifndef SOUND_WIN32_H #define SOUND_WIN32_H -- cgit v1.2.3-70-g09d2