Skip to content

Commit

Permalink
docs: added code documentation to showEventsCommand procedure
Browse files Browse the repository at this point in the history
FossilOrigin-Name: 2d3b2cb6994d2729af6d9ad06c06bf13ddb41c09f410ade3bdb2c10ddb5a5084
  • Loading branch information
thindil committed Aug 9, 2024
1 parent 3e8ae91 commit 3dc212e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions nim/src/ui/knowledgeevents.nim
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,18 @@ proc updateEventsList*(page: Positive = 1) {.sideEffect, raises: [], tags: [Root
proc showEventsCommand(clientData: cint; interp: PInterp; argc: cint;
argv: cstringArray): TclResults {.sideEffect, raises: [], tags: [
RootEffect], exportc.} =
## Show the list of known events to the player
##
## * 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:
## ShowEvents ?startindex?
## Page parameter is a page number which will be show
if argc == 2:
try:
updateEventsList(page = ($argv[1]).parseInt)
Expand Down

0 comments on commit 3dc212e

Please sign in to comment.