]> sigrok.org Git - libserialport.git/blobdiff - libserialport.h.in
Minor cosmetics.
[libserialport.git] / libserialport.h.in
index 79babac9a70b21fa49f1ab0b12a63cb2af378125..c24550e8b9c231c550c2531584e04a51df678a44 100644 (file)
@@ -18,7 +18,6 @@
  */
 
 /**
- * 
  * @mainpage libserialport API
  *
  * Introduction
@@ -64,8 +63,8 @@
  * or where otherwise documented a positive value.
  */
 
-#ifndef LIBSERIALPORT_H
-#define LIBSERIALPORT_H
+#ifndef LIBSERIALPORT_LIBSERIALPORT_H
+#define LIBSERIALPORT_LIBSERIALPORT_H
 
 #ifdef __cplusplus
 extern "C" {
@@ -541,6 +540,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 +572,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 +582,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.
  */
@@ -624,4 +629,4 @@ void sp_free_error_message(char *message);
 }
 #endif
 
-#endif /* LIBSERIALPORT_H */
+#endif