Merge pull request #734 from eZioPan/readable-field-doc

let readable field fetch doc from svd description
rust-embedded · Jun 9, 2023 · 5fa99aa · 5fa99aa
2 parents ef56dd1 + 3d5099b
commit 5fa99aa
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 
 - Updated syn to version 2 (#732)
+- Let readable field fetch doc from svd description (#734)
 
 ## [v0.29.0] - 2023-06-05
 

diff --git a/src/generate/register.rs b/src/generate/register.rs
@@ -805,7 +805,7 @@ pub fn fields(
                             span,
                         );
 
-                        let doc = format!("Checks if the value of the field is `{pc}`");
+                        let doc = util::escape_special_chars(&util::respace(&v.doc));
                         enum_items.extend(quote! {
                             #[doc = #doc]
                             #inline