Fixed doxygen warnings.

This commit is contained in:
johns 2002-04-12 14:35:44 +00:00
parent 453ea457f9
commit f511b816a4
4 changed files with 17 additions and 9 deletions

View file

@ -265,7 +265,7 @@ local void FreeTextLines(TextLines** lines)
** @param w width of text area
** @param h height of text area
** @param i scroll index.
** @param text Text to display.
** @param lines Lines of the text to display.
**
** @return 1 if there is more to scroll, 0 if it is done
*/

View file

@ -94,10 +94,11 @@ global GameSound GameSounds
** @param unit Pointer to unit.
** @param id Unit identifier, for pointer reuse detection.
** @param power How loud to play the sound.
** @param sound
** @param fight
** @param selection
** @param volume
** @param sound FIXME: docu
** @param fight FIXME: docu
** @param selection FIXME: docu
** @param volume FIXME: docu
** @param stereo FIXME: docu
*/
local void InsertSoundRequest(const Unit* unit,unsigned id,unsigned char power,
SoundId sound,unsigned char fight,

View file

@ -296,12 +296,14 @@ global void CDRomCheck(void)
** @param sample Input sample
** @param index Position into input sample
** @param volume Volume of the input sample
** @param stereo Stereo (left/right) position of sample
** @param buffer Output buffer
** @param size Size of the output buffer to be filled
**
** @return the number of bytes used to fill buffer
**
** @todo Can mix faster if signed 8 bit buffers are used.
** @todo FIXME: Remove float for stereo!
*/
local int MixSampleToStereo32(Sample* sample,int index,unsigned char volume,
float stereo,int* buffer,int size)

View file

@ -3496,22 +3496,27 @@ global void NetClientUpdateState(void)
-- Menu operation functions
----------------------------------------------------------------------------*/
/**
** Handle keys in menu mode.
**
** @param key Key scancode.
** @param keychar ASCII character code of key.
**
** @return True, if key is handled; otherwise false.
**
** @todo FIXME: Should be MenuKeyDown(), and act on _new_ MenuKeyUp() !!!
** to implement button animation (depress before action)
*/
global int MenuHandleKeyboard(int key, int keychar) // FIXME: Should be MenuKeyDown(), and act on _new_ MenuKeyUp() !!!
{ // to implement button animation (depress before action)
global int MenuHandleKeyboard(int key, int keychar)
{
int i, n;
Menuitem *mi;
Menu *menu = Menus + CurrentMenu;
Menu *menu;
if (CurrentMenu < 0) {
return 0;
}
menu = Menus + CurrentMenu;
if (MenuButtonCurSel != -1 && menu->items[MenuButtonCurSel].mitype == MI_TYPE_INPUT) {
mi = menu->items + MenuButtonCurSel;