Doc: Lots and lots of doxymentation fixes

This commit is contained in:
Charles Pigott
2018-10-28 02:17:36 +00:00
committed by frosch
parent b9273cbe07
commit f5b1115039
108 changed files with 265 additions and 290 deletions

View File

@@ -162,8 +162,7 @@ GenericResolverObject::GenericResolverObject(bool ai_callback, CallbackID callba
* @param object pre-populated resolver object
* @param param1_grfv7 callback_param1 for GRFs up to version 7.
* @param param1_grfv8 callback_param1 for GRFs from version 8 on.
* @param [out] file Optionally returns the GRFFile which made the final decision for the callback result.
* May be NULL if not required.
* @param[out] file Optionally returns the GRFFile which made the final decision for the callback result. May be NULL if not required.
* @return callback value if successful or CALLBACK_FAILED
*/
static uint16 GetGenericCallbackResult(uint8 feature, ResolverObject &object, uint32 param1_grfv7, uint32 param1_grfv8, const GRFFile **file)
@@ -202,8 +201,7 @@ static uint16 GetGenericCallbackResult(uint8 feature, ResolverObject &object, ui
* @param event 'AI construction event' to pass to callback. (Variable 86)
* @param count 'Construction number' to pass to callback. (Variable 87)
* @param station_size 'Station size' to pass to callback. (Variable 88)
* @param [out] file Optionally returns the GRFFile which made the final decision for the callback result.
* May be NULL if not required.
* @param[out] file Optionally returns the GRFFile which made the final decision for the callback result. May be NULL if not required.
* @return callback value if successful or CALLBACK_FAILED
*/
uint16 GetAiPurchaseCallbackResult(uint8 feature, CargoID cargo_type, uint8 default_selection, IndustryType src_industry, IndustryType dst_industry, uint8 distance, AIConstructionEvent event, uint8 count, uint8 station_size, const GRFFile **file)