mirror of
https://github.com/OpenTTD/OpenTTD.git
synced 2026-07-21 01:59:44 +00:00
Codechange: Make documentation comments for some enums and their members recognised by doxygen.
This commit is contained in:
committed by
rubidium42
parent
5943382cf5
commit
3c8d7df657
+1
-1
@@ -192,7 +192,7 @@ void BuildGuiGroupList(GUIGroupList &list, bool fold, Owner owner, VehicleType v
|
||||
}
|
||||
}
|
||||
|
||||
/* Columns in the group list */
|
||||
/** Columns in the group list. */
|
||||
enum VehicleGroupColumns : uint8_t {
|
||||
VGC_FOLD, ///< Fold / Unfold button.
|
||||
VGC_NAME, ///< Group name.
|
||||
|
||||
+2
-2
@@ -19,9 +19,9 @@ struct HouseSpec;
|
||||
|
||||
/** Randomisation triggers for houses */
|
||||
enum class HouseRandomTrigger : uint8_t {
|
||||
/* The tile of the house has been triggered during the tileloop. */
|
||||
/** The tile of the house has been triggered during the tileloop. */
|
||||
TileLoop,
|
||||
/*
|
||||
/**
|
||||
* The top tile of a (multitile) building has been triggered during and all
|
||||
* the tileloop other tiles of the same building get the same random value.
|
||||
*/
|
||||
|
||||
@@ -92,7 +92,7 @@ static int MapOldSubType(const Vehicle *v)
|
||||
}
|
||||
|
||||
|
||||
/* TTDP style aircraft movement states for GRF Action 2 Var 0xE2 */
|
||||
/** TTDP style aircraft movement states for GRF Action 2 Var 0xE2. */
|
||||
enum TTDPAircraftMovementStates : uint8_t {
|
||||
AMS_TTDP_HANGAR,
|
||||
AMS_TTDP_TO_HANGAR,
|
||||
@@ -230,7 +230,7 @@ static uint8_t MapAircraftMovementState(const Aircraft *v)
|
||||
}
|
||||
|
||||
|
||||
/* TTDP style aircraft movement action for GRF Action 2 Var 0xE6 */
|
||||
/** TTDP style aircraft movement action for GRF Action 2 Var 0xE6. */
|
||||
enum TTDPAircraftMovementActions : uint8_t {
|
||||
AMA_TTDP_IN_HANGAR,
|
||||
AMA_TTDP_ON_PAD1,
|
||||
|
||||
@@ -101,7 +101,7 @@ protected:
|
||||
ResolverResult Resolve(ResolverObject &object) const override;
|
||||
};
|
||||
|
||||
/* Shared by deterministic and random groups. */
|
||||
/** Shared by deterministic and random groups. */
|
||||
enum VarSpriteGroupScope : uint8_t {
|
||||
VSG_BEGIN,
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
#include "../../core/enum_type.hpp"
|
||||
#include "../../misc/dbg_helpers.h"
|
||||
|
||||
/* Enum used in PfCalcCost() to see why was the segment closed. */
|
||||
/** Enum used in PfCalcCost() to see why was the segment closed. */
|
||||
enum class EndSegmentReason : uint8_t {
|
||||
/* The following reasons can be saved into cached segment */
|
||||
DeadEnd, ///< track ends here
|
||||
|
||||
@@ -34,7 +34,7 @@ struct LoadgameState {
|
||||
std::vector<StringID> vehicle_names;
|
||||
};
|
||||
|
||||
/* OldChunk-Type */
|
||||
/** OldChunk-Type. */
|
||||
enum OldChunkType : uint32_t {
|
||||
OC_SIMPLE = 0,
|
||||
OC_NULL = 1,
|
||||
|
||||
+1
-3
@@ -25,9 +25,7 @@ extern StoryPagePool _story_page_pool;
|
||||
extern uint32_t _story_page_element_next_sort_value;
|
||||
extern uint32_t _story_page_next_sort_value;
|
||||
|
||||
/*
|
||||
* Each story page element is one of these types.
|
||||
*/
|
||||
/** Each story page element is one of these types. */
|
||||
enum StoryPageElementType : uint8_t {
|
||||
SPET_TEXT = 0, ///< A text element.
|
||||
SPET_LOCATION, ///< An element that references a tile along with a one-line text.
|
||||
|
||||
+10
-8
@@ -1695,7 +1695,7 @@ static const std::string_view _name_czech_real[] = {
|
||||
* Feel free to ask me about anything unclear or if you need help
|
||||
* with cloning this for your own language. */
|
||||
|
||||
/* Sing., pl. */
|
||||
/** Sing., pl. */
|
||||
enum CzechGender : uint8_t {
|
||||
CZG_SMASC,
|
||||
CZG_SFEM,
|
||||
@@ -1703,9 +1703,9 @@ enum CzechGender : uint8_t {
|
||||
CZG_PMASC,
|
||||
CZG_PFEM,
|
||||
CZG_PNEUT,
|
||||
/* Special for substantive stems - the ending chooses the gender. */
|
||||
/** Special for substantive stems - the ending chooses the gender. */
|
||||
CZG_FREE,
|
||||
/* Like CZG_FREE, but disallow CZG_SNEUT. */
|
||||
/** Like CZG_FREE, but disallow CZG_SNEUT. */
|
||||
CZG_NFREE
|
||||
};
|
||||
|
||||
@@ -1725,8 +1725,10 @@ static const std::string_view _name_czech_patmod[][3] = {
|
||||
/* CZG_PNEUT */ { "\u00ed", "\u00e1", "ova" }
|
||||
};
|
||||
|
||||
/* This way the substantive can choose only some adjectives/endings:
|
||||
* At least one of these flags must be satisfied: */
|
||||
/**
|
||||
* This way the substantive can choose only some adjectives/endings:
|
||||
* At least one of these flags must be satisfied:
|
||||
*/
|
||||
enum class CzechAllowFlag : uint8_t {
|
||||
Short,
|
||||
Middle,
|
||||
@@ -1737,11 +1739,11 @@ using CzechAllowFlags = EnumBitSet<CzechAllowFlag, uint8_t>;
|
||||
|
||||
static constexpr CzechAllowFlags CZA_ALL = {CzechAllowFlag::Short, CzechAllowFlag::Middle, CzechAllowFlag::Long};
|
||||
|
||||
/* All these flags must be satisfied (in the stem->others direction): */
|
||||
/** All these flags must be satisfied (in the stem->others direction): */
|
||||
enum class CzechChooseFlag : uint8_t {
|
||||
Colour,
|
||||
Postfix, // Matched if postfix was inserted.
|
||||
NoPostfix, // Matched if no postfix was inserted.
|
||||
Postfix, ///< Matched if postfix was inserted.
|
||||
NoPostfix, ///< Matched if no postfix was inserted.
|
||||
};
|
||||
|
||||
using CzechChooseFlags = EnumBitSet<CzechChooseFlag, uint8_t>;
|
||||
|
||||
+1
-1
@@ -18,7 +18,7 @@ enum TextfileType : uint8_t {
|
||||
TFT_CHANGELOG, ///< Content changelog
|
||||
TFT_LICENSE, ///< Content license
|
||||
|
||||
TFT_CONTENT_END, // This marker is used to generate the above three buttons in sequence by various of places in the code.
|
||||
TFT_CONTENT_END, ///< This marker is used to generate the above three buttons in sequence by various of places in the code.
|
||||
|
||||
TFT_SURVEY_RESULT = TFT_CONTENT_END, ///< Survey result (preview)
|
||||
TFT_GAME_MANUAL, ///< Game manual/documentation file
|
||||
|
||||
+1
-1
@@ -1481,7 +1481,7 @@ static inline bool TownAllowedToBuildRoads(TownExpandModes modes)
|
||||
return modes.Test(TownExpandMode::Roads);
|
||||
}
|
||||
|
||||
/* The possible states of town growth. */
|
||||
/** The possible states of town growth. */
|
||||
enum class TownGrowthResult {
|
||||
Succeed, ///< The town has grown.
|
||||
SearchStopped, ///< There is a reason not to try growing the town now.
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
class VideoDriver_Cocoa;
|
||||
|
||||
/* Right Mouse Button Emulation enum */
|
||||
/** Right Mouse Button Emulation enum. */
|
||||
enum RightMouseButtonEmulationState {
|
||||
RMBE_COMMAND = 0,
|
||||
RMBE_CONTROL = 1,
|
||||
|
||||
@@ -55,9 +55,9 @@ enum StationListWidgets : WidgetID {
|
||||
|
||||
/** Widgets of the #SelectStationWindow class. */
|
||||
enum JoinStationWidgets : WidgetID {
|
||||
WID_JS_CAPTION, // Caption of the window.
|
||||
WID_JS_PANEL, // Main panel.
|
||||
WID_JS_SCROLLBAR, // Scrollbar of the panel.
|
||||
WID_JS_CAPTION, ///< Caption of the window.
|
||||
WID_JS_PANEL, ///< Main panel.
|
||||
WID_JS_SCROLLBAR, ///< Scrollbar of the panel.
|
||||
};
|
||||
|
||||
#endif /* WIDGETS_STATION_WIDGET_H */
|
||||
|
||||
+1
-1
@@ -726,7 +726,7 @@ enum WindowClass : uint16_t {
|
||||
*/
|
||||
WC_SCREENSHOT,
|
||||
|
||||
/*
|
||||
/**
|
||||
* Help and manuals window; %Window numbers:
|
||||
* - 0 = #HelpWindowWidgets
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user