docs: added code documentation to several procedures

FossilOrigin-Name: c22508d3dd4a632c65cad23bce38b9e961f4b03068fd751bbb6cc4f5238692be
thindil · Feb 6, 2024 · 8e9a68a · 8e9a68a
1 parent 773d109
commit 8e9a68a
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/types.nim b/src/types.nim
@@ -142,7 +142,17 @@ type
     description*: string
 
 proc `$`*(path: Path): string =
+  ## Convert Path type to string.
+  ##
+  ## * path - the path variable which will be converted to string
+  ##
+  ## The parameter path converted to a string
   return path.string
 
 proc len*(path: Path): Natural =
+  ## Get the length of the path variable
+  ##
+  ## * path - the path variable which length will be count
+  ##
+  ## The lenght of the parameter path
   return ($path).len