summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsmatz <smatz@openttd.org>2012-01-01 17:36:19 +0000
committersmatz <smatz@openttd.org>2012-01-01 17:36:19 +0000
commitbcd3f2bb590ee7f8e63482a0336b5a1ef068402e (patch)
treecc75f3cf9f14795d135734552ff61cd62deaa4de
parenta90b767995850d69d687aad1c7bdebed073b9295 (diff)
downloadopenttd-bcd3f2bb590ee7f8e63482a0336b5a1ef068402e.tar.xz
(svn r23706) -Codechange: prevent 'unknown command' doxygen errors
-rw-r--r--Doxyfile2
-rw-r--r--src/industry_gui.cpp2
-rw-r--r--src/sprite.h6
-rw-r--r--src/string.cpp2
-rw-r--r--src/strings.cpp2
-rw-r--r--src/table/sprites.h2
-rw-r--r--src/vehicle_gui.cpp2
7 files changed, 9 insertions, 9 deletions
diff --git a/Doxyfile b/Doxyfile
index 3d6059186..66498d084 100644
--- a/Doxyfile
+++ b/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
diff --git a/src/industry_gui.cpp b/src/industry_gui.cpp
index f93070abd..f968d7826 100644
--- a/src/industry_gui.cpp
+++ b/src/industry_gui.cpp
@@ -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)
{
diff --git a/src/sprite.h b/src/sprite.h
index acb19ed4e..16da834c7 100644
--- a/src/sprite.h
+++ b/src/sprite.h
@@ -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
diff --git a/src/string.cpp b/src/string.cpp
index 78869614a..bc9933b40 100644
--- a/src/string.cpp
+++ b/src/string.cpp
@@ -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)
{
diff --git a/src/strings.cpp b/src/strings.cpp
index a4be25b59..cd5b4cee8 100644
--- a/src/strings.cpp
+++ b/src/strings.cpp
@@ -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)
diff --git a/src/table/sprites.h b/src/table/sprites.h
index 39012f1ac..4953070b3 100644
--- a/src/table/sprites.h
+++ b/src/table/sprites.h
@@ -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
diff --git a/src/vehicle_gui.cpp b/src/vehicle_gui.cpp
index 006f6278b..7e5d5e76a 100644
--- a/src/vehicle_gui.cpp
+++ b/src/vehicle_gui.cpp
@@ -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.