mirror of
https://github.com/4jcraft/4jcraft.git
synced 2026-05-30 04:02:54 +00:00
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:
parent
90ed32c63d
commit
35e0ac1d88
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in a new issue