Skip to content

Commit 3b6f4e4

Browse files
committed
added documentation to the check_list variable
1 parent d002355 commit 3b6f4e4

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/common/util/checks.ml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ module CategoryLocationMap = Hashtbl.Make (struct
114114

115115

116116
let checks_list : (bool ref * unit CheckMap.t) CategoryLocationMap.t = CategoryLocationMap.create 113
117+
(** Store the list of checks raised by the analysis. The [bool ref] stores whether all checks in the map are safe.
118+
The [unit CheckMap.t] is the set of checks associated with the given [Category.t * CilType.Location.t] pair. *)
117119

118120
let add_check check =
119121
match check.Check.range with

0 commit comments

Comments
 (0)