1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
//! Create nice greatings.
//!
//! Greetings are very important for [humans][Human]. They signal the beginning of an interaction and enable
//! further conversation that can lead to productive results. Greetings are therefore a highly
//! important topic.
//!
//! # More `rustdoc` features!
//!
//! If you want to document a specific item, you use the `///` comments
//! (that is: 3 instead of 2 slashes) to document the *next* item.
//! Check out the `greet` function below
//! and look at the source to see how the documentation is written.
use crateHuman;
/// Generate a friendly greeting message
///
/// This function currently only supports english greetings.
/// Future versions might be expanded to change this.
///
/// *(reminder: check out the source code of the documentation)*
///
/// # Code Examples
///
/// ## A lovely conversation between cryptography enthusiasts
/// ```
/// use wonderful_rustdoc::greetings::greet;
/// use wonderful_rustdoc::beings::Human;
///
/// let alice = Human{name: "Alice".into(), age: 20};
/// let bob = Human{name: "Bob".into(), age: 20};
/// let eve = Human{name: "Eve".into(), age: 7};
///
/// println!("It is a sunny summer day in Cryptoville.");
/// println!("{} sits in the bush and listens to the conversation that {} and {} have.", eve.name, alice.name, bob.name);
/// println!("Alice: {}", greet(&bob));
/// println!("Bob: {}", greet(&alice));
/// ```
///
/// # Reading on
///
/// `rustdoc` automatically links type arguments in the documentation.
/// Have a look at the `Human` type, by clicking on the link in the API line!