From 28092366ec8aaf953b6e8bb92d745ee2c32fad1e Mon Sep 17 00:00:00 2001 From: alberth Date: Sat, 14 May 2011 18:35:40 +0000 Subject: (svn r22459) -Doc: Typo fixes and doxygen markup improvements. --- src/command_type.h | 2 +- src/fileio_func.h | 2 +- src/gfxinit.cpp | 6 +++--- src/newgrf_airport.cpp | 2 +- src/object_gui.cpp | 2 +- src/rail_gui.cpp | 4 ++-- src/road_cmd.cpp | 6 +++--- src/saveload/oldloader_sl.cpp | 6 +++--- src/tilehighlight_type.h | 2 +- src/town_cmd.cpp | 2 +- src/vehicle_base.h | 2 +- 11 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/command_type.h b/src/command_type.h index 5a586fcda..179f3be2b 100644 --- a/src/command_type.h +++ b/src/command_type.h @@ -228,7 +228,7 @@ enum Commands { CMD_EXPAND_TOWN, ///< expand a town CMD_DELETE_TOWN, ///< delete a town - CMD_ORDER_REFIT, ///< change the refit informaction of an order (for "goto depot" ) + CMD_ORDER_REFIT, ///< change the refit information of an order (for "goto depot" ) CMD_CLONE_ORDER, ///< clone (and share) an order CMD_CLEAR_AREA, ///< clear an area diff --git a/src/fileio_func.h b/src/fileio_func.h index db14ccb23..1580fd6cc 100644 --- a/src/fileio_func.h +++ b/src/fileio_func.h @@ -27,7 +27,7 @@ void FioReadBlock(void *ptr, size_t size); void FioSkipBytes(int n); /** - * The searchpaths OpenTTD could search through. + * The search paths OpenTTD could search through. * At least one of the slots has to be filled with a path. * NULL paths tell that there is no such path for the * current operating system. diff --git a/src/gfxinit.cpp b/src/gfxinit.cpp index d25d8ec8c..0a2d82973 100644 --- a/src/gfxinit.cpp +++ b/src/gfxinit.cpp @@ -224,9 +224,9 @@ bool GraphicsSet::FillSetDetails(IniFile *ini, const char *path, const char *ful * Calculate and check the MD5 hash of the supplied filename. * @param subdir The sub directory to get the files from * @return - * CR_MATCH if the MD5 hash matches - * CR_MISMATCH if the MD5 does not match - * CR_NO_FILE if the file misses + * - #CR_MATCH if the MD5 hash matches + * - #CR_MISMATCH if the MD5 does not match + * - #CR_NO_FILE if the file misses */ MD5File::ChecksumResult MD5File::CheckMD5(Subdirectory subdir) const { diff --git a/src/newgrf_airport.cpp b/src/newgrf_airport.cpp index 395b0e3ad..846aa6493 100644 --- a/src/newgrf_airport.cpp +++ b/src/newgrf_airport.cpp @@ -80,7 +80,7 @@ bool AirportSpec::IsAvailable() const } /** - * This function initialize the airportspec array. + * This function initializes the airportspec array. */ void AirportSpec::ResetAirports() { diff --git a/src/object_gui.cpp b/src/object_gui.cpp index b04463d83..e31a82ec5 100644 --- a/src/object_gui.cpp +++ b/src/object_gui.cpp @@ -45,7 +45,7 @@ class BuildObjectWindow : public PickerWindowBase { int line_height; ///< The height of a single line. int object_height; ///< The height of the object box. int info_height; ///< The height of the info box. - Scrollbar *vscroll; ///< The scollbar. + Scrollbar *vscroll; ///< The scrollbar. public: BuildObjectWindow(const WindowDesc *desc, Window *w) : PickerWindowBase(w), info_height(1) diff --git a/src/rail_gui.cpp b/src/rail_gui.cpp index 6a86830a5..9a5af6c5e 100644 --- a/src/rail_gui.cpp +++ b/src/rail_gui.cpp @@ -7,7 +7,7 @@ * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see . */ -/** @file rail_gui.cpp File for dealing with rail construction user interface */ +/** @file rail_gui.cpp %File for dealing with rail construction user interface */ #include "stdafx.h" #include "gui.h" @@ -54,7 +54,7 @@ struct RailStationGUISettings { bool newstations; ///< Are custom station definitions available? StationClassID station_class; ///< Currently selected custom station class (if newstations is \c true ) - byte station_type; ///< Station type within the currently selected custom station class (if newstations is \c true ) + byte station_type; ///< %Station type within the currently selected custom station class (if newstations is \c true ) byte station_count; ///< Number of custom stations (if newstations is \c true ) }; static RailStationGUISettings _railstation; ///< Settings of the station builder GUI diff --git a/src/road_cmd.cpp b/src/road_cmd.cpp index 26fc8eb2c..57e322237 100644 --- a/src/road_cmd.cpp +++ b/src/road_cmd.cpp @@ -232,7 +232,7 @@ static CommandCost RemoveRoad(TileIndex tile, DoCommandFlag flags, RoadBits piec SetTileOwner(other_end, other_owner); } - /* Mark tiles diry that have been repaved */ + /* Mark tiles dirty that have been repaved */ MarkTileDirtyByTile(tile); MarkTileDirtyByTile(other_end); if (IsBridge(tile)) { @@ -690,7 +690,7 @@ do_clear:; SetRoadOwner(other_end, rt, _current_company); SetRoadOwner(tile, rt, _current_company); - /* Mark tiles diry that have been repaved */ + /* Mark tiles dirty that have been repaved */ MarkTileDirtyByTile(other_end); MarkTileDirtyByTile(tile); if (IsBridge(tile)) { @@ -763,7 +763,7 @@ CommandCost CmdBuildLongRoad(TileIndex start_tile, DoCommandFlag flags, uint32 p } /* On the X-axis, we have to swap the initial bits, so they - * will be interpreted correctly in the GTTS. Futhermore + * will be interpreted correctly in the GTTS. Furthermore * when you just 'click' on one tile to build them. */ if ((axis == AXIS_Y) == (start_tile == end_tile && HasBit(p2, 0) == HasBit(p2, 1))) drd ^= DRD_BOTH; /* No disallowed direction bits have to be toggled */ diff --git a/src/saveload/oldloader_sl.cpp b/src/saveload/oldloader_sl.cpp index 362df6b63..6432fd20e 100644 --- a/src/saveload/oldloader_sl.cpp +++ b/src/saveload/oldloader_sl.cpp @@ -388,7 +388,7 @@ static bool FixTTOEngines() v->engine_type = tto_to_ttd[v->engine_type]; } - /* Load the default engine set. Many of them will be overriden later */ + /* Load the default engine set. Many of them will be overridden later */ uint j = 0; for (uint i = 0; i < lengthof(_orig_rail_vehicle_info); i++, j++) new (GetTempDataEngine(j)) Engine(VEH_TRAIN, i); for (uint i = 0; i < lengthof(_orig_road_vehicle_info); i++, j++) new (GetTempDataEngine(j)) Engine(VEH_ROAD, i); @@ -517,9 +517,9 @@ static void ReadTTDPatchFlags() _old_vehicle_names = MallocT(_old_vehicle_multiplier * 850); /* TTDPatch increases the Vehicle-part in the middle of the game, - * so if the multipler is anything else but 1, the assert fails.. + * so if the multiplier is anything else but 1, the assert fails.. * bump the assert value so it doesn't! - * (1 multipler == 850 vehicles + * (1 multiplier == 850 vehicles * 1 vehicle == 128 bytes */ _bump_assert_value = (_old_vehicle_multiplier - 1) * 850 * 128; diff --git a/src/tilehighlight_type.h b/src/tilehighlight_type.h index a37b97d97..afe38ace6 100644 --- a/src/tilehighlight_type.h +++ b/src/tilehighlight_type.h @@ -24,7 +24,7 @@ enum HighLightStyle { HT_POINT = 0x020, ///< point (lower land, raise land, level land, ...) HT_SPECIAL = 0x030, ///< special mode used for highlighting while dragging (and for tunnels/docks) HT_DRAG = 0x040, ///< dragging items in the depot windows - HT_LINE = 0x008, ///< used for autorail highlighting (longer streches), lower bits: direction + HT_LINE = 0x008, ///< used for autorail highlighting (longer stretches), lower bits: direction HT_RAIL = 0x080, ///< autorail (one piece), lower bits: direction HT_VEHICLE = 0x100, ///< vehicle is accepted as target as well (bitmask) HT_DIAGONAL = 0x200, ///< Also allow 'diagonal rectangles'. Only usable in combination with #HT_RECT or #HT_POINT. diff --git a/src/town_cmd.cpp b/src/town_cmd.cpp index 25f59d174..ddf86e1f7 100644 --- a/src/town_cmd.cpp +++ b/src/town_cmd.cpp @@ -2053,7 +2053,7 @@ static bool CheckTownBuild2x2House(TileIndex *tile, Town *t, uint maxz, bool nos { TileIndex tile2 = *tile; - for (DiagDirection d = DIAGDIR_SE;;d++) { // 'd' goes through DIAGDIR_SE, DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_END + for (DiagDirection d = DIAGDIR_SE;; d++) { // 'd' goes through DIAGDIR_SE, DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_END if (TownLayoutAllows2x2HouseHere(t, tile2) && CheckFree2x2Area(tile2, t->index, maxz, noslope)) { *tile = tile2; return true; diff --git a/src/vehicle_base.h b/src/vehicle_base.h index a673bcfd1..b546ac397 100644 --- a/src/vehicle_base.h +++ b/src/vehicle_base.h @@ -129,7 +129,7 @@ private: public: friend const SaveLoad *GetVehicleDescription(VehicleType vt); ///< So we can use private/protected variables in the saveload code friend void FixOldVehicles(); - friend void AfterLoadVehicles(bool part_of_load); ///< So we can set the previous and first pointers while loading + friend void AfterLoadVehicles(bool part_of_load); ///< So we can set the #previous and #first pointers while loading friend bool LoadOldVehicle(LoadgameState *ls, int num); ///< So we can set the proper next pointer while loading char *name; ///< Name of vehicle -- cgit v1.2.3-54-g00ecf