Include documentation in printed config files (#41)

* Start work on printing toml config with comments

* WIP: toml_config: extract default values for fields

* WIP: toml_config: handle single-level nested structs

* WIP: toml_config: improve comment handling, std type trait impls

* WIP: toml_config: add Private trait, improve comment handling, clean up

* toml_config: fix default value bug; improve tests

* Use toml_config in all applicable crates; add toml_config enum support

* toml_config: improve comments

* toml_config_derive: support enum comments

* Improve config comments for udp, cli_helpers, common

* Improve config comments

* Add tests for Config struct TomlConfig implementations

* Improve Config comments

* Improve Config comments

* ws, http: add config comments for tls cert and private key lines

* small fixes to toml_config and toml_config_derive

* Run cargo fmt

* Fix typo in several config comments

* Update README

* Update README
This commit is contained in:
Joakim Frostegård 2021-12-26 11:33:27 +01:00 committed by GitHub
parent d694785244
commit a208775104
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
28 changed files with 581 additions and 92 deletions

View file

@ -14,6 +14,8 @@ members = [
"aquatic_ws",
"aquatic_ws_load_test",
"aquatic_ws_protocol",
"toml_config",
"toml_config_derive",
]
[patch.crates-io]
@ -30,6 +32,8 @@ aquatic_udp_protocol = { path = "aquatic_udp_protocol" }
aquatic_ws = { path = "aquatic_ws" }
aquatic_ws_load_test = { path = "aquatic_ws_load_test" }
aquatic_ws_protocol = { path = "aquatic_ws_protocol" }
toml_config = { path = "toml_config" }
toml_config_derive = { path = "toml_config_derive" }
[profile.release]
debug = true