Add docstring for PlaceOperation

artemagvanian · artemagvanian · commit cc1798b1f253 · 2024-08-17T12:29:21.000-07:00
diff --git a/kani-compiler/src/kani_middle/transform/check_uninit/delayed_ub/instrumentation_visitor.rs b/kani-compiler/src/kani_middle/transform/check_uninit/delayed_ub/instrumentation_visitor.rs
@@ -32,6 +32,8 @@ pub struct InstrumentationVisitor<'a, 'tcx> {
     tcx: TyCtxt<'tcx>,
 }
 
+/// This enum differentiates between different reasons to visit a place, yielding different
+/// instrumentation injected.
 enum PlaceOperation {
     Read,
     Write,

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@ pub struct InstrumentationVisitor<'a, 'tcx> {`
`32`	`32`	`tcx: TyCtxt<'tcx>,`
`33`	`33`	`}`
`34`	`34`
	`35`	`+/// This enum differentiates between different reasons to visit a place, yielding different`
	`36`	`+/// instrumentation injected.`
`35`	`37`	`enum PlaceOperation {`
`36`	`38`	`Read,`
`37`	`39`	`Write,`