Add a doc comment for eval_mir_constant

saethlin · RalfJung · web-flow · commit c8a675d75236 · 2024-01-23T10:17:50.000-05:00
Co-authored-by: Ralf Jung &lt;post@ralfj.de&gt;
diff --git a/compiler/rustc_const_eval/src/interpret/machine.rs b/compiler/rustc_const_eval/src/interpret/machine.rs
@@ -512,6 +512,8 @@ pub trait Machine<'mir, 'tcx: 'mir>: Sized {
         Ok(())
     }
 
+    /// Evaluate the given constant. The `eval` function will do all the required evaluation,
+    /// but this hook has the chance to do some pre/postprocessing.
     #[inline(always)]
     fn eval_mir_constant<F>(
         ecx: &InterpCx<'mir, 'tcx, Self>,

Original file line number	Diff line number	Diff line change
`@@ -512,6 +512,8 @@ pub trait Machine<'mir, 'tcx: 'mir>: Sized {`
`512`	`512`	`Ok(())`
`513`	`513`	`}`
`514`	`514`
	`515`	+ /// Evaluate the given constant. The `eval` function will do all the required evaluation,
	`516`	`+ /// but this hook has the chance to do some pre/postprocessing.`
`515`	`517`	`#[inline(always)]`
`516`	`518`	`fn eval_mir_constant<F>(`
`517`	`519`	`ecx: &InterpCx<'mir, 'tcx, Self>,`