changeset 18746:6f51fce90722 draft

(svn r23594) -Codechange: follow coding style with multi line comments
author rubidium <rubidium@openttd.org>
date Mon, 19 Dec 2011 17:40:54 +0000
parents c2cfd98f0c98
children 9e25a152f92d
files src/industrytype.h src/vehicle_base.h
diffstat 2 files changed, 17 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/src/industrytype.h
+++ b/src/industrytype.h
@@ -110,9 +110,12 @@
 	byte check_proc;                      ///< Index to a procedure to check for conflicting circumstances
 	CargoID produced_cargo[2];
 	byte production_rate[2];
-	byte minimal_cargo;                   ///< minimum amount of cargo transported to the stations
-	                                      ///< If the waiting cargo is less than this number, no cargo is moved to it
-	CargoID accepts_cargo[3];             ///< 3 accepted cargoes
+	/**
+	 * minimum amount of cargo transported to the stations.
+	 * If the waiting cargo is less than this number, no cargo is moved to it.
+	 */
+	byte minimal_cargo;
+	CargoID accepts_cargo[3];             ///< 3 accepted cargoes.
 	uint16 input_cargo_multiplier[3][2];  ///< Input cargo multipliers (multiply amount of incoming cargo for the produced cargoes)
 	IndustryLifeType life_type;           ///< This is also known as Industry production flag, in newgrf specs
 	byte climate_availability;            ///< Bitmask, giving landscape enums as bit position
@@ -149,8 +152,11 @@
 	Slope slopes_refused;                 ///< slope pattern on which this tile cannot be built
 	byte anim_production;                 ///< Animation frame to start when goods are produced
 	byte anim_next;                       ///< Next frame in an animation
-	bool anim_state;                      ///< When true, the tile has to be drawn using the animation
-	                                      ///< state instead of the construction state
+	/**
+	 * When true, the tile has to be drawn using the animation
+	 * state instead of the construction state
+	 */
+	bool anim_state;
 	/* Newgrf data */
 	uint8 callback_mask;                  ///< Bitmask of industry tile callbacks that have to be called
 	AnimationInfo animation;              ///< Information about the animation (is it looping, how many loops etc)
--- a/src/vehicle_base.h
+++ b/src/vehicle_base.h
@@ -187,9 +187,12 @@
 	DirectionByte direction;            ///< facing
 
 	OwnerByte owner;                    ///< Which company owns the vehicle?
-	byte spritenum;                     ///< currently displayed sprite index
-	                                    ///< 0xfd == custom sprite, 0xfe == custom second head sprite
-	                                    ///< 0xff == reserved for another custom sprite
+	/**
+	 * currently displayed sprite index
+	 * 0xfd == custom sprite, 0xfe == custom second head sprite
+	 * 0xff == reserved for another custom sprite
+	 */
+	byte spritenum;
 	SpriteID cur_image;                 ///< sprite number for this vehicle
 	byte x_extent;                      ///< x-extent of vehicle bounding box
 	byte y_extent;                      ///< y-extent of vehicle bounding box