Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
birgersp committed May 24, 2017
1 parent 4337ef2 commit 4655d56
Show file tree
Hide file tree
Showing 23 changed files with 8,645 additions and 7,529 deletions.
8 changes: 4 additions & 4 deletions autogft/setup.lua
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ function autogft_Setup:setSkill(skill)
end

---
-- Sets the maximum distance of unit routes (see @{#Setup.maxDistanceKM}).
-- Sets the maximum distance of unit routes.
-- If set, this number constrains how far groups of the task force will move between each move command (advancement).
-- When units are moving towards a target, units will stop at this distance and wait for the next movement command.
-- This prevents lag when computing routes over long distances.
Expand All @@ -348,7 +348,7 @@ function autogft_Setup:setMaxRouteDistance(maxDistanceKM)
end

---
-- Sets the desired speed of the task force units when advancing (see @{#Setup.speed}).
-- Sets the desired speed of the task force units when advancing.
-- @param #Setup self
-- @param #boolean speed New speed (in knots)
-- @return #Setup This instance (self)
Expand All @@ -358,7 +358,7 @@ function autogft_Setup:setSpeed(speed)
end

---
-- Invokes @{Setup.copyGroupsLayout} and @{Setup.useExistingGroups}.
-- Invokes @{#Setup.copyGroupsLayout} and @{#Setup.useExistingGroups}.
-- @param #Setup self
-- @param #string groupNamePrefix
-- @return #Setup
Expand Down Expand Up @@ -396,7 +396,7 @@ function autogft_Setup:useExistingGroups(groupNamePrefix)
end

---
-- Stops the reinforcing/respawning timers (see @{Setup.setReinforceTimer}).
-- Stops the reinforcing/respawning timers (see @{#Setup.setReinforceTimer}).
-- @param #Setup self
-- @return #Setup
function autogft_Setup:stopReinforcing()
Expand Down
Loading

0 comments on commit 4655d56

Please sign in to comment.