Skip to content

Commit

Permalink
docs: added code documentation to updateAssignCrewCommand procedure
Browse files Browse the repository at this point in the history
FossilOrigin-Name: 7c8a4df418565547b5ce5670f5f7a407daaa2fb2bd9f9eaefe2168517100f0f6
  • Loading branch information
thindil committed Mar 16, 2024
1 parent 0e3daf4 commit 76522a9
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions nim/src/ui/shipsuimodules.nim
Original file line number Diff line number Diff line change
Expand Up @@ -1029,6 +1029,20 @@ proc resetDestinationCommand(clientData: cint; interp: PInterp; argc: cint;

proc updateAssignCrewCommand(clientData: cint; interp: PInterp; argc: cint;
argv: openArray[cstring]): TclResults {.sideEffect, raises: [], tags: [RootEffect].} =
## Update assign the crew member UI
##
## * clientData - the additional data for the Tcl command
## * interp - the Tcl interpreter on which the command was executed
## * argc - the amount of arguments entered for the command
## * argv - the list of the command's arguments
##
## The procedure always return tclOk
##
## Tcl:
## UpdateAssignCrew moduleindex ?crewindex?
## Moduleindex is the index of the module to which a new crew members will
## be assigned. Crewindex is the index of the crew member which will be
## assigned or removed
let
moduleIndex = try:
($argv[1]).parseInt
Expand Down

0 comments on commit 76522a9

Please sign in to comment.