summaryrefslogtreecommitdiff
path: root/library/src/visualize/image.rs
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2022-12-17 16:24:29 +0100
committerLaurenz <laurmaedje@gmail.com>2022-12-17 16:24:29 +0100
commit35b16e545b4fce299edbc00c9a9754179fa51634 (patch)
treeeb1081e55187e59ff6482abc1ac2f1932606ef59 /library/src/visualize/image.rs
parentb6202b646a0d5ecced301d9bac8bfcaf977d7ee4 (diff)
Document parameters in comment
Diffstat (limited to 'library/src/visualize/image.rs')
-rw-r--r--library/src/visualize/image.rs9
1 files changed, 8 insertions, 1 deletions
diff --git a/library/src/visualize/image.rs b/library/src/visualize/image.rs
index 936ec3bf..0ce3f20b 100644
--- a/library/src/visualize/image.rs
+++ b/library/src/visualize/image.rs
@@ -6,7 +6,14 @@ use crate::prelude::*;
/// Show a raster or vector graphic.
///
-/// Tags: visualize.
+/// Supported formats are PNG, JPEG, GIF and SVG.
+///
+/// # Parameters
+/// - path: EcoString (positional, required)
+/// Path to an image file.
+///
+/// # Tags
+/// - visualize
#[func]
#[capable(Layout, Inline)]
#[derive(Debug, Hash)]