diff options
| author | Laurenz <laurmaedje@gmail.com> | 2022-12-20 16:08:16 +0100 |
|---|---|---|
| committer | Laurenz <laurmaedje@gmail.com> | 2022-12-20 16:11:37 +0100 |
| commit | f5f7df7247ae29800e0290774a50942e2485beea (patch) | |
| tree | 57253ba51efdae3ac8e4eea722428924625b514c /library/src/text/misc.rs | |
| parent | b8ffd3ad3dcaebddbc674e03494e0d818b21fa51 (diff) | |
Documentation
Diffstat (limited to 'library/src/text/misc.rs')
| -rw-r--r-- | library/src/text/misc.rs | 47 |
1 files changed, 27 insertions, 20 deletions
diff --git a/library/src/text/misc.rs b/library/src/text/misc.rs index 20be156a..df40e52d 100644 --- a/library/src/text/misc.rs +++ b/library/src/text/misc.rs @@ -1,10 +1,11 @@ use super::TextNode; use crate::prelude::*; +/// # Space /// A text space. /// -/// # Tags -/// - text +/// ## Category +/// text #[func] #[capable(Unlabellable, Behave)] #[derive(Debug, Hash)] @@ -25,14 +26,15 @@ impl Behave for SpaceNode { } } +/// # Line Break /// A line break. /// -/// # Parameters +/// ## Parameters /// - justify: bool (named) /// Whether to justify the line before the break. /// -/// # Tags -/// - text +/// ## Category +/// text #[func] #[capable(Behave)] #[derive(Debug, Hash)] @@ -54,14 +56,15 @@ impl Behave for LinebreakNode { } } +/// # Strong Emphasis /// Strongly emphasizes content by increasing the font weight. /// -/// # Parameters +/// ## Parameters /// - body: Content (positional, required) /// The content to strongly emphasize. /// -/// # Tags -/// - text +/// ## Category +/// text #[func] #[capable(Show)] #[derive(Debug, Hash)] @@ -107,14 +110,15 @@ impl Fold for Delta { } } +/// # Emphasis /// Emphasizes content by flipping the italicness. /// -/// # Parameters +/// ## Parameters /// - body: Content (positional, required) /// The content to emphasize. /// -/// # Tags -/// - text +/// ## Category +/// text #[func] #[capable(Show)] #[derive(Debug, Hash)] @@ -152,27 +156,29 @@ impl Fold for Toggle { } } +/// # Lowercase /// Convert text or content to lowercase. /// -/// # Parameters +/// ## Parameters /// - text: ToCase (positional, required) /// The text to convert to lowercase. /// -/// # Tags -/// - text +/// ## Category +/// text #[func] pub fn lower(args: &mut Args) -> SourceResult<Value> { case(Case::Lower, args) } +/// # Uppercase /// Convert text or content to uppercase. /// -/// # Parameters +/// ## Parameters /// - text: ToCase (positional, required) /// The text to convert to uppercase. /// -/// # Tags -/// - text +/// ## Category +/// text #[func] pub fn upper(args: &mut Args) -> SourceResult<Value> { case(Case::Upper, args) @@ -216,14 +222,15 @@ impl Case { } } +/// # Small Capitals /// Display text in small capitals. /// -/// # Parameters +/// ## Parameters /// - text: Content (positional, required) /// The text to display to small capitals. /// -/// # Tags -/// - text +/// ## Category +/// text #[func] pub fn smallcaps(args: &mut Args) -> SourceResult<Value> { let body: Content = args.expect("content")?; |
