rustdoc_demo/
lib.rs

1//! This is used to demo all the rustdoc features
2//!
3//! # Example
4//!
5//! ```
6//! assert_eq!(4, 2 + 2);
7//! ```
8
9mod world_mod {
10    #[derive(Debug)]
11    pub struct WorldStruct {
12        i: usize,
13    }
14    impl WorldStruct {
15        pub fn new() -> WorldStruct {
16            WorldStruct { i: rand::random() }
17        }
18    }
19}
20
21pub use rand;
22pub use sudo as super_user;
23pub use world_mod::WorldStruct as World;
24
25pub fn main() {
26    let world = World::new();
27    println!("Hello, {:?}!", world);
28}
29
30pub fn another() {
31    todo!()
32}
33pub fn before() {
34    unimplemented!()
35}
36pub fn chained() {
37    unimplemented!()
38}
39
40/// short description
41pub fn short() {
42    unimplemented!()
43}
44/// tested description
45///
46/// ```
47/// assert!(true);
48/// ```
49pub fn tested() {
50    unimplemented!()
51}
52
53/// One Two Three Four Five Six Seven Eight Nine Ten Eleven Twelve Thirteen Fourteen Fifteen Sixteen Seventeen Eighteen Nineteen Twenty
54pub fn text_that_is_longer() {
55    unimplemented!()
56}
57
58/// Closing Text
59pub fn quit() {
60    unimplemented!()
61}