Document some generic argument names

This commit is contained in:
GriffinR
2022-05-21 15:21:50 -04:00
parent ef4d99c87e
commit 5e6d8a77e4
35 changed files with 445 additions and 359 deletions
+24 -23
View File
@@ -153,7 +153,7 @@ void DoYesNoFuncWithChoice(u8 taskId, const struct YesNoFuncTable *data)
gTasks[taskId].func = Task_CallYesOrNoCallback;
}
void CreateYesNoMenuWithCallbacks(u8 taskId, const struct WindowTemplate *template, u8 arg2, u8 arg3, u8 arg4, u16 tileStart, u8 palette, const struct YesNoFuncTable *yesNo)
void CreateYesNoMenuWithCallbacks(u8 taskId, const struct WindowTemplate *template, u8 unused1, u8 unused2, u8 unused3, u16 tileStart, u8 palette, const struct YesNoFuncTable *yesNo)
{
CreateYesNoMenu(template, tileStart, palette, 0);
sYesNo = *yesNo;
@@ -176,17 +176,18 @@ static void Task_CallYesOrNoCallback(u8 taskId)
}
}
bool8 AdjustQuantityAccordingToDPadInput(s16 *arg0, u16 arg1)
// Returns TRUE if the quantity was changed, FALSE if it remained the same
bool8 AdjustQuantityAccordingToDPadInput(s16 *quantity, u16 max)
{
s16 valBefore = (*arg0);
s16 valBefore = *quantity;
if ((JOY_REPEAT(DPAD_ANY)) == DPAD_UP)
if (JOY_REPEAT(DPAD_ANY) == DPAD_UP)
{
(*arg0)++;
if ((*arg0) > arg1)
(*arg0) = 1;
(*quantity)++;
if (*quantity > max)
*quantity = 1;
if ((*arg0) == valBefore)
if (*quantity == valBefore)
{
return FALSE;
}
@@ -196,13 +197,13 @@ bool8 AdjustQuantityAccordingToDPadInput(s16 *arg0, u16 arg1)
return TRUE;
}
}
else if ((JOY_REPEAT(DPAD_ANY)) == DPAD_DOWN)
else if (JOY_REPEAT(DPAD_ANY) == DPAD_DOWN)
{
(*arg0)--;
if ((*arg0) <= 0)
(*arg0) = arg1;
(*quantity)--;
if (*quantity <= 0)
*quantity = max;
if ((*arg0) == valBefore)
if (*quantity == valBefore)
{
return FALSE;
}
@@ -212,13 +213,13 @@ bool8 AdjustQuantityAccordingToDPadInput(s16 *arg0, u16 arg1)
return TRUE;
}
}
else if ((JOY_REPEAT(DPAD_ANY)) == DPAD_RIGHT)
else if (JOY_REPEAT(DPAD_ANY) == DPAD_RIGHT)
{
(*arg0) += 10;
if ((*arg0) > arg1)
(*arg0) = arg1;
*quantity += 10;
if (*quantity > max)
*quantity = max;
if ((*arg0) == valBefore)
if (*quantity == valBefore)
{
return FALSE;
}
@@ -228,13 +229,13 @@ bool8 AdjustQuantityAccordingToDPadInput(s16 *arg0, u16 arg1)
return TRUE;
}
}
else if ((JOY_REPEAT(DPAD_ANY)) == DPAD_LEFT)
else if (JOY_REPEAT(DPAD_ANY) == DPAD_LEFT)
{
(*arg0) -= 10;
if ((*arg0) <= 0)
(*arg0) = 1;
*quantity -= 10;
if (*quantity <= 0)
*quantity = 1;
if ((*arg0) == valBefore)
if (*quantity == valBefore)
{
return FALSE;
}