]> sigrok.org Git - libserialport.git/commitdiff
Add missing @param port entries to documentation.
authorMartin Ling <redacted>
Wed, 20 Nov 2013 19:11:39 +0000 (19:11 +0000)
committerBert Vermeulen <redacted>
Fri, 22 Nov 2013 01:11:45 +0000 (02:11 +0100)
libserialport.h.in

index 79babac9a70b21fa49f1ab0b12a63cb2af378125..e4109a985f96d587f33e9b99fba6a6a33b2c48dc 100644 (file)
@@ -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.
  */