dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r20283) -Codechange: Unify start of doygen comments.

Browse Source
This commit is contained in:
frosch
2010-08-01 19:22:34 +00:00
parent 4871baf44d
commit ed4f806f1d
162 changed files with 1304 additions and 652 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/smallmap_gui.cpp
View File

@@ -63,7 +63,8 @@ static int _smallmap_industry_count; ///< Number of used industries
/** Macro for end of list marker in arrays of LegendAndColour */
#define MKEND() {0, STR_NULL, {INVALID_INDUSTRYTYPE}, true, true, false}
/** Macro for break marker in arrays of LegendAndColour.
/**
* Macro for break marker in arrays of LegendAndColour.
* It will have valid data, though */
#define MS(a, b) {a, b, {INVALID_INDUSTRYTYPE}, true, false, true}
@@ -149,7 +150,8 @@ static const LegendAndColour _legend_land_owners[] = {
#undef MS
#undef MKEND
/** Allow room for all industries, plus a terminator entry
/**
* Allow room for all industries, plus a terminator entry
* This is required in order to have the indutry slots all filled up */
static LegendAndColour _legend_from_industries[NUM_INDUSTRYTYPES + 1];
/* For connecting industry type to position in industries list(small map legend) */
@@ -631,7 +633,8 @@ class SmallMapWindow : public Window {
return scroll;
}
/** Initialize or change the zoom level.
/**
* Initialize or change the zoom level.
* @param change Way to change the zoom level.
* @param zoom_pt Position to keep fixed while zooming.
* @pre \c *zoom_pt should contain a point in the smallmap display when zooming in or out.
@@ -983,7 +986,8 @@ public:
this->SmallMapCenterOnCurrentPos();
}
/** Compute maximal required height of the legends.
/**
* Compute maximal required height of the legends.
* @return Maximally needed height for displaying the smallmap legends in pixels.
*/
inline uint GetMaxLegendHeight() const
@@ -992,7 +996,8 @@ public:
return WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + num_rows * FONT_HEIGHT_SMALL;
}
/** Compute minimal required width of the legends.
/**
* Compute minimal required width of the legends.
* @return Minimally needed width for displaying the smallmap legends in pixels.
*/
inline uint GetMinLegendWidth() const
@@ -1000,7 +1005,8 @@ public:
return WD_FRAMERECT_LEFT + this->min_number_of_columns * this->column_width;
}
/** Return number of columns that can be displayed in \a width pixels.
/**
* Return number of columns that can be displayed in \a width pixels.
* @return Number of columns to display.
*/
inline uint GetNumberColumnsLegend(uint width) const
@@ -1008,7 +1014,8 @@ public:
return width / this->column_width;
}
/** Compute height given a width.
/**
* Compute height given a width.
* @return Needed height for displaying the smallmap legends in pixels.
*/
uint GetLegendHeight(uint width) const