Skip to content

Improve documentation on generated registers and fields #468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2020
Merged

Improve documentation on generated registers and fields #468

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions src/generate/register.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ pub fn render(
let can_reset = res_val.is_some();

if can_read {
let desc = format!("Reader of register {}", register.name);
let desc = format!("Register `{}` reader", register.name);
mod_items.extend(quote! {
#[doc = #desc]
pub struct R(crate::R<#name_uc_spec>);
Expand All @@ -78,7 +78,7 @@ pub fn render(
}

if can_write {
let desc = format!("Writer for register {}", register.name);
let desc = format!("Register `{}` writer", register.name);
mod_items.extend(quote! {
#[doc = #desc]
pub struct W(crate::W<#name_uc_spec>);
Expand Down Expand Up @@ -350,12 +350,12 @@ pub fn fields(
if can_read {
let readerdoc = if let Some((_, _, _, _, suffixes_str)) = &field_dim {
format!(
"Reader of fields `{}`",
util::replace_suffix(&f.name, suffixes_str)
"Fields `{}` reader - {}",
util::replace_suffix(&f.name, suffixes_str),
description,
)
} else {
let quotedfield = String::from("`") + &f.name + "`";
String::from("Reader of field ") + &quotedfield
format!("Field `{}` reader - {}", f.name, description)
};

let name_pc_r = Ident::new(&(name_pc.clone() + "_R"), span);
Expand Down Expand Up @@ -687,12 +687,13 @@ pub fn fields(
let offset_entry;
if let Some((_, _, _, _, suffixes_str)) = &field_dim {
doc = format!(
"Write proxy for fields `{}`",
util::replace_suffix(&f.name, suffixes_str)
"Fields `{}` writer - {}",
util::replace_suffix(&f.name, suffixes_str),
description
);
offset_entry = quote! {offset: usize,};
} else {
doc = format!("Write proxy for field `{}`", f.name);
doc = format!("Field `{}` writer - {}", f.name, description);
offset_entry = quote! {};
}

Expand Down