[sw] Convert Delimiters to Backticks in Comments
This updates existing code to follow the new guidance about backticks
in software code. This should be a non-functional change.
Signed-off-by: Sam Elliott <selliott@lowrisc.org>
diff --git a/sw/device/lib/flash_ctrl.h b/sw/device/lib/flash_ctrl.h
index c7c26dd..f15d197 100644
--- a/sw/device/lib/flash_ctrl.h
+++ b/sw/device/lib/flash_ctrl.h
@@ -50,7 +50,7 @@
int flash_check_empty(void);
/**
- * Erase flash bank |bank_idx|. Blocks until erase is complete.
+ * Erase flash bank `bank_idx`. Blocks until erase is complete.
*
* @param idx Flash bank index.
* @return Non zero on failure.
@@ -59,17 +59,17 @@
int flash_page_erase(uint32_t addr);
/**
- * Write |data| at |addr| offset with |size| in 4B words
+ * Write `data` at `addr` offset with `size` in 4B words
*
* @param addr Flash address 32bit aligned.
* @param data Data to write.
- * @param size Number of 4B words to write from |data| buffer.
+ * @param size Number of 4B words to write from `data` buffer.
* @return Non zero on failure.
*/
int flash_write(uint32_t addr, const uint32_t *data, uint32_t size);
/**
- * Read |size| 4B words and write result to |data|.
+ * Read `size` 4B words and write result to `data`.
*
* @param addr Read start address.
* @param size Number of 4B words to read.