Worked on DCS function prototyping

Found in LDT the means to create using luadoc function prototypes using
a documentation mechanism. Am reworking now the DCS function manual to a
luadoc structure.
This commit is contained in:
FlightControl
2016-03-24 11:00:49 +01:00
parent 11c7cea1de
commit 560e3d643f
20 changed files with 1381 additions and 91 deletions

82
DCS/Group.doclua Normal file
View File

@@ -0,0 +1,82 @@
-------------------------------------------------------------------------------
-- @module Group
--- Represents group of Units.
-- @type Group
-- @field #ID ID Identifier of a group. It is assigned to a group by Mission Editor automatically.
-- @field #Group.Category Category Enum contains identifiers of group types.
--- Enum contains identifiers of group types.
-- @type Group.Category
-- @field AIRPLANE
-- @field HELICOPTER
-- @field GROUND
-- @field SHIP
-- Static Functions
--- Returns group by the name assigned to the group in Mission Editor.
-- @function [parent=#Airbase] getByName
-- @param #string name
-- @return #Group
-- Member Functions
--- returns true if the group exist or false otherwise.
-- @function [parent=#Airbase] isExist
-- @param self
-- @return #boolean
--- Destroys the group and all of its units.
-- @function [parent=#Airbase] destroy
-- @param self
--- Returns category of the group.
-- @function [parent=#Airbase] getCategory
-- @param self
-- @return #Group.Category
--TODO check coalition.side
--- Returns coalition of the group.
-- @function [parent=#Airbase] getCoalition
-- @param self
-- @return #coalition.side
--- Returns the group's name. This is the same name assigned to the group in Mission Editor.
-- @function [parent=#Airbase] getName
-- @param self
-- @return #string
--- Returns the group identifier.
-- @function [parent=#Airbase] getID
-- @param self
-- @return #ID
--- Returns the unit with number unitNumber. If the unit is not exists the function will return nil.
-- @function [parent=#Airbase] getUnit
-- @param self
-- @param #number unitNumber
-- @return Unit#Unit
--- Returns current size of the group. If some of the units will be destroyed, As units are destroyed the size of the group will be changed.
-- @function [parent=#Airbase] getSize
-- @param self
-- @return #number
--- Returns initial size of the group. If some of the units will be destroyed, initial size of the group will not be changed. Initial size limits the unitNumber parameter for Group.getUnit() function.
-- @function [parent=#Airbase] getInitialSize
-- @param self
-- @return #number
--- Returns array of the units present in the group now. Destroyed units will not be enlisted at all.
-- @function [parent=#Airbase] getUnits
-- @param self
-- @return #list<Unit#Unit> array of Units
--- Returns controller of the group.
-- @function [parent=#Airbase] getController
-- @param self
-- @return Controller#Controller
Group = {} --#Group