summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2014-07-12 12:21:40 +0000
committeralberth <alberth@openttd.org>2014-07-12 12:21:40 +0000
commit98194e7b6a2ad0615b8c68fa368e246f470ea09d (patch)
tree42c54da82d5f7c1c8cb0e1adadd4fb2aa39f72e1 /src
parent004607c17b383dbcd2df13000403429618c705d1 (diff)
downloadopenttd-98194e7b6a2ad0615b8c68fa368e246f470ea09d.tar.xz
(svn r26684) -Doc: Improve Doxygen markup with a few links to a constant and functions.
Diffstat (limited to 'src')
-rw-r--r--src/cargomonitor.cpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/cargomonitor.cpp b/src/cargomonitor.cpp
index 7d31e6e23..7e0ba9761 100644
--- a/src/cargomonitor.cpp
+++ b/src/cargomonitor.cpp
@@ -19,11 +19,11 @@ CargoMonitorMap _cargo_pickups; ///< Map of monitored pick-ups to the amoun
CargoMonitorMap _cargo_deliveries; ///< Map of monitored deliveries to the amount since last query/activation.
/**
- * Helper method for ClearCargoPickupMonitoring and ClearCargoDeliveryMonitoring.
- * Clears all monitors that belong to the specified company or all if INVALID_OWNER
+ * Helper method for #ClearCargoPickupMonitoring and #ClearCargoDeliveryMonitoring.
+ * Clears all monitors that belong to the specified company or all if #INVALID_OWNER
* is specified as company.
* @param cargo_monitor_map reference to the cargo monitor map to operate on.
- * @param company company to clear cargo monitors for or INVALID_OWNER if all cargo monitors should be cleared.
+ * @param company company to clear cargo monitors for or #INVALID_OWNER if all cargo monitors should be cleared.
*/
static void ClearCargoMonitoring(CargoMonitorMap &cargo_monitor_map, CompanyID company = INVALID_OWNER)
{
@@ -44,7 +44,7 @@ static void ClearCargoMonitoring(CargoMonitorMap &cargo_monitor_map, CompanyID c
/**
* Clear all pick-up cargo monitors.
- * @param company clear all pick-up monitors for this company or if INVALID_OWNER
+ * @param company clear all pick-up monitors for this company or if #INVALID_OWNER
* is passed, all pick-up monitors are cleared regardless of company.
*/
void ClearCargoPickupMonitoring(CompanyID company)
@@ -54,7 +54,7 @@ void ClearCargoPickupMonitoring(CompanyID company)
/**
* Clear all delivery cargo monitors.
- * @param company clear all delivery monitors for this company or if INVALID_OWNER
+ * @param company clear all delivery monitors for this company or if #INVALID_OWNER
* is passed, all delivery monitors are cleared regardless of company.
*/
void ClearCargoDeliveryMonitoring(CompanyID company)