Skip to content

Commit

Permalink
docs: added code documentation to setShipNameCommand procedure
Browse files Browse the repository at this point in the history
FossilOrigin-Name: 1fdd82586d4fe7ace835b01b55a33f75fa93389aa690cb39adb31093e382dc34
  • Loading branch information
thindil committed Mar 4, 2024
1 parent 2e9565b commit 0b220ed
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions nim/src/ui/shipsui.nim
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,18 @@ proc showShipInfoCommand*(clientData: cint; interp: PInterp; argc: cint;

proc setShipNameCommand*(clientData: cint; interp: PInterp; argc: cint;
argv: openArray[cstring]): TclResults {.sideEffect, raises: [], tags: [].} =
## Change name of the player's ship
##
## * 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:
## SetShipName shipname
## Shipname is the new name for the player's ship
if argc == 1:
return tclOk
let nameEntry = mainPaned & ".shipinfoframe.general.canvas.frame.name"
Expand Down

0 comments on commit 0b220ed

Please sign in to comment.