diff options
| author | Fuwn <[email protected]> | 2022-06-02 04:08:07 +0000 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2022-06-02 04:08:07 +0000 |
| commit | 4ec58d54486f89f329365b715198910abaa08fc1 (patch) | |
| tree | c79f4be1ef309ef3bc04c3fe6d2d58825980b84a /src | |
| parent | feat(germ): ast struct (diff) | |
| download | germ-4ec58d54486f89f329365b715198910abaa08fc1.tar.xz germ-4ec58d54486f89f329365b715198910abaa08fc1.zip | |
docs(ast): add comment to ast struct
Diffstat (limited to 'src')
| -rw-r--r-- | src/ast.rs | 11 |
1 files changed, 9 insertions, 2 deletions
@@ -174,6 +174,13 @@ pub enum Node { Whitespace, } +/// An AST structure which contains an AST tree +/// +/// # Example +/// +/// ```rust +/// let _ = germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#); +/// ``` pub struct Ast { inner: Vec<Node>, } @@ -213,8 +220,8 @@ impl Ast { /// # Example /// /// ```rust - /// - /// let _ = germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#).inner(); + /// let _ = + /// germ::ast::Ast::from_string(r#"=> gemini://gem.rest/ GemRest"#).inner(); /// ``` #[must_use] pub const fn inner(&self) -> &Vec<Node> { &self.inner } |