cpp/openttd-patchpack/source Changeset - r16300:dae54be93b98

Changeset - r16300:dae54be93b98

Parent rev.

Child rev.

[Not reviewed]

master

0 3 0

alberth - 14 years ago 2010-10-23 18:28:20
alberth@openttd.org

(svn r21018) -Doc: Add Doxygen comments to some function.

3 files changed with 24 insertions and 5 deletions:

src/main_gui.cpp

src/viewport.cpp

src/viewport_type.h

0 comments (0 inline, 0 general)

src/main_gui.cpp

➞

Show inline comments

@@ @@ -128,8 +128,13 @@ void ShowNetworkGiveMoneyWindow(CompanyI @@
 #endif /* ENABLE_NETWORK */
 /* Zooms a viewport in a window in or out
  * No button handling or what so ever */
 /**
  * Zooms a viewport in a window in or out.
  * @param how Zooming direction.
  * @param w   Window owning the viewport.
  * @return Returns \c true if zooming step could be done, \c false if further zooming is not possible.
  * @note No button handling or what so ever is done.
  */
 bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
+{
 	ViewPort *vp;

src/viewport.cpp

➞

Show inline comments

@@ @@ -1886,11 +1886,21 @@ bool ScrollWindowTo(int x, int y, int z, @@
 	return true;
+}
 /**
  * Scrolls the viewport of the main window to a given location.
  * @param tile    Desired tile to center on.
  * @param instant Jump to the location instead of slowly moving to it.
  * @return Destination of the viewport was changed (to activate other actions when the viewport is already at the desired position).
  */
 bool ScrollMainWindowToTile(TileIndex tile, bool instant)
+{
 	return ScrollMainWindowTo(TileX(tile) * TILE_SIZE + TILE_SIZE / 2, TileY(tile) * TILE_SIZE + TILE_SIZE / 2, -1, instant);
+}
 /**
  * Set a tile to display a red error square.
  * @param tile Tile that should show the red error square.
  */
 void SetRedErrorSquare(TileIndex tile)
+{
 	TileIndex old;

src/viewport_type.h

➞

Show inline comments

@@ @@ -51,10 +51,14 @@ struct ViewportSign { @@
 	void MarkDirty() const;
 };
 /**
  * Directions of zooming.
  * @see DoZoomInOutWindow
  */
 enum ZoomStateChange {
 	ZOOM_IN   = 0,
 	ZOOM_OUT  = 1,
 	ZOOM_NONE = 2, // hack, used to update the button status
 	ZOOM_IN   = 0, ///< Zoom in (get more detailed view).
 	ZOOM_OUT  = 1, ///< Zoom out (get helicopter view).
 	ZOOM_NONE = 2, ///< Hack, used to update the button status.
 };
 /**

0 comments (0 inline, 0 general)