diff options
| author | Laurenz <laurmaedje@gmail.com> | 2023-02-06 11:52:09 +0100 |
|---|---|---|
| committer | Laurenz <laurmaedje@gmail.com> | 2023-02-06 11:52:09 +0100 |
| commit | ea8edfa821f059921550c45d4f0267160b638a04 (patch) | |
| tree | 940c358e400e55bc1ba47faf7c1fa07611af5241 /src/lib.rs | |
| parent | 0bb0f1c98fc8eff5d7556bbe9d5801f02237a5c0 (diff) | |
Make Rust happier about the inline documentation
Diffstat (limited to 'src/lib.rs')
| -rw-r--r-- | src/lib.rs | 29 |
1 files changed, 16 insertions, 13 deletions
@@ -1,22 +1,25 @@ //! The compiler for the _Typst_ markup language. //! //! # Steps -//! - **Parsing:** The compiler first transforms a plain string into an -//! [iterator of tokens][tokens]. This token stream is [parsed] into a [syntax -//! tree]. The tree itself is untyped, but the [AST] module provides a typed -//! layer over it. -//! - **Evaluation:** The next step is to [evaluate] the markup. This produces a -//! [module], consisting of a scope of values that were exported by the code -//! and [content], a hierarchical, styled representation of what was written -//! in the source file. The nodes of the content tree are well structured and +//! - **Parsing:** +//! The compiler first transforms a plain string into an iterator of [tokens]. +//! This token stream is [parsed] into a [syntax tree]. The tree itself is +//! untyped, but the [AST] module provides a typed layer over it. +//! - **Evaluation:** +//! The next step is to [evaluate] the markup. This produces a [module], +//! consisting of a scope of values that were exported by the code and +//! [content], a hierarchical, styled representation of what was written in +//! the source file. The nodes of the content tree are well structured and //! order-independent and thus much better suited for further processing than //! the raw markup. -//! - **Typesetting:** Next, the content is [typeset] into a [document] -//! containing one [frame] per page with elements and fixed positions. -//! - **Exporting:** These frames can finally be exported into an output format -//! (currently supported are [PDF] and [raster images]). +//! - **Typesetting:** +//! Next, the content is [typeset] into a [document] containing one [frame] +//! per page with elements and fixed positions. +//! - **Exporting:** +//! These frames can finally be exported into an output format (currently +//! supported are [PDF] and [raster images]). //! -//! [tokens]: syntax::Tokens +//! [tokens]: syntax::SyntaxKind //! [parsed]: syntax::parse //! [syntax tree]: syntax::SyntaxNode //! [AST]: syntax::ast |
