[sw] Document Output-params
This commit updates almost all software doxygen comments to highlight
where a value is an out-param. Out-params are heavily used in e.g. DIF
libraries, so it is useful to explicitly document where they are used.
The criteria I am using for an out-param is a pointer- (or array-) typed
parameter, where the function updates the value stored in that pointer
in order to return data to the caller. This includes both output buffers
(for recieving data into), and output singleton pointers.
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 00b6640..381d061 100644
--- a/sw/device/lib/flash_ctrl.h
+++ b/sw/device/lib/flash_ctrl.h
@@ -86,7 +86,7 @@
* @param addr Read start address.
* @param part Flash parittion to access.
* @param size Number of 4B words to read.
- * @param data Output buffer.
+ * @param[out] data Output buffer.
* @return Non zero on failure.
*/
int flash_read(uint32_t addr, part_type_t part, uint32_t size, uint32_t *data);
