Adds documentation to the implemented modules.

This commit is contained in:
2023-04-18 00:11:29 -07:00
parent 9b344b5d6b
commit 891890f779
10 changed files with 191 additions and 74 deletions

View File

@@ -7,10 +7,10 @@ namespace SBF {
using std::ostream;
using std::vector;
ostream& operator<<(ostream& os, const AbilityType& abilityGroup) {
os << "AbilityGroup: {id: " << abilityGroup.id
<< ", singular: \"" << abilityGroup.singular
<< "\", plural: \"" << abilityGroup.plural << "\"}";
ostream& operator<<(ostream& os, const AbilityType& ability) {
os << "AbilityGroup: {id: " << ability.id
<< ", singular: \"" << ability.singular
<< "\", plural: \"" << ability.plural << "\"}";
return os;
}
@@ -31,10 +31,10 @@ namespace SBF {
abilities.push_back(kAbilityGroupKnowledges);
}
void FillAbilitiesForAbilityGroup(vector<string>& abilities, int abilityGroupId) {
void FillAbilitiesForAbilityGroup(vector<string>& abilities, int id) {
abilities.clear();
int numAbilities = GetNumItemsForAbilityGroup(abilityGroupId);
switch (abilityGroupId) {
int numAbilities = GetNumItemsForAbilityGroup(id);
switch (id) {
case kAbilityTalentsId:
for (int talentId = 0; talentId <= numAbilities; talentId++) {
if (talentId >= 0 && talentId <= kTalentsCount) {
@@ -59,9 +59,9 @@ namespace SBF {
}
}
void FillAbilityLabels(vector<string>& labels, int abilityGroupId) {
void FillAbilityLabels(vector<string>& labels, int id) {
labels.clear();
switch (abilityGroupId) {
switch (id) {
case kAbilityTalentsId:
FillTalentLabels(labels);
break;