git: 96480d9b338b - main - cam_sim: add doxygen to cam_sim_alloc_dev

[Warner Losh]

The branch main has been updated by imp:

URL: https://cgit.FreeBSD.org/src/commit/?id=96480d9b338bd501d1a92bd961a0776ff0c39f71

commit 96480d9b338bd501d1a92bd961a0776ff0c39f71
Author:     Warner Losh <imp at FreeBSD.org>
AuthorDate: 2021-05-16 15:37:26 +0000
Commit:     Warner Losh <imp at FreeBSD.org>
CommitDate: 2021-05-19 21:59:09 +0000

    cam_sim: add doxygen to cam_sim_alloc_dev
    
    cam_sim_alloc_dev was overlooked when cam_sim_alloc was documented.
    Add doxygen docs for it, pointing at cam_sim_alloc.
    
    Sponsored by:           Netflix
---
 sys/cam/cam_sim.c | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/sys/cam/cam_sim.c b/sys/cam/cam_sim.c
index 5b6d43b81d5d..64427795426e 100644
--- a/sys/cam/cam_sim.c
+++ b/sys/cam/cam_sim.c
@@ -130,11 +130,19 @@ cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
 	return (sim);
 }
 
+/**
+ * @brief allocate a new sim and fill in the details with a device_t
+ *
+ * Just like @c cam_sim_alloc, but with an additional paramter.
+ *
+ * @param dev		A newbus device that's associated with the
+ *			sim. Must be non-NULL.
+ */
 struct cam_sim *
 cam_sim_alloc_dev(sim_action_func sim_action, sim_poll_func sim_poll,
-	      const char *sim_name, void *softc, device_t dev,
-	      struct mtx *mtx, int max_dev_transactions,
-	      int max_tagged_dev_transactions, struct cam_devq *queue)
+    const char *sim_name, void *softc, device_t dev, struct mtx *mtx,
+    int max_dev_transactions, int max_tagged_dev_transactions,
+    struct cam_devq *queue)
 {
 	struct cam_sim *sim;