From: Martin Ling <redacted>
Date: Wed, 20 Nov 2013 19:11:39 +0000 (+0000)
Subject: Add missing @param port entries to documentation.
X-Git-Tag: libserialport-0.1.0~81
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=3f099f4fe8d17e8acc43a04e38d7b6aacc9c6057;p=libserialport.git

Add missing @param port entries to documentation.
---

diff --git a/libserialport.h.in b/libserialport.h.in
index 79babac..e4109a9 100644
--- a/libserialport.h.in
+++ b/libserialport.h.in
@@ -541,6 +541,8 @@ enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers);
 /**
  * Wait for buffered data to be transmitted.
  *
+ * @param port Pointer to port structure.
+ *
  * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
  *         if an invalid port is passed.
  */
@@ -571,6 +573,8 @@ enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signals);
 /**
  * Put the port transmit line into the break state.
  *
+ * @param port Pointer to port structure.
+ *
  * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
  *         if an invalid port is passed.
  */
@@ -579,6 +583,8 @@ enum sp_return sp_start_break(struct sp_port *port);
 /**
  * Take the port transmit line out of the break state.
  *
+ * @param port Pointer to port structure.
+ *
  * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
  *         if an invalid port is passed.
  */