Skip to content

Commit

Permalink
docs: added code documentation to closeDialogCommand procedure
Browse files Browse the repository at this point in the history
FossilOrigin-Name: c6becd1ec21426e6b1a20696afdb63b3897651299c1c8e81837c375d8e4e0ee2
  • Loading branch information
thindil committed Jan 22, 2024
1 parent ad98851 commit 1305b84
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions nim/src/ui/dialogs2.nim
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@ import dialogs

proc closeDialogCommand*(clientData: cint; interp: PInterp; argc: cint;
argv: openArray[cstring]): TclResults {.sideEffect, raises: [], tags: [].} =
## Close the selected dialog
##
## * 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:
## CloseDialog dialogname
## Dialogname is name of the dialog to close
if timerId.len > 0:
tclEval(script = "after cancel " & timerId)
timerId = ""
Expand Down

0 comments on commit 1305b84

Please sign in to comment.