diff options
| author | Laurenz <laurmaedje@gmail.com> | 2022-12-17 16:24:29 +0100 |
|---|---|---|
| committer | Laurenz <laurmaedje@gmail.com> | 2022-12-17 16:24:29 +0100 |
| commit | 35b16e545b4fce299edbc00c9a9754179fa51634 (patch) | |
| tree | eb1081e55187e59ff6482abc1ac2f1932606ef59 /library/src/text/raw.rs | |
| parent | b6202b646a0d5ecced301d9bac8bfcaf977d7ee4 (diff) | |
Document parameters in comment
Diffstat (limited to 'library/src/text/raw.rs')
| -rw-r--r-- | library/src/text/raw.rs | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/library/src/text/raw.rs b/library/src/text/raw.rs index 125a5da1..74626588 100644 --- a/library/src/text/raw.rs +++ b/library/src/text/raw.rs @@ -8,14 +8,21 @@ use crate::prelude::*; /// Raw text with optional syntax highlighting. /// -/// Tags: text. +/// # Parameters +/// - text: EcoString (positional, required) +/// The raw text. +/// - block: bool (named) +/// Whether the raw text is displayed as a separate block. +/// +/// # Tags +/// - text #[func] #[capable(Show)] #[derive(Debug, Hash)] pub struct RawNode { /// The raw text. pub text: EcoString, - /// Whether the node is block-level. + /// Whether the raw text is displayed as a separate block. pub block: bool, } |
