(svn r19909) -Doc: Typo fixes, small doxygen improvements.

This commit is contained in:
alberth 2010-05-30 13:05:36 +00:00
parent d0a999bd5b
commit 29fd6ce0e4
5 changed files with 18 additions and 18 deletions

View File

@ -30,7 +30,7 @@ class SmallVector {
protected:
T *data; ///< The pointer to the first item
uint items; ///< The number of items stored
uint capacity; ///< The avalible space for storing items
uint capacity; ///< The available space for storing items
public:
SmallVector() : data(NULL), items(0), capacity(0) { }
@ -93,7 +93,7 @@ public:
}
/**
* Search for the first occurence of an item.
* Search for the first occurrence of an item.
* The '!=' operator of T is used for comparison.
* @param item Item to search for
* @return The position of the item, or End() when not present
@ -107,7 +107,7 @@ public:
}
/**
* Search for the first occurence of an item.
* Search for the first occurrence of an item.
* The '!=' operator of T is used for comparison.
* @param item Item to search for
* @return The position of the item, or End() when not present
@ -121,7 +121,7 @@ public:
}
/**
* Search for the first occurence of an item.
* Search for the first occurrence of an item.
* The '!=' operator of T is used for comparison.
* @param item Item to search for
* @return The position of the item, or -1 when not present
@ -250,7 +250,7 @@ public:
/**
* Get item "number" (const)
*
* @param index the positon of the item
* @param index the position of the item
* @return the item
*/
FORCEINLINE const T &operator[](uint index) const
@ -262,7 +262,7 @@ public:
/**
* Get item "number"
*
* @param index the positon of the item
* @param index the position of the item
* @return the item
*/
FORCEINLINE T &operator[](uint index)

View File

@ -38,7 +38,7 @@ static FORCEINLINE void QSortT(T *base, uint num, int (CDECL *comparator)(const
* Type safe Gnome Sort.
*
* This is a slightly modifyied Gnome search. The basic
* Gnome search trys to sort already sorted list parts.
* Gnome search tries to sort already sorted list parts.
* The modification skips these.
*
* @note Use this sort for presorted / regular sorted data.

View File

@ -33,16 +33,16 @@ enum TreeType {
TREE_INVALID = 0xFF, ///< An invalid tree
};
/**
/*
* Counts the number of treetypes for each landscape.
*
* This list contains the counts of different treetypes for each landscape. This list contains
* 5 entries instead of 4 (as there are only 4 landscape types) as the sub tropic landscape
* got two types of area, one for normal trees and one only for cacti.
* has two types of area, one for normal trees and one only for cacti.
*/
static const uint TREE_COUNT_TEMPERATE = TREE_SUB_ARCTIC - TREE_TEMPERATE; ///< number of treetypes on a temperate map
static const uint TREE_COUNT_SUB_ARCTIC = TREE_RAINFOREST - TREE_SUB_ARCTIC; ///< number of treetypes on a sub arctic map
static const uint TREE_COUNT_RAINFOREST = TREE_CACTUS - TREE_RAINFOREST; ///< number of treetypes for the 'rainforrest part' of a sub-tropic map
static const uint TREE_COUNT_RAINFOREST = TREE_CACTUS - TREE_RAINFOREST; ///< number of treetypes for the 'rainforest part' of a sub-tropic map
static const uint TREE_COUNT_SUB_TROPICAL = TREE_TOYLAND - TREE_SUB_TROPICAL; ///< number of treetypes for the 'sub-tropic part' of a sub-tropic map
static const uint TREE_COUNT_TOYLAND = 9; ///< number of treetypes on a toyland map

View File

@ -141,7 +141,7 @@ struct ViewportDrawer {
int foundation[FOUNDATION_PART_END]; ///< Foundation sprites (index into parent_sprites_to_draw).
FoundationPart foundation_part; ///< Currently active foundation for ground sprite drawing.
int *last_foundation_child[FOUNDATION_PART_END]; ///< Tail of ChildSprite list of the foundations. (index into child_screen_sprites_to_draw)
Point foundation_offset[FOUNDATION_PART_END]; ///< Pixeloffset for ground sprites on the foundations.
Point foundation_offset[FOUNDATION_PART_END]; ///< Pixel offset for ground sprites on the foundations.
};
static ViewportDrawer _vd;
@ -297,7 +297,7 @@ static void SetViewportPosition(Window *w, int x, int y)
vp->virtual_left = x;
vp->virtual_top = y;
/* viewport is bound to its left top corner, so it must be rounded down (UnScaleByZoomLower)
/* Viewport is bound to its left top corner, so it must be rounded down (UnScaleByZoomLower)
* else glitch described in FS#1412 will happen (offset by 1 pixel with zoom level > NORMAL)
*/
old_left = UnScaleByZoomLower(old_left, vp->zoom);
@ -465,7 +465,7 @@ void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte
}
/**
* Shedules a tile sprite for drawing.
* Schedules a tile sprite for drawing.
*
* @param image the image to draw.
* @param pal the provided palette.
@ -868,7 +868,7 @@ static bool IsPartOfAutoLine(int px, int py)
case HT_DIR_Y: return px == 0; // y direction
case HT_DIR_HU: return px == -py || px == -py - 16; // horizontal upper
case HT_DIR_HL: return px == -py || px == -py + 16; // horizontal lower
case HT_DIR_VL: return px == py || px == py + 16; // vertival left
case HT_DIR_VL: return px == py || px == py + 16; // vertical left
case HT_DIR_VR: return px == py || px == py - 16; // vertical right
default:
NOT_REACHED();
@ -1085,7 +1085,7 @@ static void ViewportAddLandscape()
* @param sign sign position and dimension
* @param string_normal String for normal and 2x zoom level
* @param string_small String for 4x and 8x zoom level
* @param string_small_shadow Shadow string for 4x and 8x zoom level; or STR_NULL if no shadow
* @param string_small_shadow Shadow string for 4x and 8x zoom level; or #STR_NULL if no shadow
* @param colour colour of the sign background; or 0 if transparent
*/
void ViewportAddString(const DrawPixelInfo *dpi, ZoomLevel small_from, const ViewportSign *sign, StringID string_normal, StringID string_small, StringID string_small_shadow, uint64 params_1, uint64 params_2, Colours colour)
@ -1499,7 +1499,7 @@ static inline void ClampViewportToMap(const ViewPort *vp, int &x, int &y)
x = (-vx + vy) / 2;
y = ( vx + vy) / 4;
/* Remove centreing */
/* Remove centering */
x -= vp->virtual_width / 2;
y -= vp->virtual_height / 2;
}
@ -1529,7 +1529,7 @@ void UpdateViewportPosition(Window *w)
if (delta_x != 0 || delta_y != 0) {
if (_settings_client.gui.smooth_scroll) {
int max_scroll = ScaleByMapSize1D(512);
/* Not at our desired positon yet... */
/* Not at our desired position yet... */
w->viewport->scrollpos_x += Clamp(delta_x / 4, -max_scroll, max_scroll);
w->viewport->scrollpos_y += Clamp(delta_y / 4, -max_scroll, max_scroll);
} else {

View File

@ -44,7 +44,7 @@ Window *_z_front_window = NULL;
Window *_z_back_window = NULL;
/*
* Window that currently have focus. - The main purpose is to generate
* Window that currently has focus. - The main purpose is to generate
* FocusLost events, not to give next window in z-order focus when a
* window is closed.
*/