mirrors/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD synced 2026-01-18 18:02:37 +01:00
Code Issues Releases Wiki Activity

Codefix: some incorrect doxygen comments (#15019)

Browse Source
This commit is contained in:
Loïc Guilloux
2026-01-02 22:53:34 +01:00
committed by GitHub
parent fdf75775d9
commit 7d32bf24d5
5 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/bridge_type.h
View File

@@ -43,10 +43,10 @@ enum class BridgePillarFlag : uint8_t {
CornerE = 2, ///< East corner is obstructed.
CornerN = 3, ///< North corner is obstructed.
/* Edges are in the same order as DiagDirection enum. */
EdgeNE = 4, //< Northeast edge is obstructed.
EdgeSE = 5, //< Southeast edge is obstructed.
EdgeSW = 6, //< Southwest edge is obstructed.
EdgeNW = 7, //< Northwest edge is obstructed.
EdgeNE = 4, ///< Northeast edge is obstructed.
EdgeSE = 5, ///< Southeast edge is obstructed.
EdgeSW = 6, ///< Southwest edge is obstructed.
EdgeNW = 7, ///< Northwest edge is obstructed.
};
using BridgePillarFlags = EnumBitSet<BridgePillarFlag, uint8_t>;

2
src/gamelog_internal.h
View File

@@ -56,7 +56,7 @@ struct LoggedChangeRevision : LoggedChange {
std::string text{}; ///< revision string, _openttd_revision
uint32_t newgrf = 0; ///< _openttd_newgrf_version
uint16_t slver = 0; ///< _sl_version
uint8_t modified = 0; //< _openttd_revision_modified
uint8_t modified = 0; ///< _openttd_revision_modified
};
struct LoggedChangeOldVersion : LoggedChange {

2
src/script/api/script_types.hpp
View File

@@ -124,7 +124,7 @@
/* Define all types here, so they are added to the API docs. */
using BridgeType = uint32_t; ///< The ID of a bridge type.
using CargoType = uint8_t; ///< The ID of a cargo type.
using ClientID = uint32_t; //< The ID of a (network) client.
using ClientID = uint32_t; ///< The ID of a (network) client.
using CompanyID = uint8_t; ///< The ID of a company.
using EngineID = uint16_t; ///< The ID of an engine.
using GoalID = uint16_t; ///< The ID of a goal.

2
src/string.cpp
View File

@@ -753,7 +753,7 @@ public:
class DefaultStringIterator : public StringIterator
{
Utf8View string; ///< Current string.
Utf8View::iterator cur_pos; //< Current iteration position.
Utf8View::iterator cur_pos; ///< Current iteration position.
public:
void SetString(std::string_view s) override

8
src/tgp.cpp
View File

@@ -159,12 +159,12 @@ static const int AMPLITUDE_DECIMAL_BITS = 10;
/** Height map - allocated array of heights (Map::SizeX() + 1) * (Map::SizeY() + 1) */
struct HeightMap
{
std::vector<Height> h; //< array of heights
std::vector<Height> h; ///< array of heights
/* Even though the sizes are always positive, there are many cases where
* X and Y need to be signed integers due to subtractions. */
int dim_x; //< height map size_x Map::SizeX() + 1
int size_x; //< Map::SizeX()
int size_y; //< Map::SizeY()
int dim_x; ///< height map size_x Map::SizeX() + 1
int size_x; ///< Map::SizeX()
int size_y; ///< Map::SizeY()
/**
* Height map accessor