Added additional documentation to Achievement.cpp

Clang formatter was throwing a fit so hopefully changing a cpp file will fix it
This commit is contained in:
Liriosha 2026-03-15 01:10:51 -04:00
parent 90ed32c63d
commit 35e0ac1d88
No known key found for this signature in database
GPG key ID: 1A9AA2EFDA5F83E9

View file

@ -5,6 +5,17 @@
#include "../Util/DescFormatter.h"
#include "Achievement.h"
/**
* @class Achievement
* @brief Represents a Minecraft achievement.
*
* Achievements are stat objects that can be unlocked by the player.
* Each achievement has a position in the achievement tree
* a description and an optional icon and prerequisite.
*
* Use postConstruct() to register the achievement globally.
*/
/**
* @brief Performs internal initialization for the achievement.
*
@ -65,17 +76,18 @@ Achievement::Achievement(int id, const std::wstring& name, int x, int y,
y(y),
requires(requires) {}
/**
* @brief Sets the decription formatter (DescFormatter)
* @param descFormatter Pointer to the DescFormatter formatting the description text.
* @return self
**/
Achievement* Achievement::setDescFormatter(DescFormatter* descFormatter) {
/**
* @brief Sets the decription formatter (DescFormatter)
* @param descFormatter Pointer to the DescFormatter formatting the
* description text.
* @return self
**/
Achievement
* Achievement::setDescFormatter(DescFormatter * descFormatter) {
this->descFormatter = descFormatter;
return this;
}
/**
* @brief Returns whether the Achivement is golden
* @return boolean