Doc: Summary for count_type_leaves

romainbrenguier · romainbrenguier · commit 5a0343f56465 · 2017-11-01T07:55:45.000Z
diff --git a/src/goto-programs/interpreter_evaluate.cpp b/src/goto-programs/interpreter_evaluate.cpp
@@ -102,6 +102,9 @@ void interpretert::clear_input_flags()
   }
 }
 
+/// Count the number of leaf subtypes of `ty`, a leaf type is a type that is
+/// not an array or a struct. For instance the count for a type such as
+/// `struct { (int[3])[5]; int }` would be 16 = (3 * 5 + 1).
 /// \param ty: a type
 /// \param [out] result: Number of leaf primitive types in `ty`
 /// \return returns true on error

Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,9 @@ void interpretert::clear_input_flags()`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`
	`105`	+/// Count the number of leaf subtypes of `ty`, a leaf type is a type that is
	`106`	`+/// not an array or a struct. For instance the count for a type such as`
	`107`	+/// `struct { (int[3])[5]; int }` would be 16 = (3 * 5 + 1).
`105`	`108`	`/// \param ty: a type`
`106`	`109`	/// \param [out] result: Number of leaf primitive types in `ty`
`107`	`110`	`/// \return returns true on error`