Skip to content

Commit

Permalink
bumped version and updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cptpiepmatz committed Nov 19, 2023
1 parent 8e40fc6 commit 25208fb
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "static-toml"
version = "1.0.1"
version = "1.1.0"
edition = "2021"
authors = ["Tim 'Piepmatz' Hesse"]
exclude = [".github/"]
Expand Down
13 changes: 13 additions & 0 deletions doc/crate.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,19 @@ You can configure the [`static_toml!`] macro call by applying a
every array.
By default, this is set to `true`.

<br>

- `#[static_toml(auto_doc = true)]`

By default, the macro generates documentation comments, including the file
location and contents, enhancing visibility in the generated docs.
Setting `auto_doc` to `true` ensures auto-generated documentation is appended
after any existing manual comments.
Conversely, setting it to `false` disables automatic documentation generation,
which may result in the static item lacking documentation comments.
This feature is particularly useful for easily accessing TOML contents within
rustdoc.

You can combine attributes as follows:
```rust
static_toml::static_toml! {
Expand Down

0 comments on commit 25208fb

Please sign in to comment.