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

Update doc comments

This commit is contained in:
Hanno Braun 2022-11-05 09:25:36 +01:00
parent cf7043a723
commit 097c57fa56
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/fj/src/models/context.rs
View File

@ -1,7 +1,5 @@
/// Contextual information passed to a [`Model`][crate::models::Model] when it /// Contextual information passed to a [`Model`][crate::models::Model] when it
/// is being initialized. /// is being initialized.
///
/// Check out the [`ContextExt`] trait for some helper methods.
pub trait Context { pub trait Context {
/// Get an argument that was passed to this model. /// Get an argument that was passed to this model.
fn get_argument(&self, name: &str) -> Option<&str>; fn get_argument(&self, name: &str) -> Option<&str>;

2
crates/fj/src/models/host.rs
View File

@ -11,6 +11,8 @@ pub trait Host {
} }
/// Extension methods to augment the [`Host`] API. /// Extension methods to augment the [`Host`] API.
///
/// The purpose of this trait is to keep [`Host`] object-safe.
pub trait HostExt { pub trait HostExt {
/// Register a model with the Fornjot runtime. /// Register a model with the Fornjot runtime.
fn register_model<M>(&mut self, model: M) fn register_model<M>(&mut self, model: M)