Skip to content

Commit f507dc1

Browse files
docs: add documentation for rfl::Commented feature
- Created docs/commented.md with examples for YAML and XML. - Highlighted that comments are write-only and ignored during deserialization. - Updated mkdocs.yaml to include rfl::Commented in the navigation. - Added rfl::Commented to the feature overview in README.md. Co-authored-by: liuzicheng1987 <19538706+liuzicheng1987@users.noreply.github.com>
1 parent 05c0b40 commit f507dc1

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/commented.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The `rfl::Commented<T>` wrapper allows you to add comments to fields in your structs. These comments are then serialized in formats that support them, such as YAML and XML.
44

5-
Note that `rfl::Commented` is currently unsupported by formats that do not have a standard way of representing comments, such as JSON.
5+
Note that `rfl::Commented` is currently unsupported by formats that do not have a standard way of representing comments, such as JSON. Also note that comments are **write-only**: they are ignored during deserialization.
66

77
## Example (YAML)
88

0 commit comments

Comments
 (0)