From 6573a8ff9a3321eb92dd7f4a118e97ebdafdaea9 Mon Sep 17 00:00:00 2001
From: nehalmistry <>
Date: Thu, 12 Dec 2002 03:52:13 +0000
Subject: [PATCH] fixed up comments
---
src/sound/cdda.cpp | 24 ++++++++++++++++++++++--
src/sound/mad.cpp | 8 ++++----
2 files changed, 26 insertions(+), 6 deletions(-)
diff --git a/src/sound/cdda.cpp b/src/sound/cdda.cpp
index 65ba6a8fe..3b0fbeb90 100644
--- a/src/sound/cdda.cpp
+++ b/src/sound/cdda.cpp
@@ -8,7 +8,7 @@
// T H E W A R B E G I N S
// FreeCraft - A free fantasy real time strategy game engine
//
-/**@name wav.c - wav support */
+/**@name cdda.c - cdda support */
//
// (c) Copyright 2002 by Lutz Sammer and Fabrice Rossi
//
@@ -38,6 +38,9 @@
#include "sound.h"
#include "sound_server.h"
+/*----------------------------------------------------------------------------
+-- Declarations
+----------------------------------------------------------------------------*/
local struct cdrom_read_audio readdata;
local void *bufstart;
@@ -47,6 +50,15 @@ static local int pos;
-- Functions
----------------------------------------------------------------------------*/
+/**
+** Type member function to read from the cd
+**
+** @param sample Sample reading from
+** @param buf Buffer to write data to
+** @param len Length of the buffer
+**
+** @return Number of bytes read
+*/
local int CDRead(Sample *sample, void *buf, int len)
{
static int count = 0;
@@ -92,11 +104,19 @@ local int CDRead(Sample *sample, void *buf, int len)
return len;
}
+/**
+** Type member function to free CDDA sample
+**
+** @param sample Sample to free
+*/
local void CDFree(Sample *sample)
{
free(sample);
}
+/**
+** CDDA object type structure.
+*/
local const SampleType CDStreamSampleType = {
CDRead,
CDFree,
@@ -106,7 +126,7 @@ local const SampleType CDStreamSampleType = {
** Load CD.
**
** @param name Unused.
-** @param flags Track number.
+** @param flags Unused.
**
** @return Returns the loaded sample.
**
diff --git a/src/sound/mad.cpp b/src/sound/mad.cpp
index ef424819a..c71ad1e9b 100644
--- a/src/sound/mad.cpp
+++ b/src/sound/mad.cpp
@@ -184,7 +184,7 @@ local enum mad_flow MAD_error(void *user __attribute__((unused)),
#if 0
/**
-** Type member function to read from the ogg file
+** Type member function to read from the Mp3 file
**
** @param sample Sample reading from
** @param buf Buffer to write data to
@@ -234,7 +234,7 @@ local int Mp3ReadStream(Sample* sample, void* buf, int len)
}
/**
-** Type member function to free an ogg file
+** Type member function to free an Mp3 file
**
** @param sample Sample to free
*/
@@ -260,7 +260,7 @@ local const SampleType Mp3StreamSampleType = {
#endif
/**
-** Type member function to read from the ogg file
+** Type member function to read from the Mp3 file
**
** @param sample Sample reading from
** @param buf Buffer to write data to
@@ -284,7 +284,7 @@ local int Mp3Read(Sample* sample, void* buf, int len)
}
/**
-** Type member function to free an ogg file
+** Type member function to free an Mp3 file
**
** @param sample Sample to free
*/