summaryrefslogtreecommitdiff
path: root/library/src/meta
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/meta
parentb6202b646a0d5ecced301d9bac8bfcaf977d7ee4 (diff)
Document parameters in comment
Diffstat (limited to 'library/src/meta')
-rw-r--r--library/src/meta/document.rs3
-rw-r--r--library/src/meta/link.rs9
-rw-r--r--library/src/meta/outline.rs3
-rw-r--r--library/src/meta/reference.rs7
4 files changed, 18 insertions, 4 deletions
diff --git a/library/src/meta/document.rs b/library/src/meta/document.rs
index 8c664df3..e20821c5 100644
--- a/library/src/meta/document.rs
+++ b/library/src/meta/document.rs
@@ -3,7 +3,8 @@ use crate::prelude::*;
/// The root node that represents a full document.
///
-/// Tags: meta.
+/// # Tags
+/// - meta
#[func]
#[capable(LayoutRoot)]
#[derive(Hash)]
diff --git a/library/src/meta/link.rs b/library/src/meta/link.rs
index 6f5d8af1..27294a8d 100644
--- a/library/src/meta/link.rs
+++ b/library/src/meta/link.rs
@@ -3,7 +3,14 @@ use crate::text::TextNode;
/// Link text and other elements to a destination.
///
-/// Tags: meta.
+/// # Parameters
+/// - dest: Destination (positional, required)
+/// The destination the link points to.
+/// - body: Content (positional)
+/// How the link is represented. Defaults to the destination if it is a link.
+///
+/// # Tags
+/// - meta
#[func]
#[capable(Show, Finalize)]
#[derive(Debug, Hash)]
diff --git a/library/src/meta/outline.rs b/library/src/meta/outline.rs
index 27ca5944..6ea65391 100644
--- a/library/src/meta/outline.rs
+++ b/library/src/meta/outline.rs
@@ -5,7 +5,8 @@ use crate::text::{LinebreakNode, SpaceNode, TextNode};
/// A section outline (table of contents).
///
-/// Tags: meta.
+/// # Tags
+/// - meta
#[func]
#[capable(Prepare, Show)]
#[derive(Debug, Hash)]
diff --git a/library/src/meta/reference.rs b/library/src/meta/reference.rs
index 378d19d2..c49ff970 100644
--- a/library/src/meta/reference.rs
+++ b/library/src/meta/reference.rs
@@ -3,7 +3,12 @@ use crate::text::TextNode;
/// A reference to a label.
///
-/// Tags: meta.
+/// # Parameters
+/// - target: Label (positional, required)
+/// The label that should be referenced.
+///
+/// # Tags
+/// - meta
#[func]
#[capable(Show)]
#[derive(Debug, Hash)]