ZJIT: Add missing module doc comments

Author: aidenfoxivey

zjit/src/asm/mod.rs

@@ -1,3 +1,5 @@
+//! Model for creating generating textual assembler code.
+
 use std::collections::BTreeMap;
 use std::fmt;
 use std::ops::Range;

zjit/src/backend/mod.rs

@@ -1,3 +1,5 @@
+//! A multi-platform assembler generation backend.
+
 #[cfg(target_arch = "x86_64")]
 pub mod x86_64;
 

zjit/src/bitset.rs

@@ -1,3 +1,5 @@
+//! Optimized bitset implementation.
+
 type Entry = u128;
 
 const ENTRY_NUM_BITS: usize = Entry::BITS as usize;

zjit/src/cast.rs

@@ -1,3 +1,5 @@
+//! Optimized [usize] casting trait.
+
 /// Trait for casting to [usize] that allows you to say `.as_usize()`.
 /// Implementation conditional on the cast preserving the numeric value on
 /// all inputs and being inexpensive.

zjit/src/codegen.rs

@@ -1,3 +1,5 @@
+//! This module is for native code generation.
+
 use std::cell::{Cell, RefCell};
 use std::rc::Rc;
 use std::ffi::{c_int, c_long, c_void};

zjit/src/distribution.rs

@@ -1,3 +1,5 @@
+//! Type frequency distribution tracker.
+
 /// This implementation was inspired by the type feedback module from Google's S6, which was
 /// written in C++ for use with Python. This is a new implementation in Rust created for use with
 /// Ruby instead of Python.

zjit/src/gc.rs

@@ -1,4 +1,4 @@
-// This module is responsible for marking/moving objects on GC.
+//! This module is responsible for marking/moving objects on GC.
 
 use std::cell::RefCell;
 use std::rc::Rc;

zjit/src/hir_type/mod.rs

@@ -1,3 +1,5 @@
+//! High-level intermediate representation types.
+
 #![allow(non_upper_case_globals)]
 use crate::cruby::{Qfalse, Qnil, Qtrue, VALUE, RUBY_T_ARRAY, RUBY_T_STRING, RUBY_T_HASH, RUBY_T_CLASS, RUBY_T_MODULE};
 use crate::cruby::{rb_cInteger, rb_cFloat, rb_cArray, rb_cHash, rb_cString, rb_cSymbol, rb_cObject, rb_cTrueClass, rb_cFalseClass, rb_cNilClass, rb_cRange, rb_cSet, rb_cRegexp, rb_cClass, rb_cModule, rb_zjit_singleton_class_p};

zjit/src/invariants.rs

@@ -1,3 +1,5 @@
+//! Code invalidation and patching for speculative optimizations.
+
 use std::{collections::{HashMap, HashSet}, mem};
 
 use crate::{backend::lir::{asm_comment, Assembler}, cruby::{rb_callable_method_entry_t, rb_gc_location, ruby_basic_operators, src_loc, with_vm_lock, IseqPtr, RedefinitionFlag, ID, VALUE}, gc::IseqPayload, hir::Invariant, options::debug, state::{zjit_enabled_p, ZJITState}, virtualmem::CodePtr};

zjit/src/options.rs

@@ -1,3 +1,5 @@
+//! Configurable options for ZJIT.
+
 use std::{ffi::{CStr, CString}, ptr::null};
 use std::os::raw::{c_char, c_int, c_uint};
 use crate::cruby::*;