Fix nested function return types

Author: vallode

dist/library/df.advmode.lua

@@ -1745,9 +1745,11 @@ df.adventure_optionst = {}
 
 function df.adventure_optionst:getDescription() end
 
+---@return item
 function df.adventure_optionst:getIngestedItem() end
 
 ---for "pick up vermin": the first argument is set to the vermin index if an item was allocated and this was the last vermin of its type the second argument is set to true if an item was allocated, false otherwise the third argument is set to true if the second argument is false the first and third arguments are not changed in all other cases returns an item_verminst pointer for all other types (as of 0.47.04): does not modify arguments 1 and 2 argument 3 is set to true if a fire was started returns nullptr
+---@return item
 function df.adventure_optionst:performAction() end
 
 ---@return integer
@@ -1770,15 +1772,19 @@ function df.adventure_optionst:getTargetPosZ() end
 
 function df.adventure_optionst:deleteSpatter() end
 
+---@return unit
 function df.adventure_optionst:getSuckBloodUnitID() end
 
 ---@return boolean
 function df.adventure_optionst:isIngestFromContainer() end
 
+---@return building
 function df.adventure_optionst:getBuildingContainer() end
 
+---@return item
 function df.adventure_optionst:getItemContainer() end
 
+---@return unit
 function df.adventure_optionst:getUnitContainer() end
 
 ---@class adventure_option_eat_unit_contaminantst: adventure_optionst

dist/library/df.art.lua

@@ -43,6 +43,7 @@ function df.art_image_element:getType() end
 ---@param ID integer
 function df.art_image_element:setID(ID) end
 
+---@return art_image_element
 function df.art_image_element:clone() end
 
 ---@param sym integer
@@ -117,6 +118,7 @@ function df.art_image_property:read_file(file, loadversion) end
 ---@return art_image_property_type
 function df.art_image_property:getType() end
 
+---@return art_image_element
 function df.art_image_property:clone() end
 
 ---@param useName boolean

dist/library/df.buildings.lua

@@ -424,6 +424,7 @@ function df.building:setCustomType(type) end
 ---@param supplies hospital_supplies
 function df.building:countHospitalSupplies(supplies) end
 
+---@return stockpile_links
 function df.building:getStockpileLinks() end
 
 ---?
@@ -433,6 +434,7 @@ function df.building:detachWorldData() end
 ---@return boolean
 function df.building:canLinkToStockpile() end
 
+---@return building_users
 function df.building:getUsers() end
 
 ---@param delta_x integer
@@ -480,8 +482,10 @@ function df.building:isNormalFurniture() end
 ---@return boolean
 function df.building:isFarmPlot() end
 
+---@return workshop_profile
 function df.building:getWorkshopProfile() end
 
+---@return machine_info
 function df.building:getMachineInfo() end
 
 ---@param power_info power_info

dist/library/df.history.lua

@@ -2989,7 +2989,7 @@ function df.history_event:getHappinessModifier(entity1, entity2) end
 function df.history_event:madeFirstContact(entity1, entity2, site) end
 
 ---@param killer historical_figure
----@return integer
+---@return historical_figure
 function df.history_event:getKilledHistfigID(killer) end
 
 ---@param victim historical_figure

dist/library/df.itemimprovements.lua

@@ -81,12 +81,14 @@ df.dye_info = {}
 ---@field unk_1 integer
 df.itemimprovement = {}
 
+---@return art_image
 function df.itemimprovement:getImage() end
 
 ---@param colors integer[]
 ---@param shapes integer[]
 function df.itemimprovement:getColorAndShape(colors, shapes) end
 
+---@return itemimprovement
 function df.itemimprovement:clone() end
 
 ---@param file file_compressorst

dist/library/df.items.lua

@@ -494,6 +494,7 @@ function df.item:getVehicleID() end
 ---@return boolean
 function df.item:isAmmo() end
 
+---@return item_stockpile_ref
 function df.item:getStockpile() end
 
 ---@return boolean
@@ -505,6 +506,7 @@ function df.item:isPlaster() end
 ---@return boolean
 function df.item:getColorOverride() end
 
+---@return item_history_info
 function df.item:getHistoryInfo() end
 
 ---@param use tool_uses
@@ -613,11 +615,14 @@ function df.item:setMaker(unit_id) end
 ---@param punit unit
 function df.item:getCorpseInfo(prace, pcaste, phfig, punit) end
 
+---@return caste_body_info
 function df.item:getBodyInfo() end
 
+---@return boolean[]
 function df.item:getGloveFlags() end
 
 ---a statue/figurine of "string goes here"
+---@return string
 function df.item:getItemShapeDesc() end
 
 ---@return boolean
@@ -669,6 +674,7 @@ function df.item:isBogeymanCorpse() end
 ---@return boolean
 function df.item:testMaterialFlag(mat_flag) end
 
+---@return string
 function df.item:getAmmoType() end
 
 ---@return boolean
@@ -696,6 +702,7 @@ function df.item:getVolume() end
 ---@param site world_site
 ---@param unk integer
 ---@param unshaped boolean
+---@return itemimprovement
 function df.item:addImprovementFromJob(imp_type, job, unit, mat_type, mat_index, shape, forced_quality, entity, site, unk, unshaped) end
 
 ---@return boolean
@@ -793,6 +800,7 @@ function df.item:needTwoHandedWield() end
 
 ---@param stack_size integer
 ---@param preserve_containment boolean
+---@return item
 function df.item:splitStack(stack_size, preserve_containment) end
 
 ---@return boolean
@@ -869,6 +877,7 @@ function df.item:write_file(file) end
 ---@param loadversion save_version
 function df.item:read_file(file, loadversion) end
 
+---@return integer[]
 function df.item:getWeaponAttacks() end
 
 ---@return boolean
@@ -1054,6 +1063,7 @@ function df.item:hasImprovements() end
 ---@return boolean
 function df.item:isImproved() end
 
+---@return item_magicness[]
 function df.item:getMagic() end
 
 ---@param plurality integer
@@ -1121,6 +1131,7 @@ function df.item:detachStockpileAssignment() end
 ---just wipes the fields
 function df.item:removeStockpileAssignment() end
 
+---@return item_stockpile_ref
 function df.item:getStockpile2() end
 
 ---this updates the quality of a thread improvement already added to the item (or adjusts the quality of a thread item) based on the skill of the dyer
@@ -1161,6 +1172,7 @@ function df.item:calcUniformScore(exact_match, best_any, best_melee, best_ranged
 ---@return integer
 function df.item:calcBaseUniformScore() end
 
+---@return slab_engraving_type
 function df.item:getSlabEngravingType() end
 
 ---@return integer
@@ -1175,6 +1187,7 @@ function df.item:setGemShape(shape) end
 ---@return boolean
 function df.item:hasGemShape() end
 
+---@return descriptor_shape
 function df.item:getGemShape() end
 
 ---@return boolean

dist/library/df.map.lua

@@ -897,13 +897,16 @@ function df.feature_init:write_file(file, include_feature) end
 ---@param include_feature boolean
 function df.feature_init:read_file(file, loadversion, include_feature) end
 
+---@return feature
 function df.feature_init:createFeature() end
 
 ---destroyFeature(), then createFeature()
+---@return feature
 function df.feature_init:recreateFeature() end
 
 function df.feature_init:destroyFeature() end
 
+---@return feature
 function df.feature_init:getFeature() end
 
 ---@param mat_type integer
@@ -1094,6 +1097,7 @@ df.world_construction = {}
 ---@return world_construction_type
 function df.world_construction:getType() end
 
+---@return language_name
 function df.world_construction:getName() end
 
 ---@param file file_compressorst

dist/library/df.meeting.lua

@@ -112,6 +112,7 @@ df.script_step_eventst = {}
 ---@field name string
 df.script_varst = {}
 
+---@return active_script_varst
 function df.script_varst:instantiate() end
 
 ---@class script_var_unitst: script_varst
@@ -594,6 +595,7 @@ function df.activity_event:read_file(file, loadversion) end
 ---@return boolean
 function df.activity_event:isEmpty() end
 
+---@return activity_event_participants
 function df.activity_event:getParticipantInfo() end
 
 ---@param children_too boolean
@@ -618,6 +620,7 @@ function df.activity_event:checkDrillInvalid(unit) end
 ---@return boolean
 function df.activity_event:decUniformLock() end
 
+---@return squad_event_type
 function df.activity_event:getSquadEventType() end
 
 ---@param skill job_skill
@@ -637,6 +640,7 @@ function df.activity_event:adjustOrganizeCounter(amount) end
 function df.activity_event:getOrganizer(hist_figure_id, unit_id) end
 
 ---returns pointer to building_id
+---@return integer
 function df.activity_event:getBuilding() end
 
 ---@return boolean

dist/library/df.military.lua

@@ -396,6 +396,7 @@ df.squad_order_cannot_reason = {}
 ---@field unk_1 integer
 df.squad_order = {}
 
+---@return squad_order
 function df.squad_order:clone() end
 
 ---@param file file_compressorst
@@ -431,6 +432,7 @@ function df.squad_order:decUniformLock(soldier) end
 ---@return boolean
 function df.squad_order:isFulfilled() end
 
+---@return integer[]
 function df.squad_order:getTargetUnits() end
 
 ---@param soldier unit

dist/library/df.refs.lua

@@ -299,20 +299,28 @@ function df.general_ref:read_file(file, loadversion) end
 ---@return general_ref_type
 function df.general_ref:getType() end
 
+---@return item
 function df.general_ref:getItem() end
 
+---@return unit
 function df.general_ref:getUnit() end
 
+---@return projectile
 function df.general_ref:getProjectile() end
 
+---@return building
 function df.general_ref:getBuilding() end
 
+---@return historical_entity
 function df.general_ref:getEntity() end
 
+---@return artifact_record
 function df.general_ref:getArtifact() end
 
+---@return nemesis_record
 function df.general_ref:getNemesis() end
 
+---@return activity_event
 function df.general_ref:getEvent() end
 
 function df.general_ref:setID() end
@@ -330,6 +338,7 @@ function df.general_ref:setLocation(x, y, z) end
 ---@param out_z integer
 function df.general_ref:getLocation(out_x, out_y, out_z) end
 
+---@return general_ref
 function df.general_ref:clone() end
 
 ---@param str string