add file docs

This commit is contained in:
collin 2020-04-20 18:52:39 -07:00
parent 9bf0dc9a4a
commit ff4fc0cc20
8 changed files with 48 additions and 0 deletions

View File

@ -1,3 +1,9 @@
//! Methods to enforce constraints on booleans in a resolved aleo program.
//!
//! @file boolean.rs
//! @author Collin Chin <collin@aleo.org>
//! @date 2020
use crate::aleo_program::constraints::{new_scope_from_variable, ResolvedProgram, ResolvedValue};
use crate::aleo_program::{BooleanExpression, BooleanSpreadOrExpression, Variable};

View File

@ -1,3 +1,9 @@
//! Methods to enforce constraints a resolved aleo program.
//!
//! @file constraints.rs
//! @author Collin Chin <collin@aleo.org>
//! @date 2020
use crate::aleo_program::constraints::{new_scope_from_variable, ResolvedProgram, ResolvedValue};
use crate::aleo_program::{Expression, Function, Import, Program, Statement, Type};
use crate::ast;

View File

@ -1,3 +1,9 @@
//! Methods to enforce constraints on expressions in a resolved aleo program.
//!
//! @file expression.rs
//! @author Collin Chin <collin@aleo.org>
//! @date 2020
use crate::aleo_program::constraints::{new_scope_from_variable, ResolvedProgram, ResolvedValue};
use crate::aleo_program::{
Expression, IntegerExpression, IntegerRangeOrExpression, StructMember, Variable,

View File

@ -1,3 +1,9 @@
//! Methods to enforce constraints on field elements in a resolved aleo program.
//!
//! @file field_element.rs
//! @author Collin Chin <collin@aleo.org>
//! @date 2020
use crate::aleo_program::constraints::{new_scope_from_variable, ResolvedProgram, ResolvedValue};
use crate::aleo_program::{FieldExpression, FieldSpreadOrExpression, Variable};

View File

@ -1,3 +1,9 @@
//! Methods to enforce constraints on integers in a resolved aleo program.
//!
//! @file integer.rs
//! @author Collin Chin <collin@aleo.org>
//! @date 2020
use crate::aleo_program::constraints::{new_scope_from_variable, ResolvedProgram, ResolvedValue};
use crate::aleo_program::{Integer, IntegerExpression, IntegerSpreadOrExpression, Variable};

View File

@ -1,3 +1,9 @@
//! An in memory store to keep track of defined names when constraining an aleo program.
//!
//! @file resolved_program.rs
//! @author Collin Chin <collin@aleo.org>
//! @date 2020
use crate::aleo_program::constraints::ResolvedValue;
use crate::aleo_program::types::Variable;

View File

@ -1,3 +1,9 @@
//! The in memory stored value for a defined name in a resolved aleo program.
//!
//! @file resolved_value.rs
//! @author Collin Chin <collin@aleo.org>
//! @date 2020
use crate::aleo_program::types::{Function, Struct, StructMember, Variable};
use snarkos_models::curves::{Field, PrimeField};

View File

@ -1,3 +1,9 @@
//! Methods to enforce constraints on statements in a resolved aleo program.
//!
//! @file statement.rs
//! @author Collin Chin <collin@aleo.org>
//! @date 2020
use crate::aleo_program::constraints::{new_scope_from_variable, ResolvedProgram, ResolvedValue};
use crate::aleo_program::{
Assignee, Expression, IntegerExpression, IntegerRangeOrExpression, Statement, Variable,