Adjust documentation

boa-dev · Dec 19, 2022 · 42446ba · 42446ba
1 parent 7194994
commit 42446ba
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 46 deletions.
diff --git a/boa_ast/src/lib.rs b/boa_ast/src/lib.rs
@@ -1,4 +1,4 @@
-//! Boa's **boa_ast** crate implements an ECMAScript abstract syntax tree.
+//! Boa's **`boa_ast`** crate implements an ECMAScript abstract syntax tree.
 //!
 //! # Crate Overview
 //! **boa_ast** contains representations of [**Parse Nodes**][grammar] as defined by the ECMAScript
@@ -19,11 +19,12 @@
 //! # Boa Crates
 //!  - **boa_ast** - Boa's ECMAScript Abstract Syntax Tree.
 //!  - **boa_engine** - Boa's implementation of ECMAScript builtin objects and execution.
-//!  - **boa_gc** - Boa's garbage collector
-//!  - **boa_interner** - Boa's string interner
-//!  - **boa_parser** - Boa's lexer and parser
-//!  - **boa_profiler** - Boa's code profiler
-//!  - **boa_unicode** - Boa's Unicode identifier
+//!  - **boa_gc** - Boa's garbage collector.
+//!  - **boa_interner** - Boa's string interner.
+//!  - **boa_parser** - Boa's lexer and parser.
+//!  - **boa_profiler** - Boa's code profiler.
+//!  - **boa_unicode** - Boa's Unicode identifier.
+//!  - **boa_icu_provider** - Boa's ICU4X data provider.
 //!
 //! [grammar]: https://tc39.es/ecma262/#sec-syntactic-grammar
 //! [early]: https://tc39.es/ecma262/#sec-static-semantic-rules

diff --git a/boa_cli/Cargo.toml b/boa_cli/Cargo.toml
@@ -12,7 +12,7 @@ repository.workspace = true
 rust-version.workspace = true
 
 [dependencies]
-boa_engine = { workspace = true, features = ["deser", "console", "flowgraph"] }
+boa_engine = { workspace = true, features = ["deser", "console", "flowgraph", "intl"] }
 boa_ast = { workspace = true, features = ["serde"]}
 boa_parser.workspace = true
 rustyline = "10.0.0"

diff --git a/boa_engine/src/lib.rs b/boa_engine/src/lib.rs
@@ -1,4 +1,4 @@
-//! Boa's **boa_engine** crate implements ECMAScript's standard library of builtin objects
+//! Boa's **`boa_engine`** crate implements ECMAScript's standard library of builtin objects
 //! and an ECMAScript context, bytecompiler, and virtual machine for code execution.
 //!
 //! # Crate Features
@@ -16,11 +16,12 @@
 //! # Boa Crates
 //!  - **boa_ast** - Boa's ECMAScript Abstract Syntax Tree.
 //!  - **boa_engine** - Boa's implementation of ECMAScript builtin objects and execution.
-//!  - **boa_gc** - Boa's garbage collector
-//!  - **boa_interner** - Boa's string interner
-//!  - **boa_parser** - Boa's lexer and parser
-//!  - **boa_profiler** - Boa's code profiler
-//!  - **boa_unicode** - Boa's Unicode identifier
+//!  - **boa_gc** - Boa's garbage collector.
+//!  - **boa_interner** - Boa's string interner.
+//!  - **boa_parser** - Boa's lexer and parser.
+//!  - **boa_profiler** - Boa's code profiler.
+//!  - **boa_unicode** - Boa's Unicode identifier.
+//!  - **boa_icu_provider** - Boa's ICU4X data provider.
 //!
 //! [whatwg]: https://console.spec.whatwg.org
 //! [ecma-402]: https://tc39.es/ecma402

diff --git a/boa_gc/src/lib.rs b/boa_gc/src/lib.rs
@@ -1,4 +1,4 @@
-//! Boa's **boa_gc** crate implements a garbage collector.
+//! Boa's **`boa_gc`** crate implements a garbage collector.
 //!
 //! # Crate Overview
 //! **boa_gc** is a mark-sweep garbage collector that implements a Trace and Finalize trait
@@ -13,11 +13,12 @@
 //! # Boa Crates
 //!  - **boa_ast** - Boa's ECMAScript Abstract Syntax Tree.
 //!  - **boa_engine** - Boa's implementation of ECMAScript builtin objects and execution.
-//!  - **boa_gc** - Boa's garbage collector
-//!  - **boa_interner** - Boa's string interner
-//!  - **boa_parser** - Boa's lexer and parser
-//!  - **boa_profiler** - Boa's code profiler
-//!  - **boa_unicode** - Boa's Unicode identifier
+//!  - **boa_gc** - Boa's garbage collector.
+//!  - **boa_interner** - Boa's string interner.
+//!  - **boa_parser** - Boa's lexer and parser.
+//!  - **boa_profiler** - Boa's code profiler.
+//!  - **boa_unicode** - Boa's Unicode identifier.
+//!  - **boa_icu_provider** - Boa's ICU4X data provider.
 //!
 //! [boa-conformance]: https://boa-dev.github.io/boa/test262/
 //! [boa-web]: https://boa-dev.github.io/

diff --git a/boa_icu_provider/src/lib.rs b/boa_icu_provider/src/lib.rs
@@ -1,5 +1,4 @@
-//! Boa's **boa_icu_provider** crate contains the default data provider used by its `Intl`
-//! implementation.
+//! Boa's **`boa_icu_provider`** exports the default data provider used by its `Intl` implementation.
 //!
 //! # Crate Overview
 //! This crate exports the function [`blob`], which contains an extensive dataset of locale data to

diff --git a/boa_interner/src/lib.rs b/boa_interner/src/lib.rs
@@ -1,4 +1,4 @@
-//! Boa's **boa_interner** is a string interner for compiler performance.
+//! Boa's **`boa_interner`** is a string interner for compiler performance.
 //!
 //! # Crate Overview
 //! The idea behind using a string interner is that in most of the code, strings such as
@@ -18,11 +18,12 @@
 //! # Boa Crates
 //!  - **boa_ast** - Boa's ECMAScript Abstract Syntax Tree.
 //!  - **boa_engine** - Boa's implementation of ECMAScript builtin objects and execution.
-//!  - **boa_gc** - Boa's garbage collector
-//!  - **boa_interner** - Boa's string interner
-//!  - **boa_parser** - Boa's lexer and parser
-//!  - **boa_profiler** - Boa's code profiler
-//!  - **boa_unicode** - Boa's Unicode identifier
+//!  - **boa_gc** - Boa's garbage collector.
+//!  - **boa_interner** - Boa's string interner.
+//!  - **boa_parser** - Boa's lexer and parser.
+//!  - **boa_profiler** - Boa's code profiler.
+//!  - **boa_unicode** - Boa's Unicode identifier.
+//!  - **boa_icu_provider** - Boa's ICU4X data provider.
 //!
 //! [boa-conformance]: https://boa-dev.github.io/boa/test262/
 //! [boa-web]: https://boa-dev.github.io/

diff --git a/boa_parser/src/lib.rs b/boa_parser/src/lib.rs
@@ -1,4 +1,4 @@
-//! Boa's **boa_parser** crate is a parser targeting the latest [ECMAScript language specification][spec].
+//! Boa's **`boa_parser`** crate is a parser targeting the latest [ECMAScript language specification][spec].
 //!
 //! # Crate Overview
 //! This crate contains implementations of a [`Lexer`] and a [`Parser`] for the **ECMAScript**
@@ -14,11 +14,12 @@
 //! # Boa Crates
 //!  - **boa_ast** - Boa's ECMAScript Abstract Syntax Tree.
 //!  - **boa_engine** - Boa's implementation of ECMAScript builtin objects and execution.
-//!  - **boa_gc** - Boa's garbage collector
-//!  - **boa_interner** - Boa's string interner
-//!  - **boa_parser** - Boa's lexer and parser
-//!  - **boa_profiler** - Boa's code profiler
-//!  - **boa_unicode** - Boa's Unicode identifier
+//!  - **boa_gc** - Boa's garbage collector.
+//!  - **boa_interner** - Boa's string interner.
+//!  - **boa_parser** - Boa's lexer and parser.
+//!  - **boa_profiler** - Boa's code profiler.
+//!  - **boa_unicode** - Boa's Unicode identifier.
+//!  - **boa_icu_provider** - Boa's ICU4X data provider.
 //!
 //! [spec]: https://tc39.es/ecma262
 //! [lex]: https://tc39.es/ecma262/#sec-ecmascript-language-lexical-grammar

diff --git a/boa_profiler/src/lib.rs b/boa_profiler/src/lib.rs
@@ -11,13 +11,14 @@
 //! Try out the most recent release with Boa's live demo [playground][boa-playground].  
 //!
 //! # Boa Crates
-//!  - **`boa_ast`** - Boa's ECMAScript Abstract Syntax Tree.
-//!  - **`boa_engine`** - Boa's implementation of ECMAScript builtin objects and execution.
-//!  - **`boa_gc`** - Boa's garbage collector
-//!  - **`boa_interner`** - Boa's string interner
-//!  - **`boa_parser`** - Boa's lexer and parser
-//!  - **`boa_profiler`** - Boa's code profiler
-//!  - **`boa_unicode`** - Boa's Unicode identifier
+//!  - **boa_ast** - Boa's ECMAScript Abstract Syntax Tree.
+//!  - **boa_engine** - Boa's implementation of ECMAScript builtin objects and execution.
+//!  - **boa_gc** - Boa's garbage collector.
+//!  - **boa_interner** - Boa's string interner.
+//!  - **boa_parser** - Boa's lexer and parser.
+//!  - **boa_profiler** - Boa's code profiler.
+//!  - **boa_unicode** - Boa's Unicode identifier.
+//!  - **boa_icu_provider** - Boa's ICU4X data provider.
 //!
 //! [profiler-md]: https://github.com/boa-dev/boa/blob/main/docs/profiling.md
 //! [boa-conformance]: https://boa-dev.github.io/boa/test262/

diff --git a/boa_unicode/src/lib.rs b/boa_unicode/src/lib.rs
@@ -1,4 +1,4 @@
-//! Boa's **boa_unicode** crate for query valid Unicode identifiers.
+//! Boa's **`boa_unicode`** crate for query valid Unicode identifiers.
 //!
 //! # Crate Overview
 //! This crate implements the extension to query if a char belongs to a particular unicode identifier property.
@@ -18,11 +18,12 @@
 //! # Boa Crates
 //!  - **boa_ast** - Boa's ECMAScript Abstract Syntax Tree.
 //!  - **boa_engine** - Boa's implementation of ECMAScript builtin objects and execution.
-//!  - **boa_gc** - Boa's garbage collector
-//!  - **boa_interner** - Boa's string interner
-//!  - **boa_parser** - Boa's lexer and parser
-//!  - **boa_profiler** - Boa's code profiler
-//!  - **boa_unicode** - Boa's Unicode identifier
+//!  - **boa_gc** - Boa's garbage collector.
+//!  - **boa_interner** - Boa's string interner.
+//!  - **boa_parser** - Boa's lexer and parser.
+//!  - **boa_profiler** - Boa's code profiler.
+//!  - **boa_unicode** - Boa's Unicode identifier.
+//!  - **boa_icu_provider** - Boa's ICU4X data provider.
 //!
 //! [uax31]: http://unicode.org/reports/tr31
 //! [boa-conformance]: https://boa-dev.github.io/boa/test262/