diff options
| author | Matthias Beyer <mail@beyermatthias.de> | 2018-04-16 10:33:17 +0200 |
|---|---|---|
| committer | Matthias Beyer <mail@beyermatthias.de> | 2018-04-16 10:53:23 +0200 |
| commit | 816708a1aa25f08a7e7407be1191798364f1b8f6 (patch) | |
| tree | 32d689fa1fadc64ba7dd7858eeeb2e89e8680209 /lib | |
| parent | 8928f9cb9445d9fbdfae2612b399fc780faa50d2 (diff) | |
Add documentation for type
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/domain/libimagwiki/src/wiki.rs | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/domain/libimagwiki/src/wiki.rs b/lib/domain/libimagwiki/src/wiki.rs index acf4fd08..50ef61cd 100644 --- a/lib/domain/libimagwiki/src/wiki.rs +++ b/lib/domain/libimagwiki/src/wiki.rs @@ -35,6 +35,15 @@ use error::Result; pub struct Wiki<'a, 'b>(&'a Store, &'b str); +/// An interface for accessing, creating and deleting "wiki pages" +/// +/// Wiki pages are normal entries with some details added. +/// +/// +/// # Details +/// +/// Entries are automatically linked to the "index" page when created and retrieved. +/// impl<'a, 'b> Wiki<'a, 'b> { pub(crate) fn new(store: &'a Store, name: &'b str) -> Wiki<'a, 'b> { |