Fixed doxygen warnings.

This commit is contained in:
johns 2002-03-20 17:51:49 +00:00
parent 267abfd711
commit 8dd8c32fb9
3 changed files with 18 additions and 13 deletions

View file

@ -746,6 +746,7 @@
<LI>Added display of orders after command for 2s.
<LI>Fixed bug: Add to selections with shift and rectangle didn't work.
<LI>Fixed bug: Units have wrong colors, if level is loaded with GUI.
<LI>Fixed many doxygen warnings.
<LI>+++
</UL>
</UL>

View file

@ -10,12 +10,11 @@
//
/**@name sound.c - The sound. */
//
// (c) Copyright 1998-2001 by Lutz Sammer and Fabrice Rossi
// (c) Copyright 1998-2002 by Lutz Sammer and Fabrice Rossi
//
// FreeCraft is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published
// by the Free Software Foundation; either version 2 of the License,
// or (at your option) any later version.
// by the Free Software Foundation; only version 2 of the License.
//
// FreeCraft is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
@ -195,15 +194,14 @@ local SoundId ChooseUnitVoiceSoundId(const Unit *unit,UnitVoiceGroup voice)
** @param unit Sound initiator, unit speaking
** @param voice Type of sound wanted (Ready,Die,Yes,...)
*/
global void PlayUnitSound(const Unit* unit,UnitVoiceGroup unit_voice_group)
global void PlayUnitSound(const Unit* unit,UnitVoiceGroup voice)
{
InsertSoundRequest(unit,
unit->Slot,
ViewPointDistanceToUnit(unit),
ChooseUnitVoiceSoundId(unit,unit_voice_group),
unit_voice_group==VoiceAttacking,
(unit_voice_group==VoiceSelected
||unit_voice_group==VoiceBuilding),
ChooseUnitVoiceSoundId(unit,voice),
voice==VoiceAttacking,
(voice==VoiceSelected ||voice==VoiceBuilding),
0);
}

View file

@ -601,6 +601,7 @@ global int PlayerCheckCosts(const Player* player,const int* costs)
/**
** Check if enough resources for new unit is available.
**
** @param player Pointer to player, which resources are checked.
** @param type Type of unit.
** @return False if all enought, otherwise a bit mask.
*/
@ -628,8 +629,9 @@ global void PlayerAddCosts(Player* player,const int* costs)
}
/**
** Add the costs of an unit to resources
** Add the costs of an unit type to resources
**
** @param player Pointer of player, to which the resources are added.
** @param type Type of unit.
*/
global void PlayerAddUnitType(Player* player,const UnitType* type)
@ -679,6 +681,7 @@ global void PlayerSubCosts(Player* player,const int* costs)
/**
** Substract the costs of new unit from resources
**
** @param player Pointer of player, from which the resources are removed.
** @param type Type of unit.
*/
global void PlayerSubUnitType(Player* player,const UnitType* type)
@ -720,9 +723,11 @@ global int HaveUnitTypeByType(const Player* player,const UnitType* type)
/**
** Have unit of type.
**
** @param player Pointer to player.
** @param type Type of unit.
** @param player Pointer to owning player.
** @param ident Identifier of unit-type that should be lookuped.
** @return How many exists, false otherwise.
**
** @note This function should not be used during run time.
*/
global int HaveUnitTypeByIdent(const Player* player,const char* ident)
{
@ -1035,11 +1040,12 @@ global void DebugPlayers(void)
**
** @param player Player with it
** @param type Problem type
** @param X Map X tile position
** @param Y Map Y tile position
** @param x Map X tile position
** @param y Map Y tile position
** @param fmt Message format
** @param ... Message varargs
**
** @note The parameter type, isn't yet used.
** @todo FIXME: We must also notfiy allied players.
*/
global void NotifyPlayer(const Player* player,