Mercurial > hg > openttd

changeset 19492:e38ba89182f4 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r24395) -Doc: Fixed argument references in @param descriptions.
author alberth <alberth@openttd.org>
date Tue, 10 Jul 2012 18:37:54 +0000
parents 7f19f5271d45
children 8d38edc7e773
files src/industry_gui.cpp src/newgrf.cpp src/screenshot.cpp src/script/api/script_goal.hpp src/subsidy.cpp src/vehiclelist.cpp
diffstat 6 files changed, 17 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/src/industry_gui.cpp
+++ b/src/industry_gui.cpp
@@ -1548,7 +1548,7 @@
 	/**
 	 * Make a piece of cargo column.
 	 * @param cargoes    Array of #CargoID (may contain #INVALID_CARGO).
-	 * @param length     Number of cargoes in #cargoes.
+	 * @param length     Number of cargoes in \a cargoes.
 	 * @param count      Number of cargoes to display (should be at least the number of valid cargoes, or \c -1 to let the method compute it).
 	 * @param top_end    This is the first cargo field of this column.
 	 * @param bottom_end This is the last cargo field of this column.
@@ -1576,7 +1576,7 @@
 	/**
 	 * Make a field displaying cargo type names.
 	 * @param cargoes    Array of #CargoID (may contain #INVALID_CARGO).
-	 * @param length     Number of cargoes in #cargoes.
+	 * @param length     Number of cargoes in \a cargoes.
 	 * @param left_align ALign texts to the left (else to the right).
 	 */
 	void MakeCargoLabel(const CargoID *cargoes, uint length, bool left_align)
@@ -2158,7 +2158,7 @@
 	/**
 	 * Count how many industries have accepted cargoes in common with one of the supplied set.
 	 * @param cargoes Cargoes to search.
-	 * @param length  Number of cargoes in #cargoes.
+	 * @param length  Number of cargoes in \a cargoes.
 	 * @return Number of industries that have an accepted cargo in common with the supplied set.
 	 */
 	static int CountMatchingAcceptingIndustries(const CargoID *cargoes, uint length)
@@ -2176,7 +2176,7 @@
 	/**
 	 * Count how many industries have produced cargoes in common with one of the supplied set.
 	 * @param cargoes Cargoes to search.
-	 * @param length  Number of cargoes in #cargoes.
+	 * @param length  Number of cargoes in \a cargoes.
 	 * @return Number of industries that have a produced cargo in common with the supplied set.
 	 */
 	static int CountMatchingProducingIndustries(const CargoID *cargoes, uint length)
--- a/src/newgrf.cpp
+++ b/src/newgrf.cpp
@@ -856,7 +856,7 @@
  * See http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts
  * @param base_pointer TTD(P) Base Price Pointer
  * @param error_location Function name for grf error messages
- * @param index If #base_pointer is valid, #index is assigned to the matching price; else it is left unchanged
+ * @param[out] index If \a base_pointer is valid, \a index is assigned to the matching price; else it is left unchanged
  */
 static void ConvertTTDBasePrice(uint32 base_pointer, const char *error_location, Price *index)
 {
--- a/src/screenshot.cpp
+++ b/src/screenshot.cpp
@@ -50,7 +50,7 @@
  * Function signature for a screenshot generation routine for one of the available formats.
  * @param name        Filename, including extension.
  * @param callb       Callback function for generating lines of pixels.
- * @param userdata    User data, passed on to #callb.
+ * @param userdata    User data, passed on to \a callb.
  * @param w           Width of the image in pixels.
  * @param h           Height of the image in pixels.
  * @param pixelformat Bits per pixel (bpp), either 8 or 32.
@@ -106,7 +106,7 @@
  * Generic .BMP writer
  * @param name file name including extension
  * @param callb callback used for gathering rendered image
- * @param userdata parameters forwarded to #callb
+ * @param userdata parameters forwarded to \a callb
  * @param w width in pixels
  * @param h height in pixels
  * @param pixelformat bits per pixel
@@ -252,7 +252,7 @@
  * Generic .PNG file image writer.
  * @param name        Filename, including extension.
  * @param callb       Callback function for generating lines of pixels.
- * @param userdata    User data, passed on to #callb.
+ * @param userdata    User data, passed on to \a callb.
  * @param w           Width of the image in pixels.
  * @param h           Height of the image in pixels.
  * @param pixelformat Bits per pixel (bpp), either 8 or 32.
@@ -430,7 +430,7 @@
  * Generic .PCX file image writer.
  * @param name        Filename, including extension.
  * @param callb       Callback function for generating lines of pixels.
- * @param userdata    User data, passed on to #callb.
+ * @param userdata    User data, passed on to \a callb.
  * @param w           Width of the image in pixels.
  * @param h           Height of the image in pixels.
  * @param pixelformat Bits per pixel (bpp), either 8 or 32.
--- a/src/script/api/script_goal.hpp
+++ b/src/script/api/script_goal.hpp
@@ -86,7 +86,7 @@
 	 * @param company The company to create the goal for, or ScriptCompany::COMPANY_INVALID for all.
 	 * @param goal The goal to add to the GUI (can be either a raw string, or a ScriptText object).
 	 * @param type The type of the goal.
-	 * @param destination The destination of the #type type.
+	 * @param destination The destination of the \a type type.
 	 * @return The new GoalID, or GOAL_INVALID if it failed.
 	 * @pre No ScriptCompanyMode may be in scope.
 	 * @pre goal != NULL && len(goal) != 0.
--- a/src/subsidy.cpp
+++ b/src/subsidy.cpp
@@ -189,9 +189,9 @@
 
 /**
  * Checks if the source and destination of a subsidy are inside the distance limit.
- * @param src_type Type of #src.
+ * @param src_type Type of \a src.
  * @param src      Index of source.
- * @param dst_type Type of #dst.
+ * @param dst_type Type of \a dst.
  * @param dst      Index of destination.
  * @return True if they are inside the distance limit.
  */
@@ -206,9 +206,9 @@
 /**
  * Creates a subsidy with the given parameters.
  * @param cid      Subsidised cargo.
- * @param src_type Type of #src.
+ * @param src_type Type of \a src.
  * @param src      Index of source.
- * @param dst_type Type of #dst.
+ * @param dst_type Type of \a dst.
  * @param dst      Index of destination.
  */
 void CreateSubsidy(CargoID cid, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
@@ -399,7 +399,7 @@
 /**
  * Tries to find a suitable destination for the given source and cargo.
  * @param cid      Subsidized cargo.
- * @param src_type Type of #src.
+ * @param src_type Type of \a src.
  * @param src      Index of source.
  * @return True iff the subsidy was created.
  */
@@ -520,7 +520,7 @@
  * Tests whether given delivery is subsidised and possibly awards the subsidy to delivering company
  * @param cargo_type type of cargo
  * @param company company delivering the cargo
- * @param src_type type of #src
+ * @param src_type type of \a src
  * @param src index of source
  * @param st station where the cargo is delivered to
  * @return is the delivery subsidised?
--- a/src/vehiclelist.cpp
+++ b/src/vehiclelist.cpp
@@ -60,7 +60,7 @@
  * @param tile    The tile the depot is located on
  * @param engines Pointer to list to add vehicles to
  * @param wagons  Pointer to list to add wagons to (can be NULL)
- * @param individual_wagons If true add every wagon to #wagons which is not attached to an engine. If false only add the first wagon of every row.
+ * @param individual_wagons If true add every wagon to \a wagons which is not attached to an engine. If false only add the first wagon of every row.
  */
 void BuildDepotVehicleList(VehicleType type, TileIndex tile, VehicleList *engines, VehicleList *wagons, bool individual_wagons)
 {