rei-mirrors
/
Fornjot
mirror of https://github.com/hannobraun/Fornjot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve formatting

This commit is contained in:
Hanno Braun 2022-11-05 09:38:43 +01:00
parent 097c57fa56
commit f3c3e6324c
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/fj/src/models/metadata.rs
View File

@ -4,16 +4,22 @@
pub struct Metadata { pub struct Metadata {
/// A short, human-friendly name used to identify this module. /// A short, human-friendly name used to identify this module.
pub name: String, pub name: String,
/// A semver-compliant version number. /// A semver-compliant version number.
pub version: String, pub version: String,
/// A short, one-line description. /// A short, one-line description.
pub short_description: Option<String>, pub short_description: Option<String>,
/// A more elaborate description. /// A more elaborate description.
pub description: Option<String>, pub description: Option<String>,
/// A link to the homepage. /// A link to the homepage.
pub homepage: Option<String>, pub homepage: Option<String>,
/// A link to the source code. /// A link to the source code.
pub repository: Option<String>, pub repository: Option<String>,
/// The name of the software license(s) this software is released under. /// The name of the software license(s) this software is released under.
/// ///
/// This is interpreted as a SPDX license expression (e.g. `MIT OR /// This is interpreted as a SPDX license expression (e.g. `MIT OR
@ -120,8 +126,10 @@ impl Metadata {
pub struct ModelMetadata { pub struct ModelMetadata {
/// A short, human-friendly name used to identify this model. /// A short, human-friendly name used to identify this model.
pub name: String, pub name: String,
/// A description of what this model does. /// A description of what this model does.
pub description: Option<String>, pub description: Option<String>,
/// Arguments that the model uses when calculating its geometry. /// Arguments that the model uses when calculating its geometry.
pub arguments: Vec<ArgumentMetadata>, pub arguments: Vec<ArgumentMetadata>,
} }
@ -171,9 +179,11 @@ impl ModelMetadata {
pub struct ArgumentMetadata { pub struct ArgumentMetadata {
/// The name used to refer to this argument. /// The name used to refer to this argument.
pub name: String, pub name: String,
/// A short description of this argument that could be shown to the user /// A short description of this argument that could be shown to the user
/// in something like a tooltip. /// in something like a tooltip.
pub description: Option<String>, pub description: Option<String>,
/// Something that could be used as a default if no value was provided. /// Something that could be used as a default if no value was provided.
pub default_value: Option<String>, pub default_value: Option<String>,
} }