X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;ds=inline;f=libsigrok-internal.h;h=6073f4bd81a93eccecf73f146521a6e36687c730;hb=2eb84c983584490153fe2bcbf10cc7ceaf46d033;hp=cb4fd3fe6aa37bc862df6a896d78fcdb7feff331;hpb=23dc6661667b05a91b01ab6a6fa425aa57af6daf;p=libsigrok.git

diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index cb4fd3fe..6073f4bd 100644
--- a/libsigrok-internal.h
+++ b/libsigrok-internal.h
@@ -17,8 +17,12 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef LIBSIGROK_SIGROK_INTERNAL_H
-#define LIBSIGROK_SIGROK_INTERNAL_H
+/** @file
+  * @internal
+  */
+
+#ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
+#define LIBSIGROK_LIBSIGROK_INTERNAL_H
 
 #include <stdarg.h>
 #include <glib.h>
@@ -60,9 +64,13 @@ struct sr_context {
 };
 
 #ifdef HAVE_LIBUSB_1_0
+/** USB device instance */
 struct sr_usb_dev_inst {
+	/** USB bus */
 	uint8_t bus;
+	/** Device address on USB bus */
 	uint8_t address;
+	/** libusb device handle */
 	struct libusb_device_handle *devhdl;
 };
 #endif
@@ -72,9 +80,13 @@ struct sr_usb_dev_inst {
 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
 struct sr_serial_dev_inst {
+	/** Port name, e.g. '/dev/tty42'. */
 	char *port;
+	/** Comm params for serial_set_paramstr(). */
 	char *serialcomm;
+	/** Port is non-blocking. */
 	int nonblocking;
+	/** libserialport port handle */
 	struct sp_port *data;
 };
 #endif
@@ -86,6 +98,7 @@ struct sr_usbtmc_dev_inst {
 
 /* Private driver context. */
 struct drv_context {
+	/** sigrok context */
 	struct sr_context *sr_ctx;
 	GSList *instances;
 };
@@ -164,7 +177,9 @@ struct sr_session {
 	 * an async fashion. We need to make sure the session is stopped from
 	 * within the session thread itself.
 	 */
+	/** Mutex protecting access to abort_session. */
 	GMutex stop_mutex;
+	/** Abort current session. See sr_session_stop(). */
 	gboolean abort_session;
 };