rust-embedded / svd2rust

Generate Rust register maps (`struct`s) from SVD files
Apache License 2.0
697 stars 150 forks source link

Warning during doc generation: warning: unclosed HTML tag `K` #710

Closed pellico closed 1 year ago

pellico commented 1 year ago

When generating documentation for generated PAL I get: warning: unclosed HTML tagK --> src\srss\res_cause2.rs:47:5 | 47 | #[doc = "Bits 0:15 - Clock supervision logic requested a reset due to loss or frequency violation of a high-frequency clock. Each bit index K corresponds to a HFCLK<K>. Unimplemented clock bits return zero."]

The reason is clearly are the angle brackets. Looking at CMSIS specs nothing forbid to use angle brackets. Moreover the generated documentation has bad formatting due to embedded tag.

I expect that svd2rust escapes this kind of characters.

svd2rust version 0.28.0 In attachment one of SVD files that triggers the issue. cyt2b9.zip