config-docs 0.1.0

A trait and derive macro to generate documentation for your structs
Documentation 
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
47
48
49
50
51
52
53

//! # Config Docs
//!
//! This crate adds a trait with a derive macro to create a documentation for your struct in code.
//! This is useful for things like configuration objects that should be documented in your app.
//!
//!
//! ## Disclaimer
//! This project came into place for a small project I'm working on and is in no means perfect. If
//! you have any suggestions, please consider contributing on [Github](https://github.com/Ceedrich/config_docs)
//!
//! ## Usage Example
//! ```
//! use config_docs::ConfigDocs;
//!
//! #[derive(ConfigDocs)]
//! struct Config {
//!     /// Holds the colors for your app
//!     colors: ColorConfig,
//!     /// Holds the keybinds for your app
//!     keybinds: KeybindConfig,
//! }
//!
//! #[derive(ConfigDocs)]
//! struct ColorConfig {
//!     /// The foreground color for your app as a hex value
//!     fg: String,
//!     /// The background color for your app as a hex value
//!     bg: String,
//! }
//!
//! #[derive(ConfigDocs)]
//! struct KeybindConfig {
//!     /// Show the help inside your app
//!     help: String,
//!     /// Quit your app
//!     quit: String
//! }
//!
//! assert_eq!(Config::config_docs(), &[
//!     ("colors", "Holds the colors for your app"),
//!     ("fg", "The foreground color for your app as a hex value"),
//!     ("bg", "The background color for your app as a hex value"),
//!     ("keybinds", "Holds the keybinds for your app"),
//!     ("help", "Show the help inside your app"),
//!     ("quit", "Quit your app")
//! ])
//! ```
//!

mod config_docs;

pub use config_docs::*;
pub use config_docs_macros::ConfigDocs;