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/visualize | |
| parent | b8ffd3ad3dcaebddbc674e03494e0d818b21fa51 (diff) | |
Documentation
Diffstat (limited to 'library/src/visualize')
| -rw-r--r-- | library/src/visualize/image.rs | 7 | ||||
| -rw-r--r-- | library/src/visualize/line.rs | 7 | ||||
| -rw-r--r-- | library/src/visualize/shape.rs | 7 |
3 files changed, 12 insertions, 9 deletions
diff --git a/library/src/visualize/image.rs b/library/src/visualize/image.rs index 0ce3f20b..a3eb32a5 100644 --- a/library/src/visualize/image.rs +++ b/library/src/visualize/image.rs @@ -4,16 +4,17 @@ use typst::image::{Image, ImageFormat, RasterFormat, VectorFormat}; use crate::prelude::*; +/// # Image /// Show a raster or vector graphic. /// /// Supported formats are PNG, JPEG, GIF and SVG. /// -/// # Parameters +/// ## Parameters /// - path: EcoString (positional, required) /// Path to an image file. /// -/// # Tags -/// - visualize +/// ## Category +/// visualize #[func] #[capable(Layout, Inline)] #[derive(Debug, Hash)] diff --git a/library/src/visualize/line.rs b/library/src/visualize/line.rs index 6c60ef4e..7fed90ce 100644 --- a/library/src/visualize/line.rs +++ b/library/src/visualize/line.rs @@ -1,10 +1,11 @@ use crate::prelude::*; +/// # Line /// Display a line without affecting the layout. /// /// You should only provide either an endpoint or an angle and a length. /// -/// # Parameters +/// ## Parameters /// - origin: Axes<Rel<Length>> (named) /// The start point of the line. /// @@ -17,8 +18,8 @@ use crate::prelude::*; /// - angle: Angle (named) /// The angle at which the line points away from the origin. /// -/// # Tags -/// - visualize +/// ## Category +/// visualize #[func] #[capable(Layout, Inline)] #[derive(Debug, Hash)] diff --git a/library/src/visualize/shape.rs b/library/src/visualize/shape.rs index 9c66e867..5edab70b 100644 --- a/library/src/visualize/shape.rs +++ b/library/src/visualize/shape.rs @@ -2,9 +2,10 @@ use std::f64::consts::SQRT_2; use crate::prelude::*; +/// # Rectangle /// A sizable and fillable shape with optional content. /// -/// # Parameters +/// ## Parameters /// - body: Content (positional) /// The content to place into the shape. /// @@ -23,8 +24,8 @@ use crate::prelude::*; /// - stroke: Smart<Sides<Option<PartialStroke>>> (named) /// How to stroke the shape. /// -/// # Tags -/// - visualize +/// ## Category +/// visualize #[func] #[capable(Layout, Inline)] #[derive(Debug, Hash)] |