docs: added code documentation to showOrdersCommand procedure

FossilOrigin-Name: db9d56d23951489237b4ad4b8faba4e6eb889fd9ca13012091b94abde4c10d20
thindil · Jan 24, 2024 · 41958d3 · 41958d3
1 parent 032b1fc
commit 41958d3
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/nim/src/ui/ordersmenu.nim b/nim/src/ui/ordersmenu.nim
@@ -22,6 +22,17 @@ import coreui, dialogs, dialogs2
 
 proc showOrdersCommand*(clientData: cint; interp: PInterp; argc: cint;
     argv: openArray[cstring]): TclResults {.sideEffect, raises: [], tags: [].} =
+  ## Show available the player's ship's orders 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:
+  ## ShowOrders
   var ordersMenu = createDialog(name = ".gameframe.orders",
       title = "Ship orders")
   if tclEval2(script = "winfo ismapped " & ordersMenu) == "1":