Currently, register_bitfields! generates few or no documentation comments. This results in a large amount of generated code that is completely opaque in rustdoc. Currently, there is an example at rust-embedded/aarch64-cpu#68 (comment).
register_bitfields! should generate some information on the purpose of each generated item and how to use it (to the extent possible). If it's not possible to generate "how to use it" documentation, then it could at least link to tock-registers' README.
Also, if register_bitfields! does not currently support doc comments (I haven't checked), then it should do so, so that per-register documentation can be provided.
Currently,
register_bitfields!generates few or no documentation comments. This results in a large amount of generated code that is completely opaque in rustdoc. Currently, there is an example at rust-embedded/aarch64-cpu#68 (comment).register_bitfields!should generate some information on the purpose of each generated item and how to use it (to the extent possible). If it's not possible to generate "how to use it" documentation, then it could at least link to tock-registers' README.Also, if
register_bitfields!does not currently support doc comments (I haven't checked), then it should do so, so that per-register documentation can be provided.