diff options
author | alberth <alberth@openttd.org> | 2010-02-14 15:58:10 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2010-02-14 15:58:10 +0000 |
commit | ac65c415094b01e2f612e720737a633cd822cde0 (patch) | |
tree | 5cec861664f9b840dd6c83737454b717dbf9764a | |
parent | 7dcc41400010e20560fc0cf702d74b2f8f5bf4d4 (diff) | |
download | openttd-ac65c415094b01e2f612e720737a633cd822cde0.tar.xz |
(svn r19131) -Doc: Add doxygen comments to some economy variables and constants.
-rw-r--r-- | src/economy_type.h | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/src/economy_type.h b/src/economy_type.h index 9cde6d7dc..44227a97d 100644 --- a/src/economy_type.h +++ b/src/economy_type.h @@ -17,6 +17,7 @@ typedef OverflowSafeInt64 Money; +/** Data of the economy. */ struct Economy { Money max_loan; ///< NOSAVE: Maximum possible loan int16 fluct; ///< Economy fluctuation status @@ -130,25 +131,26 @@ enum Price { }; DECLARE_POSTFIX_INCREMENT(Price) -typedef Money Prices[PR_END]; +typedef Money Prices[PR_END]; ///< Prices of everything. @see Price typedef int8 PriceMultipliers[PR_END]; +/** Types of expenses. */ enum ExpensesType { - EXPENSES_CONSTRUCTION = 0, - EXPENSES_NEW_VEHICLES, - EXPENSES_TRAIN_RUN, - EXPENSES_ROADVEH_RUN, - EXPENSES_AIRCRAFT_RUN, - EXPENSES_SHIP_RUN, - EXPENSES_PROPERTY, - EXPENSES_TRAIN_INC, - EXPENSES_ROADVEH_INC, - EXPENSES_AIRCRAFT_INC, - EXPENSES_SHIP_INC, - EXPENSES_LOAN_INT, - EXPENSES_OTHER, - EXPENSES_END, - INVALID_EXPENSES = 0xFF, + EXPENSES_CONSTRUCTION = 0, ///< Construction costs. + EXPENSES_NEW_VEHICLES, ///< New vehicles. + EXPENSES_TRAIN_RUN, ///< Running costs trains. + EXPENSES_ROADVEH_RUN, ///< Running costs road vehicles. + EXPENSES_AIRCRAFT_RUN, ///< Running costs aircrafts. + EXPENSES_SHIP_RUN, ///< Running costs ships. + EXPENSES_PROPERTY, ///< Property costs. + EXPENSES_TRAIN_INC, ///< Income from trains. + EXPENSES_ROADVEH_INC, ///< Income from road vehicles. + EXPENSES_AIRCRAFT_INC, ///< Income from aircrafts. + EXPENSES_SHIP_INC, ///< Income from ships. + EXPENSES_LOAN_INT, ///< Interest payments over the loan. + EXPENSES_OTHER, ///< Other expenses. + EXPENSES_END, ///< Number of expense types. + INVALID_EXPENSES = 0xFF, ///< Invalid expense type. }; /** |