1
0
Fork 0

Cleanup: Adjustments to comments to match code changes (#13636)

pull/13641/head
Jonathan G Rennison 2025-02-22 13:28:35 +00:00 committed by GitHub
parent 2b80812922
commit 8566030c53
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 11 additions and 8 deletions

View File

@ -116,11 +116,11 @@ namespace StrongType {
* Templated helper to make a type-safe 'typedef' representing a single POD value.
* A normal 'typedef' is not distinct from its base type and will be treated as
* identical in many contexts. This class provides a distinct type that can still
* be assign from and compared to values of its base type.
* be assigned from and compared to values of its base type.
*
* Example usage:
*
* using MyType = StrongType::Typedef<int, struct MyTypeTag, StrongType::Explicit, StrongType::Compare, StrongType::Integer>;
* using MyType = StrongType::Typedef<int, struct MyTypeTag, StrongType::Compare, StrongType::Integer>;
*
* @tparam TBaseType Type of the derived class (i.e. the concrete usage of this class).
* @tparam TTag An unique struct to keep types of the same TBaseType distinct.

View File

@ -172,7 +172,7 @@ public:
/**
* Drop down indent component.
* @tparam TBase Base component.
* @tparam TEnd Position checkmark at end if true, or start if false.
* @tparam TEnd Position indent at end if true, or start if false.
*/
template <class TBase, bool TEnd = false>
class DropDownIndent : public TBase {

View File

@ -556,7 +556,7 @@ static StringID TTDPStringIDToOTTDStringIDMapping(GRFStringID str)
* Used when setting an object's property to map to the GRF's strings
* while taking in consideration the "drift" between TTDPatch string system and OpenTTD's one
* @param grfid Id of the grf file.
* @param str StringID that we want to have the equivalent in OoenTTD.
* @param str GRF-local GRFStringID that we want to have the equivalent in OpenTTD.
* @return The properly adjusted StringID.
*/
StringID MapGRFStringID(uint32_t grfid, GRFStringID str)
@ -4632,6 +4632,7 @@ static ChangeInfoResult RailTypeReserveInfo(uint first, uint last, int prop, Byt
* @param last Local ID of the last roadtype.
* @param prop The property to change.
* @param buf The property value.
* @param rtt Road/tram type.
* @return ChangeInfoResult.
*/
static ChangeInfoResult RoadTypeChangeInfo(uint first, uint last, int prop, ByteReader &buf, RoadTramType rtt)

View File

@ -1311,7 +1311,6 @@ static void ViewportAddLandscape()
/**
* Add a string to draw in the current viewport.
* @param dpi current viewport area
* @param small_from Zoomlevel from when the small font should be used
* @param sign sign position and dimension
* @param flags ViewportStringFlags to control the string's appearance.
* @param colour colour of the sign background; or INVALID_COLOUR if transparent
@ -1376,7 +1375,7 @@ static void ViewportAddTownStrings(DrawPixelInfo *dpi, const std::vector<const T
/**
* Add sign strings to a viewport.
* @param dpi Current viewport area.
* @param towns List of signs to add.
* @param signs List of signs to add.
* @param small Add small versions of strings.
*/
static void ViewportAddSignStrings(DrawPixelInfo *dpi, const std::vector<const Sign *> &signs, bool small)
@ -1400,7 +1399,7 @@ static void ViewportAddSignStrings(DrawPixelInfo *dpi, const std::vector<const S
/**
* Add station strings to a viewport.
* @param dpi Current viewport area.
* @param towns List of stations to add.
* @param stations List of stations to add.
* @param small Add small versions of strings.
*/
static void ViewportAddStationStrings(DrawPixelInfo *dpi, const std::vector<const BaseStation *> &stations, bool small)
@ -1963,6 +1962,7 @@ static void ClampSmoothScroll(uint32_t delta_ms, int64_t delta_hi, int64_t delta
/**
* Update the viewport position being displayed.
* @param w %Window owning the viewport.
* @param delta_ms Milliseconds since the last update.
*/
void UpdateViewportPosition(Window *w, uint32_t delta_ms)
{

View File

@ -959,7 +959,9 @@ inline uint ComputeMaxSize(uint base, uint max_space, uint step)
* Next, specify its properties with one or more of
* - #SetMinimalSize Define the minimal size of the widget.
* - #SetFill Define how the widget may grow to make it nicely.
* - #SetDataTip Define the data and the tooltip of the widget.
* - #SetStringTip Define the string and the tooltip of the widget.
* - #SetSpriteTip Define the sprite ID and the tooltip of the widget.
* - #SetToolTip Define the tooltip of the widget.
* - #SetResize Define how the widget may resize.
* - #SetPadding Create additional space around the widget.
*