X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=backend.c;h=4823044efce580dbc9d7a116f1eb46e63a84a389;hb=a53da08254a5adcc15c925014eb1083fb067f3b6;hp=9f0f119fa5bfc3b29cf37b4d1c7eeeb9e3f472fe;hpb=393fb9cb18c5746d8567c9cf74b872804043345a;p=libsigrok.git

diff --git a/backend.c b/backend.c
index 9f0f119f..4823044e 100644
--- a/backend.c
+++ b/backend.c
@@ -19,6 +19,7 @@
  */
 
 #include <glib.h>
+#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
@@ -74,6 +75,42 @@
  *
  * Initializing and shutting down libsigrok.
  *
+ * Before using any of the libsigrok functionality, sr_init() must
+ * be called to initialize the library, which will return a struct sr_context
+ * when the initialization was successful.
+ *
+ * When libsigrok functionality is no longer needed, sr_exit() should be
+ * called, which will (among other things) free the struct sr_context.
+ *
+ * Example for a minimal program using libsigrok:
+ *
+ * @code{.c}
+ *   #include <stdio.h>
+ *   #include <libsigrok/libsigrok.h>
+ *
+ *   int main(int argc, char **argv)
+ *   {
+ *   	int ret;
+ *   	struct sr_context *sr_ctx;
+ *
+ *   	if ((ret = sr_init(&sr_ctx)) != SR_OK) {
+ *   		printf("Error initializing libsigrok (%s): %s.",
+ *   		       sr_strerror_name(ret), sr_strerror(ret));
+ *   		return 1;
+ *   	}
+ *
+ *   	// Use libsigrok functions here...
+ *
+ *   	if ((ret = sr_exit(sr_ctx)) != SR_OK) {
+ *   		printf("Error shutting down libsigrok (%s): %s.",
+ *   		       sr_strerror_name(ret), sr_strerror(ret));
+ *   		return 1;
+ *   	}
+ *
+ *   	return 0;
+ *   }
+ * @endcode
+ *
  * @{
  */