В процессе. Доработка документации

scripts/tools.gd

@@ -7,7 +7,7 @@ extends Node
 func round_to(v: float, a: float) -> float: return snappedf(v, -a if v < 0 else a)
 
 
-## Возвращает true, если val число, false - если иначе
+## Возвращает [b]true[/b], если [param val] число, [b]false[/b] - если иначе.
 func type_is_num(val) -> bool: return (typeof(val) == TYPE_INT) or (typeof(val) == typeof(0.0))
 
 
@@ -61,8 +61,9 @@ func is_array_ipaddr(val: Array):
         and (val[1] < 65536)
 
 
-## Преобразует декартовые координаты в полярные. [param pos0]
-## - координаты центра, [param pos] - координаты точки
+## Преобразует декартовые координаты в полярные.[br]
+## [param pos0] - координаты центра.[br]
+## [param pos] - координаты точки.[br]
 func map_dec_to_rad(pos0: Vector2, pos: Vector2) -> Vector2:
     var x1:  float = pos.x - pos0.x
     var y1:  float = pos.y - pos0.y
@@ -75,7 +76,7 @@ func map_range(val: float, a0: float, a1: float, b0: float, b1: float) -> float:
     return (((val - a0) * (b1 - b0)) / (a1 - a0)) + b0
 
 
-## Возвращает true, если точка внутри заданного полигона
+## Возвращает [b]true[/b], если точка внутри заданного полигона
 func is_point_in_polygon(pos: Vector2, p: PackedVector2Array) -> bool:
     var sz: = p.size()
     assert(sz)
@@ -89,7 +90,8 @@ func is_point_in_polygon(pos: Vector2, p: PackedVector2Array) -> bool:
 
 
 ## Записывает слово [param val] в элемент байтовго массива [param buf]
-## расположенный по индексу [param index]. Младшее слово
+## расположенный по индексу [param index] (младшее слово).[br]
+## [i]Следует использовать встроенные в[/i] [b]PackedByteArray[/b] [i]методы вместо этой функции.[/i]
 func set_wordi(buf: PackedByteArray, index: int, val: int) -> void:
     buf[index] = val & 0xff
     buf[index + 1] = (val >> 8) & 0xff