summaryrefslogtreecommitdiff
path: root/src/model/func.rs
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2022-12-19 01:16:35 +0100
committerLaurenz <laurmaedje@gmail.com>2022-12-19 01:16:35 +0100
commitb4b022940b908d8fe490b9f4f68bc60dcfb76cd2 (patch)
treebc93a2f51295f97f971466ab87bdd763c0ed6002 /src/model/func.rs
parentba384e5bb6c2455eb431f6e1fcc8b98aca1e9879 (diff)
Syntax and example sections
Diffstat (limited to 'src/model/func.rs')
-rw-r--r--src/model/func.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/model/func.rs b/src/model/func.rs
index 46befd77..fb8b3dd0 100644
--- a/src/model/func.rs
+++ b/src/model/func.rs
@@ -214,6 +214,10 @@ pub struct FuncInfo {
pub tags: &'static [&'static str],
/// Documentation for the function.
pub docs: &'static str,
+ /// The source code of an example, if any.
+ pub example: Option<&'static str>,
+ /// Documentation about this function's syntax, if it has syntax.
+ pub syntax: Option<&'static str>,
/// Details about the function's parameters.
pub params: Vec<ParamInfo>,
}
@@ -232,6 +236,8 @@ pub struct ParamInfo {
pub name: &'static str,
/// Documentation for the parameter.
pub docs: &'static str,
+ /// The source code of an example, if any.
+ pub example: Option<&'static str>,
/// Valid values for the parameter.
pub cast: CastInfo,
/// Is the parameter positional?