code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH List.clear 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 List.clear \- clear a list
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI List.clear\ :\ func(list:\ @[T]\ ->\ Void)
  13 .fi
  14 .SH DESCRIPTION
  15 Clears all elements from the list.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 list	@[T]	The mutable reference to the list to be cleared. 
  26 .TE
  27 .SH RETURN
  28 Nothing.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 list := &[10, 20]
  33 list.clear()
  34 assert list[] == []
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-List (3)