Use remap_pins inline comment as doc comment

david-sawatzke · david-sawatzke · commit 3c8d1b4b6560 · 2020-12-06T23:38:28.000+01:00
We're sorely lacking on documentation and this is good enough as is
diff --git a/src/usb.rs b/src/usb.rs
@@ -46,10 +46,10 @@ unsafe impl UsbPeripheral for Peripheral {
     }
 }
 
+/// Remap PA11/PA12 pins to PA09/PA10 for USB on
+/// TSSOP20 (STM32F042F) or UFQFPN28 (STM32F042G) packages
 pub fn remap_pins(rcc: &mut RCC, syscfg: &mut SYSCFG) {
     cortex_m::interrupt::free(|_| {
-        // Remap PA11/PA12 pins to PA09/PA10 for USB on
-        // TSSOP20 (STM32F042F) or UFQFPN28 (STM32F042G) packages
         rcc.apb2enr.modify(|_, w| w.syscfgen().set_bit());
         syscfg.cfgr1.modify(|_, w| w.pa11_pa12_rmp().remapped());
     });

Original file line number	Diff line number	Diff line change
`@@ -46,10 +46,10 @@ unsafe impl UsbPeripheral for Peripheral {`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`
	`49`	`+/// Remap PA11/PA12 pins to PA09/PA10 for USB on`
	`50`	`+/// TSSOP20 (STM32F042F) or UFQFPN28 (STM32F042G) packages`
`49`	`51`	`pub fn remap_pins(rcc: &mut RCC, syscfg: &mut SYSCFG) {`
`50`	`52`	`cortex_m::interrupt::free(\|_\| {`
`51`		`- // Remap PA11/PA12 pins to PA09/PA10 for USB on`
`52`		`- // TSSOP20 (STM32F042F) or UFQFPN28 (STM32F042G) packages`
`53`	`53`	`rcc.apb2enr.modify(\|_, w\| w.syscfgen().set_bit());`
`54`	`54`	`syscfg.cfgr1.modify(\|_, w\| w.pa11_pa12_rmp().remapped());`
`55`	`55`	`});`