cpp/openttd-patchpack/source Changeset - r18847:c72a2915657e

Changeset - r18847:c72a2915657e

Parent rev.

Child rev.

[Not reviewed]

master

0 7 0

smatz - 13 years ago 2012-01-01 17:36:19
smatz@openttd.org

(svn r23706) -Codechange: prevent 'unknown command' doxygen errors

7 files changed with 9 insertions and 9 deletions:

Doxyfile

src/industry_gui.cpp

src/sprite.h

src/string.cpp

src/strings.cpp

src/table/sprites.h

src/vehicle_gui.cpp

0 comments (0 inline, 0 general)

Doxyfile

➞

Show inline comments

@@ @@ -90,13 +90,13 @@ FILE_PATTERNS = *.c \ @@
                          *.c++ \
                          *.h \
                          *.hpp
 RECURSIVE              = YES
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = */3rdparty */.svn
+EXCLUDE_PATTERNS       = */3rdparty */.svn */script/api
 EXAMPLE_PATH           =
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
 IMAGE_PATH             =
 INPUT_FILTER           =
 FILTER_PATTERNS        =

src/industry_gui.cpp

➞

Show inline comments

@@ @@ -1844,13 +1844,13 @@ struct CargoesField { @@
 private:
 	/**
 	 * Draw a horizontal cargo connection.
 	 * @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)
+	{
 		GfxDrawLine(left, top, right, top, CARGO_LINE_COLOUR);
 		GfxFillRect(left, top + 1, right, top + FONT_HEIGHT_NORMAL - 2, csp->legend_colour, FILLRECT_OPAQUE);
 		GfxDrawLine(left, top + FONT_HEIGHT_NORMAL - 1, right, top + FONT_HEIGHT_NORMAL - 1, CARGO_LINE_COLOUR);

src/sprite.h

➞

Show inline comments

@@ @@ -136,14 +136,14 @@ static inline void DrawNewGRFTileSeqInGU @@
+{
 	DrawCommonTileSeqInGUI(x, y, dts, 0, stage, default_palette, true);
+}
 /**
  * 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
  * @param pal The palette from the sprite layout
  * @param default_pal The default recolour sprite to use (typically company colour resp. random industry/house colour)
  * @return The palette to use
@@ @@ -156,13 +156,13 @@ static inline PaletteID SpriteLayoutPale @@
 		return PAL_NONE;
+	}
+}
 /**
  * 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
  * @param pal The palette from the sprite layout
  * @param default_pal The default recolour sprite to use (typically company colour resp. random industry/house colour)
  * @return The palette to use

src/string.cpp

➞

Show inline comments

@@ @@ -520,13 +520,13 @@ size_t Utf8Encode(char *buf, WChar c) @@
 /**
  * Properly terminate an UTF8 string to some maximum length
  * @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)
+{
 	size_t length = 0;
 	for (const char *ptr = strchr(s, '\0'); *s != '\0';) {

src/strings.cpp

➞

Show inline comments

@@ @@ -1930,13 +1930,13 @@ const char *GetCurrentLanguageIsoCode() @@
 	return _langpack->isocode;
+}
 /**
  * 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)
+{
 	InitFreeType(this->Monospace());
 	const Sprite *question_mark[FS_END];

src/table/sprites.h

➞

Show inline comments

@@ @@ -10,13 +10,13 @@ @@
 /**
  * @file sprites.h
  * This file contails all sprite-related enums and defines. These consist mainly of
  * 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
  * have the same name and then suffixes
  *   _GROUND and _BUILD for building-type sprites
  *   _REAR and _FRONT for transport-type sprites (tiles where vehicles are on)

src/vehicle_gui.cpp

➞

Show inline comments

@@ @@ -356,13 +356,13 @@ static void DrawVehicleRefitWindow(const @@
+	}
+}
 /** 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.
 	Scrollbar *vscroll;          ///< The main scrollbar.
 	Scrollbar *hscroll;          ///< Only used for long vehicles.
 	int vehicle_width;           ///< Width of the vehicle being drawn.

0 comments (0 inline, 0 general)