mirror of https://github.com/OpenTTD/OpenTTD.git
(svn r23706) -Codechange: prevent 'unknown command' doxygen errors
This commit is contained in:
parent
a90b767995
commit
bcd3f2bb59
2
Doxyfile
2
Doxyfile
|
@ -93,7 +93,7 @@ FILE_PATTERNS = *.c \
|
|||
RECURSIVE = YES
|
||||
EXCLUDE =
|
||||
EXCLUDE_SYMLINKS = NO
|
||||
EXCLUDE_PATTERNS = */3rdparty */.svn
|
||||
EXCLUDE_PATTERNS = */3rdparty */.svn */script/api
|
||||
EXAMPLE_PATH =
|
||||
EXAMPLE_PATTERNS = *
|
||||
EXAMPLE_RECURSIVE = NO
|
||||
|
|
|
@ -1847,7 +1847,7 @@ private:
|
|||
* @param left Left-most coordinate to draw.
|
||||
* @param right Right-most coordinate to draw.
|
||||
* @param top Top coordinate of the cargo connection.
|
||||
* @csp Cargo to draw.
|
||||
* @param csp Cargo to draw.
|
||||
*/
|
||||
static void DrawHorConnection(int left, int right, int top, const CargoSpec *csp)
|
||||
{
|
||||
|
|
|
@ -139,8 +139,8 @@ static inline void DrawNewGRFTileSeqInGUI(int x, int y, const DrawTileSprites *d
|
|||
|
||||
/**
|
||||
* Applies PALETTE_MODIFIER_TRANSPARENT and PALETTE_MODIFIER_COLOUR to a palette entry of a sprite layout entry
|
||||
* @Note for ground sprites use #GroundSpritePaletteTransform
|
||||
* @Note Not useable for OTTD internal spritelayouts from table/xxx_land.h as PALETTE_MODIFIER_TRANSPARENT is only set
|
||||
* @note for ground sprites use #GroundSpritePaletteTransform
|
||||
* @note Not useable for OTTD internal spritelayouts from table/xxx_land.h as PALETTE_MODIFIER_TRANSPARENT is only set
|
||||
* when to use the default palette.
|
||||
*
|
||||
* @param image The sprite to draw
|
||||
|
@ -159,7 +159,7 @@ static inline PaletteID SpriteLayoutPaletteTransform(SpriteID image, PaletteID p
|
|||
|
||||
/**
|
||||
* Applies PALETTE_MODIFIER_COLOUR to a palette entry of a ground sprite
|
||||
* @Note Not useable for OTTD internal spritelayouts from table/xxx_land.h as PALETTE_MODIFIER_TRANSPARENT is only set
|
||||
* @note Not useable for OTTD internal spritelayouts from table/xxx_land.h as PALETTE_MODIFIER_TRANSPARENT is only set
|
||||
* when to use the default palette.
|
||||
*
|
||||
* @param image The sprite to draw
|
||||
|
|
|
@ -523,7 +523,7 @@ size_t Utf8Encode(char *buf, WChar c)
|
|||
* @param s string to check if it needs additional trimming
|
||||
* @param maxlen the maximum length the buffer can have.
|
||||
* @return the new length in bytes of the string (eg. strlen(new_string))
|
||||
* @NOTE maxlen is the string length _INCLUDING_ the terminating '\0'
|
||||
* @note maxlen is the string length _INCLUDING_ the terminating '\0'
|
||||
*/
|
||||
size_t Utf8TrimString(char *s, size_t maxlen)
|
||||
{
|
||||
|
|
|
@ -1933,7 +1933,7 @@ const char *GetCurrentLanguageIsoCode()
|
|||
/**
|
||||
* Check whether there are glyphs missing in the current language.
|
||||
* @param Pointer to an address for storing the text pointer.
|
||||
* @return If glyphs are missing, return \c true, else return \false.
|
||||
* @return If glyphs are missing, return \c true, else return \c false.
|
||||
* @post If \c true is returned and str is not NULL, *str points to a string that is found to contain at least one missing glyph.
|
||||
*/
|
||||
bool MissingGlyphSearcher::FindMissingGlyphs(const char **str)
|
||||
|
|
|
@ -13,7 +13,7 @@
|
|||
* the sprite numbers and a bunch of masks and macros to handle sprites and to get
|
||||
* rid of all the magic numbers in the code.
|
||||
*
|
||||
* @NOTE:
|
||||
* @note
|
||||
* ALL SPRITE NUMBERS BELOW 5126 are in the main files
|
||||
*
|
||||
* All elements which consist of two elements should
|
||||
|
|
|
@ -359,7 +359,7 @@ static void DrawVehicleRefitWindow(const SubtypeList list[NUM_CARGO], int sel, u
|
|||
/** Refit cargo window. */
|
||||
struct RefitWindow : public Window {
|
||||
int sel; ///< Index in refit options, \c -1 if nothing is selected.
|
||||
RefitOption *cargo; ///< Refit option selected by \v sel.
|
||||
RefitOption *cargo; ///< Refit option selected by #sel.
|
||||
SubtypeList list[NUM_CARGO]; ///< List of refit subtypes available for each sorted cargo.
|
||||
VehicleOrderID order; ///< If not #INVALID_VEH_ORDER_ID, selection is part of a refit order (rather than execute directly).
|
||||
uint information_width; ///< Width required for correctly displaying all cargoes in the information panel.
|
||||
|
|
Loading…
Reference in New Issue