docs: added code documentation to zoomMapCommand procedure

FossilOrigin-Name: 09ea1601fc804d77e26bd65b9a68b42383be3dbbcde4c6bc16e7af7dc423d235
thindil · Jan 26, 2024 · 7e74252 · 7e74252
1 parent 87f8db0
commit 7e74252
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/nim/src/ui/mapsui.nim b/nim/src/ui/mapsui.nim
@@ -994,6 +994,17 @@ proc moveMapCommand(clientData: cint; interp: PInterp; argc: cint;
 
 proc zoomMapCommand(clientData: cint; interp: PInterp; argc: cint;
     argv: openArray[cstring]): TclResults {.sideEffect, raises: [], tags: [].} =
+  ## Zoom in or our the sky map
+  ##
+  ## * 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:
+  ## ZoomMap
   gameSettings.mapFontSize = (if argv[1] == "raise": gameSettings.mapFontSize +
       1 else: gameSettings.mapFontSize - 1)
   if gameSettings.mapFontSize < 3: