docs: Enhance module documentation across various files for clarity a… (#62)

* docs: Enhance module documentation across various files for clarity and completeness

* fix: Remove unnecessary blank line in build.rs for cleaner code

* docs: Update documentation to improve clarity and consistency in code comments
This commit is contained in:
Eli Peter 2026-05-02 17:46:45 -04:00 committed by GitHub
parent 40995e45e7
commit 1f2bfe76c1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
44 changed files with 721 additions and 366 deletions

View file

@ -322,7 +322,7 @@ impl BoolState {
pub struct ValueFact {
/// Exact known constant (Eq constraint). `None` = unconstrained.
pub exact: Option<ConstValue>,
/// Excluded constant values (Neq constraints). Bounded by [`MAX_NEQ`].
/// Excluded constant values (Neq constraints). Bounded by `MAX_NEQ`.
pub excluded: SmallVec<[ConstValue; 4]>,
/// Inclusive lower bound (`None` = −∞).
pub lo: Option<i64>,

View file

@ -204,7 +204,7 @@ pub fn lower_condition(
/// Called during SSA lowering when the full [`SsaBody`] is not yet available.
/// Resolves variables via `var_stacks[name].last()` (the current reaching
/// definition) instead of scanning `value_defs`. Does not use `const_values`
/// (unavailable at lowering time); constants are seeded into [`PathEnv`]
/// (unavailable at lowering time); constants are seeded into [`crate::constraint::PathEnv`]
/// separately via `seed_from_optimization`.
pub fn lower_condition_with_stacks(
cond_info: &NodeInfo,

View file

@ -200,7 +200,7 @@ fn apply_value_const(env: &mut PathEnv, v: crate::ssa::ir::SsaValue, op: CompOp,
/// Resolution order:
/// 1. Cross-language primitive aliases (case-insensitive)
/// 2. Java/Ruby/Go class and framework names (case-sensitive)
/// 3. Java type hierarchy fallback (case-sensitive, via [`TypeHierarchy`])
/// 3. Java type hierarchy fallback (case-sensitive, via [`crate::ssa::type_facts::TypeHierarchy`])
pub fn parse_type_name(name: &str) -> Option<TypeKind> {
use crate::ssa::type_facts::TypeHierarchy;