Add documentation

mlir-rs · Dec 7, 2024 · df34017 · df34017
1 parent fcf2051
commit df34017
Showing 1 changed file with 20 additions and 8 deletions.
diff --git a/melior/src/helpers/arith.rs b/melior/src/helpers/arith.rs
@@ -31,91 +31,103 @@ pub trait ArithBlockExt<'c>: BuiltinBlockExt<'c> {
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
+    /// Creates an `arith.extui` operation.
     fn extsi(
         &self,
         lhs: Value<'c, '_>,
         target_type: Type<'c>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
+    /// Creates an `arith.extui` operation.
     fn trunci(
         &self,
         lhs: Value<'c, '_>,
         target_type: Type<'c>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
+    /// Creates an `arith.shri` operation.
     fn shrui(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
+    /// Creates an `arith.shli` operation.
     fn shli(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
+    /// Creates an `arith.addi` operation.
     fn addi(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
+    /// Creates an `arith.subi` operation.
     fn subi(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
-    fn divui(
+    /// Creates an `arith.muli` operation.
+    fn muli(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
-    fn divsi(
+    /// Creates an `arith.divui` operation.
+    fn divui(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
-    fn xori(
+    /// Creates an `arith.divsi` operation.
+    fn divsi(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
-    fn ori(
+    /// Creates an `arith.xori` operation.
+    fn xori(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
-    fn andi(
+    /// Creates an `arith.ori` operation.
+    fn ori(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
-    fn muli(
+    /// Creates an `arith.andi` operation.
+    fn andi(
         &self,
         lhs: Value<'c, '_>,
         rhs: Value<'c, '_>,
         location: Location<'c>,
     ) -> Result<Value<'c, '_>, Error>;
 
-    /// Creates a constant of the given integer bit width. Do not use for felt252.
+    /// Creates a constant of the given integer bit width.
     fn const_int<T: fmt::Display>(
         &self,
         context: &'c Context,
@@ -124,7 +136,7 @@ pub trait ArithBlockExt<'c>: BuiltinBlockExt<'c> {
         bits: u32,
     ) -> Result<Value<'c, '_>, Error>;
 
-    /// Creates a constant of the given integer type. Do not use for felt252.
+    /// Creates a constant of the given integer type.
     fn const_int_from_type<T: fmt::Display>(
         &self,
         context: &'c Context,