jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-09-29 09:22:18 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docstrings

Browse source
This commit is contained in:
DawnFire42 2026-06-29 11:42:18 -04:00
parent 1c7516a3cc
commit a247f407dd
No known key found for this signature in database
GPG key ID: 24BB855EE2911B33
2 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
libcockatrice_utility/libcockatrice/utility/dice_limits.h
View file

@ -3,9 +3,13 @@
#include <QtGlobal> // for uint #include <QtGlobal> // for uint
/** @brief Fewest sides a rollable die may have. */
constexpr uint MINIMUM_DIE_SIDES = 2; constexpr uint MINIMUM_DIE_SIDES = 2;
/** @brief Most sides a rollable die may have. */
constexpr uint MAXIMUM_DIE_SIDES = 1000000; constexpr uint MAXIMUM_DIE_SIDES = 1000000;
/** @brief Fewest dice that may be rolled at once. */
constexpr uint MINIMUM_DICE_TO_ROLL = 1; constexpr uint MINIMUM_DICE_TO_ROLL = 1;
/** @brief Most dice that may be rolled at once. */
constexpr uint MAXIMUM_DICE_TO_ROLL = 100; constexpr uint MAXIMUM_DICE_TO_ROLL = 100;
#endif // DICE_LIMITS_H #endif // DICE_LIMITS_H

12
libcockatrice_utility/libcockatrice/utility/string_limits.h
View file

@ -5,22 +5,24 @@
#include <algorithm> #include <algorithm>
#include <string> #include <string>
// max size for short strings, like names and things that are generally a single phrase /** @brief Max size for short strings, like names and things that are generally a single phrase. */
constexpr int MAX_NAME_LENGTH = 0xff; constexpr int MAX_NAME_LENGTH = 0xff;
// max size for chat messages and text contents /** @brief Max size for chat messages and text contents. */
constexpr int MAX_TEXT_LENGTH = 0xfff; constexpr int MAX_TEXT_LENGTH = 0xfff;
// max size for deck files and pictures /** @brief Max size for deck files and pictures (about 2 megabytes). */
constexpr int MAX_FILE_LENGTH = 0x1fffff; // about 2 megabytes constexpr int MAX_FILE_LENGTH = 0x1fffff;
// optimized functions to get qstrings that are at most that long /** @brief Returns a QString from a std::string, truncated to at most MAX_NAME_LENGTH bytes. */
inline QString nameFromStdString(const std::string &_string) inline QString nameFromStdString(const std::string &_string)
{ {
return QString::fromUtf8(_string.data(), std::min(int(_string.size()), MAX_NAME_LENGTH)); return QString::fromUtf8(_string.data(), std::min(int(_string.size()), MAX_NAME_LENGTH));
} }
/** @brief Returns a QString from a std::string, truncated to at most MAX_TEXT_LENGTH bytes. */
inline QString textFromStdString(const std::string &_string) inline QString textFromStdString(const std::string &_string)
{ {
return QString::fromUtf8(_string.data(), std::min(int(_string.size()), MAX_TEXT_LENGTH)); return QString::fromUtf8(_string.data(), std::min(int(_string.size()), MAX_TEXT_LENGTH));
} }
/** @brief Returns a QString from a std::string, truncated to at most MAX_FILE_LENGTH bytes. */
inline QString fileFromStdString(const std::string &_string) inline QString fileFromStdString(const std::string &_string)
{ {
return QString::fromUtf8(_string.data(), std::min(int(_string.size()), MAX_FILE_LENGTH)); return QString::fromUtf8(_string.data(), std::min(int(_string.size()), MAX_FILE_LENGTH));