dan/oxc
1
0
Fork 0
mirror of https://github.com/danbulant/oxc synced 2026-05-19 04:08:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(semantic): fix and reformat doc comments (#8652)

Browse source 
Update doc comment for `TempUnresolvedReferences` which was out of date. Reformat other comments.
This commit is contained in:
overlookmotel 2025-01-22 12:22:27 +00:00
parent 9953ac7cad
commit 50295474cc
1 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
crates/oxc_semantic/src/unresolved_stack.rs
View file

@ -4,7 +4,8 @@ use rustc_hash::FxHashMap;
use oxc_span::Atom;
use oxc_syntax::reference::ReferenceId;
/// The difference with Scope's `UnresolvedReferences` is that this type uses Atom as the key. its clone is very cheap!
/// Unlike `ScopeTree`'s `UnresolvedReferences`, this type uses `Atom` as the key,
/// and uses a heap-allocated hashmap (not arena-allocated)
type TempUnresolvedReferences<'a> = FxHashMap<Atom<'a>, Vec<ReferenceId>>;
// Stack used to accumulate unresolved refs while traversing scopes.
@ -21,16 +22,19 @@ pub(crate) struct UnresolvedReferencesStack<'a> {
}
impl<'a> UnresolvedReferencesStack<'a> {
// Initial scope depth.
// Start on 1 (`Program` scope depth).
// SAFETY: Must be >= 1 to ensure soundness of `current_and_parent_mut`.
/// Initial scope depth.
/// Start on 1 (`Program` scope depth).
/// SAFETY: Must be >= 1 to ensure soundness of `current_and_parent_mut`.
const INITIAL_DEPTH: usize = 1;
// Most programs will have at least 1 place where scope depth reaches 16,
// so initialize `stack` with this length, to reduce reallocations as it grows.
// This is just an estimate of a good initial size, but certainly better than
// `Vec`'s default initial capacity of 4.
// SAFETY: Must be >= 2 to ensure soundness of `current_and_parent_mut`.
/// Most programs will have at least 1 place where scope depth reaches 16,
/// so initialize `stack` with this length, to reduce reallocations as it grows.
/// This is just an estimate of a good initial size, but certainly better than
/// `Vec`'s default initial capacity of 4.
/// SAFETY: Must be >= 2 to ensure soundness of `current_and_parent_mut`.
const INITIAL_SIZE: usize = 16;
/// Assert invariant
#[allow(clippy::assertions_on_constants)]
const _SIZE_CHECK: () = assert!(Self::INITIAL_SIZE > Self::INITIAL_DEPTH);