Mercurial > hg > openttd

changeset 17684:2773b630b41f draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r22459) -Doc: Typo fixes and doxygen markup improvements.
author alberth <alberth@openttd.org>
date Sat, 14 May 2011 18:35:40 +0000
parents b1c4622f22d1
children 75712bdb8713
files src/command_type.h src/fileio_func.h src/gfxinit.cpp src/newgrf_airport.cpp src/object_gui.cpp src/rail_gui.cpp src/road_cmd.cpp src/saveload/oldloader_sl.cpp src/tilehighlight_type.h src/town_cmd.cpp src/vehicle_base.h
diffstat 11 files changed, 18 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/src/command_type.h
+++ b/src/command_type.h
@@ -228,7 +228,7 @@
 	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
 
--- a/src/fileio_func.h
+++ b/src/fileio_func.h
@@ -27,7 +27,7 @@
 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.
--- a/src/gfxinit.cpp
+++ b/src/gfxinit.cpp
@@ -224,9 +224,9 @@
  * 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
 {
--- a/src/newgrf_airport.cpp
+++ b/src/newgrf_airport.cpp
@@ -80,7 +80,7 @@
 }
 
 /**
- * This function initialize the airportspec array.
+ * This function initializes the airportspec array.
  */
 void AirportSpec::ResetAirports()
 {
--- a/src/object_gui.cpp
+++ b/src/object_gui.cpp
@@ -45,7 +45,7 @@
 	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)
--- 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 <http://www.gnu.org/licenses/>.
  */
 
-/** @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 @@
 
 	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
--- a/src/road_cmd.cpp
+++ b/src/road_cmd.cpp
@@ -232,7 +232,7 @@
 					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 @@
 				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 @@
 	}
 
 	/* 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 */
--- a/src/saveload/oldloader_sl.cpp
+++ b/src/saveload/oldloader_sl.cpp
@@ -388,7 +388,7 @@
 		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 @@
 	_old_vehicle_names = MallocT<StringID>(_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;
 
--- a/src/tilehighlight_type.h
+++ b/src/tilehighlight_type.h
@@ -24,7 +24,7 @@
 	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.
--- a/src/town_cmd.cpp
+++ b/src/town_cmd.cpp
@@ -2053,7 +2053,7 @@
 {
 	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;
--- a/src/vehicle_base.h
+++ b/src/vehicle_base.h
@@ -129,7 +129,7 @@
 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