Skip to content

Commit

Permalink
docs: added code documentation to assignModuleCommand procedure
Browse files Browse the repository at this point in the history
FossilOrigin-Name: 8a6d654cb706bc9b718165ef8edf3c85d8895f93bf7ae56fee42995f82b78fe1
  • Loading branch information
thindil committed Mar 12, 2024
1 parent b4315bd commit 0aac6f2
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions nim/src/ui/shipsuimodules.nim
Original file line number Diff line number Diff line change
Expand Up @@ -950,6 +950,21 @@ proc setUpgradeCommand(clientData: cint; interp: PInterp; argc: cint;

proc assignModuleCommand(clientData: cint; interp: PInterp; argc: cint;
argv: openArray[cstring]): TclResults {.sideEffect, raises: [], tags: [RootEffect].}
## Assign member, ammo or skill to module
##
## * 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:
## AssignModule assigntype moduleindex assignindex
## assigntype is type of item to assing to module: crew, ammo, skills.
## moduleindex is the index of the Player_Ship module to which item will be
## assigned. assignindex is the index of the item which will be assigned
## to the module

proc addCommands*() {.sideEffect, raises: [], tags: [].} =
## Adds Tcl commands related to the wait menu
Expand Down

0 comments on commit 0aac6f2

Please sign in to comment.