thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixing various doxygen warnings

Browse source 
svn-id: r25362
This commit is contained in:
Max Horn 2007-02-03 21:37:52 +00:00
parent a2b1ff0de8
commit 73c3625f1f
17 changed files with 39 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

2
backends/fs/abstract-fs.h
View file

@ -87,7 +87,7 @@ protected:
* identical to oldNode. Hence, we can use the "path" value for persistent
* storage e.g. in the config file.
*
* @TODO: This is of course a place where non-portable code easily will sneak
* @todo: This is of course a place where non-portable code easily will sneak
* in, because the format of the path used here is not well-defined.
* So we really should reconsider this API and try to come up with
* something which is more portable but still flexible enough for our

2
common/fs.cpp
View file

@ -95,7 +95,7 @@ FilesystemNode FilesystemNode::getParent() const {
}
}
FilesystemNode FilesystemNode::getChild(const String &n) const {
FilesystemNode FilesystemNode::getChild(const Common::String &n) const {
if (_realNode == 0)
return *this;

11
common/fs.h
View file

@ -63,7 +63,6 @@ class FSList : public Common::Array<FilesystemNode> {};
* we can build upon this.
*/
class FilesystemNode {
typedef Common::String String;
private:
AbstractFilesystemNode *_realNode;
int *_refCount;
@ -96,7 +95,7 @@ public:
* operating system doesn't support the concept), some other directory is
* used (usually the root directory).
*/
FilesystemNode(const String &path);
FilesystemNode(const Common::String &path);
/**
* Copy constructor.
@ -129,7 +128,7 @@ public:
* directory nodes (an assertion is triggered otherwise). If no no child
* node with the given name exists, an invalid node is returned.
*/
FilesystemNode getChild(const String &name) const;
FilesystemNode getChild(const Common::String &name) const;
/**
* Return a list of child nodes of this directory node. If called on a node
@ -155,7 +154,7 @@ public:
* like constructing paths!
* @return the display name
*/
virtual String displayName() const;
virtual Common::String displayName() const;
/**
* Return a string representation of the name of the file. This is can be
@ -165,7 +164,7 @@ public:
*
* @return the file name
*/
virtual String name() const;
virtual Common::String name() const;
/**
* Return a string representation of the file which can be passed to fopen(),
@ -178,7 +177,7 @@ public:
*
* @return the 'path' represented by this filesystem node
*/
virtual String path() const;
virtual Common::String path() const;
/**
* Compare the name of this node to the name of another. Directories

2
engines/agi/agi.cpp
View file

@ -347,7 +347,7 @@ int AgiEngine::agiInit() {
/* clear view table */
for (i = 0; i < MAX_VIEWTABLE; i++)
memset(&_game.viewTable[i], 0, sizeof(struct VtEntry));
memset(&_game.viewTable[i], 0, sizeof(VtEntry));
initWords();

2
engines/agi/agi.h
View file

@ -392,7 +392,7 @@ struct AgiGame {
AgiSound sounds[MAX_DIRS]; /**< AGI sound resources */
/* view table */
struct VtEntry viewTable[MAX_VIEWTABLE];
VtEntry viewTable[MAX_VIEWTABLE];
int32 ver; /**< detected game version */

8
engines/agi/checks.cpp
View file

@ -27,7 +27,7 @@
namespace Agi {
int AgiEngine::checkPosition(struct VtEntry *v) {
int AgiEngine::checkPosition(VtEntry *v) {
debugC(4, kDebugLevelSprites, "check position @ %d, %d", v->xPos, v->yPos);
if (v->xPos < 0 ||
@ -52,8 +52,8 @@ int AgiEngine::checkPosition(struct VtEntry *v) {
/**
* Check if there's another object on the way
*/
int AgiEngine::checkCollision(struct VtEntry *v) {
struct VtEntry *u;
int AgiEngine::checkCollision(VtEntry *v) {
VtEntry *u;
if (v->flags & IGNORE_OBJECTS)
return 0;
@ -168,7 +168,7 @@ check_ego:
* rules, otherwise the previous position will be kept.
*/
void AgiEngine::updatePosition() {
struct VtEntry *v;
VtEntry *v;
int x, y, oldX, oldY, border;
_game.vars[vBorderCode] = 0;

2
engines/agi/cycle.cpp
View file

@ -186,7 +186,7 @@ void AgiEngine::oldInputMode() {
/* If main_cycle returns false, don't process more events! */
int AgiEngine::mainCycle() {
unsigned int key, kascii;
struct VtEntry *v = &_game.viewTable[0];
VtEntry *v = &_game.viewTable[0];
_gfx->pollTimer(); /* msdos driver -> does nothing */
updateTimer();

2
engines/agi/keyboard.cpp
View file

@ -99,7 +99,7 @@ int AgiEngine::doPollKeyboard() {
}
int AgiEngine::handleController(int key) {
struct VtEntry *v = &_game.viewTable[0];
VtEntry *v = &_game.viewTable[0];
int i;
/* The Black Cauldron needs KEY_ESCAPE to use menus */

16
engines/agi/motion.cpp
View file

@ -42,7 +42,7 @@ int AgiEngine::checkBlock(int x, int y) {
return true;
}
void AgiEngine::changePos(struct VtEntry *v) {
void AgiEngine::changePos(VtEntry *v) {
int b, x, y;
int dx[9] = { 0, 0, 1, 1, 1, 0, -1, -1, -1 };
int dy[9] = { 0, -1, -1, 0, 1, 1, 1, 0, -1 };
@ -64,7 +64,7 @@ void AgiEngine::changePos(struct VtEntry *v) {
}
}
void AgiEngine::motionWander(struct VtEntry *v) {
void AgiEngine::motionWander(VtEntry *v) {
if (v->parm1--) {
if (~v->flags & DIDNT_MOVE)
return;
@ -80,7 +80,7 @@ void AgiEngine::motionWander(struct VtEntry *v) {
}
}
void AgiEngine::motionFollowEgo(struct VtEntry *v) {
void AgiEngine::motionFollowEgo(VtEntry *v) {
int egoX, egoY;
int objX, objY;
int dir;
@ -142,7 +142,7 @@ void AgiEngine::motionFollowEgo(struct VtEntry *v) {
}
}
void AgiEngine::motionMoveObj(struct VtEntry *v) {
void AgiEngine::motionMoveObj(VtEntry *v) {
v->direction = getDirection(v->xPos, v->yPos, v->parm1, v->parm2, v->stepSize);
/* Update V6 if ego */
@ -153,7 +153,7 @@ void AgiEngine::motionMoveObj(struct VtEntry *v) {
inDestination(v);
}
void AgiEngine::checkMotion(struct VtEntry *v) {
void AgiEngine::checkMotion(VtEntry *v) {
switch (v->motion) {
case MOTION_WANDER:
motionWander(v);
@ -178,7 +178,7 @@ void AgiEngine::checkMotion(struct VtEntry *v) {
*
*/
void AgiEngine::checkAllMotions() {
struct VtEntry *v;
VtEntry *v;
for (v = _game.viewTable; v < &_game.viewTable[MAX_VIEWTABLE]; v++) {
if ((v->flags & (ANIMATED | UPDATE | DRAWN)) == (ANIMATED | UPDATE | DRAWN)
@ -194,7 +194,7 @@ void AgiEngine::checkAllMotions() {
* type motion that * has reached its final destination coordinates.
* @param v Pointer to view table entry
*/
void AgiEngine::inDestination(struct VtEntry *v) {
void AgiEngine::inDestination(VtEntry *v) {
if (v->motion == MOTION_MOVE_OBJ) {
v->stepSize = v->parm3;
setflag(v->parm4, true);
@ -210,7 +210,7 @@ void AgiEngine::inDestination(struct VtEntry *v) {
* after setting the motion mode to MOTION_MOVE_OBJ.
* @param v Pointer to view table entry
*/
void AgiEngine::moveObj(struct VtEntry *v) {
void AgiEngine::moveObj(VtEntry *v) {
motionMoveObj(v);
}

4
engines/agi/op_cmd.cpp
View file

@ -1006,8 +1006,8 @@ cmd(restart_game) {
cmd(distance) {
int16 x1, y1, x2, y2, d;
struct VtEntry *v0 = &game.viewTable[p0];
struct VtEntry *v1 = &game.viewTable[p1];
VtEntry *v0 = &game.viewTable[p0];
VtEntry *v1 = &game.viewTable[p1];
if (v0->flags & DRAWN && v1->flags & DRAWN) {
x1 = v0->xPos + v0->xSize / 2;

8
engines/agi/op_test.cpp
View file

@ -129,7 +129,7 @@ static uint8 testController(uint8 cont) {
}
static uint8 testPosn(uint8 n, uint8 x1, uint8 y1, uint8 x2, uint8 y2) {
struct VtEntry *v = &game.viewTable[n];
VtEntry *v = &game.viewTable[n];
uint8 r;
r = v->xPos >= x1 && v->yPos >= y1 && v->xPos <= x2 && v->yPos <= y2;
@ -140,7 +140,7 @@ static uint8 testPosn(uint8 n, uint8 x1, uint8 y1, uint8 x2, uint8 y2) {
}
static uint8 testObjInBox(uint8 n, uint8 x1, uint8 y1, uint8 x2, uint8 y2) {
struct VtEntry *v = &game.viewTable[n];
VtEntry *v = &game.viewTable[n];
return v->xPos >= x1 &&
v->yPos >= y1 && v->xPos + v->xSize - 1 <= x2 && v->yPos <= y2;
@ -148,7 +148,7 @@ static uint8 testObjInBox(uint8 n, uint8 x1, uint8 y1, uint8 x2, uint8 y2) {
/* if n is in centre of box */
static uint8 testObjCentre(uint8 n, uint8 x1, uint8 y1, uint8 x2, uint8 y2) {
struct VtEntry *v = &game.viewTable[n];
VtEntry *v = &game.viewTable[n];
return v->xPos + v->xSize / 2 >= x1 &&
v->xPos + v->xSize / 2 <= x2 && v->yPos >= y1 && v->yPos <= y2;
@ -156,7 +156,7 @@ static uint8 testObjCentre(uint8 n, uint8 x1, uint8 y1, uint8 x2, uint8 y2) {
/* if nect N is in right corner */
static uint8 testObjRight(uint8 n, uint8 x1, uint8 y1, uint8 x2, uint8 y2) {
struct VtEntry *v = &game.viewTable[n];
VtEntry *v = &game.viewTable[n];
return v->xPos + v->xSize - 1 >= x1 &&
v->xPos + v->xSize - 1 <= x2 && v->yPos >= y1 && v->yPos <= y2;

6
engines/agi/savegame.cpp
View file

@ -352,7 +352,7 @@ int AgiEngine::loadGame(const char *fileName) {
/* game.sounds - loaded above */
for (i = 0; i < vtEntries; i++) {
struct VtEntry *v = &_game.viewTable[i];
VtEntry *v = &_game.viewTable[i];
v->stepTime = in->readByte();
v->stepTimeCount = in->readByte();
@ -398,13 +398,13 @@ int AgiEngine::loadGame(const char *fileName) {
v->parm4 = in->readByte();
}
for (i = vtEntries; i < MAX_VIEWTABLE; i++) {
memset(&_game.viewTable[i], 0, sizeof(struct VtEntry));
memset(&_game.viewTable[i], 0, sizeof(VtEntry));
}
/* Fix some pointers in viewtable */
for (i = 0; i < MAX_VIEWTABLE; i++) {
struct VtEntry *v = &_game.viewTable[i];
VtEntry *v = &_game.viewTable[i];
if (_game.dirView[v->currentView].offset == _EMPTY)
continue;

2
engines/sky/intro.cpp
View file

@ -740,7 +740,7 @@ bool Intro::nextPart(uint16 *&data) {
// probably use _skySound instead of calling playRaw()
// directly, but this will have to do for now.
memset(vData, 127, sizeof(struct dataFileHeader));
_mixer->playRaw(Audio::Mixer::kSFXSoundType, &_voice, vData, _skyDisk->_lastLoadedFileSize, 11025,
_mixer->playRaw(Audio::Mixer::kSpeechSoundType, &_voice, vData, _skyDisk->_lastLoadedFileSize, 11025,
Audio::Mixer::FLAG_AUTOFREE | Audio::Mixer::FLAG_UNSIGNED, SOUND_VOICE);
return true;
case WAITVOICE:

2
engines/sky/sound.cpp
View file

@ -1245,7 +1245,7 @@ bool Sound::startSpeech(uint16 textNum) {
rate = 11025;
_mixer->stopID(SOUND_SPEECH);
_mixer->playRaw(Audio::Mixer::kSFXSoundType, &_ingameSpeech, playBuffer, speechSize, rate, Audio::Mixer::FLAG_UNSIGNED | Audio::Mixer::FLAG_AUTOFREE, SOUND_SPEECH);
_mixer->playRaw(Audio::Mixer::kSpeechSoundType, &_ingameSpeech, playBuffer, speechSize, rate, Audio::Mixer::FLAG_UNSIGNED | Audio::Mixer::FLAG_AUTOFREE, SOUND_SPEECH);
return true;
}

6
engines/sword1/sound.cpp
View file

@ -196,12 +196,12 @@ bool Sound::startSpeech(uint16 roomNo, uint16 localNo) {
uint32 size;
int16 *data = uncompressSpeech(index + _cowHeaderSize, sampleSize, &size);
if (data)
_mixer->playRaw(Audio::Mixer::kSFXSoundType, &_speechHandle, data, size, 11025, SPEECH_FLAGS, SOUND_SPEECH_ID, speechVol, speechPan);
_mixer->playRaw(Audio::Mixer::kSpeechSoundType, &_speechHandle, data, size, 11025, SPEECH_FLAGS, SOUND_SPEECH_ID, speechVol, speechPan);
}
#ifdef USE_MAD
else if (_cowMode == CowMp3) {
_cowFile.seek(index);
_mixer->playInputStream(Audio::Mixer::kSFXSoundType, &_speechHandle, Audio::makeMP3Stream(&_cowFile, sampleSize), SOUND_SPEECH_ID, speechVol, speechPan);
_mixer->playInputStream(Audio::Mixer::kSpeechSoundType, &_speechHandle, Audio::makeMP3Stream(&_cowFile, sampleSize), SOUND_SPEECH_ID, speechVol, speechPan);
// with compressed audio, we can't calculate the wave volume.
// so default to talking.
for (int cnt = 0; cnt < 480; cnt++)
@ -212,7 +212,7 @@ bool Sound::startSpeech(uint16 roomNo, uint16 localNo) {
#ifdef USE_VORBIS
else if (_cowMode == CowVorbis) {
_cowFile.seek(index);
_mixer->playInputStream(Audio::Mixer::kSFXSoundType, &_speechHandle, Audio::makeVorbisStream(&_cowFile, sampleSize), SOUND_SPEECH_ID, speechVol, speechPan);
_mixer->playInputStream(Audio::Mixer::kSpeechSoundType, &_speechHandle, Audio::makeVorbisStream(&_cowFile, sampleSize), SOUND_SPEECH_ID, speechVol, speechPan);
for (int cnt = 0; cnt < 480; cnt++)
_waveVolume[cnt] = true;
_waveVolPos = 0;

2
engines/sword2/animation.cpp
View file

@ -351,7 +351,7 @@ void MoviePlayer::play(int32 leadIn, int32 leadOut) {
}
if (startNextText && !_mixer->isSoundHandleActive(_speechHandle)) {
_mixer->playRaw(Audio::Mixer::kSFXSoundType, &_speechHandle, t->speech, t->speechBufferSize, 22050, flags);
_mixer->playRaw(Audio::Mixer::kSpeechSoundType, &_speechHandle, t->speech, t->speechBufferSize, 22050, flags);
startNextText = false;
}

2
graphics/dxa_player.cpp
View file

@ -287,7 +287,7 @@ void DXAPlayer::decode12(byte *data, int size, int totalSize) {
#endif
}
void DXAPlayer::decode13(uint8 *data, int size, int totalSize) {
void DXAPlayer::decode13(byte *data, int size, int totalSize) {
#ifdef USE_ZLIB
uint8 *codeBuf, *dataBuf, *motBuf, *maskBuf;