mirror/libserialport
mirror/libserialport
1
0
Fork 0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00
Code Issues Projects Releases Wiki Activity

Add missing @param port entries to documentation.

Browse Source
This commit is contained in:
Martin Ling 2013-11-20 19:11:39 +00:00 committed by Bert Vermeulen
parent 8cf7c6978f
commit 3f099f4fe8
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
libserialport.h.in
View 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. * 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 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
* if an invalid port is passed. * 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. * 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 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
* if an invalid port is passed. * 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. * 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 * @return SP_OK on success, SP_ERR_FAIL on failure, or SP_ERR_ARG
* if an invalid port is passed. * if an invalid port is passed.
*/ */