]> sigrok.org Git - libsigrok.git/blobdiff - backend.c
Doxygen: Add @file items for the relevant files.
[libsigrok.git] / backend.c
index 2d0b38e2e44ecbb22bff2a5640e2e38b38f851fe..9f0f119fa5bfc3b29cf37b4d1c7eeeb9e3f472fe 100644 (file)
--- a/backend.c
+++ b/backend.c
  * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
  * file formats</a>.
  *
- * @section sec_error_handling Error handling
+ * @section sec_api API reference
  *
- * libsigrok functions usually return @ref SR_OK upon success, or a negative
- * error code on failure.
+ * See the "Modules" page for an introduction to various libsigrok
+ * related topics and the detailed API documentation of the respective
+ * functions.
+ *
+ * You can also browse the API documentation by file, or review all
+ * data structures.
  *
  * @section sec_mailinglists Mailing lists
  *
  * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
  */
 
+/**
+ * @file
+ *
+ * Initializing and shutting down libsigrok.
+ */
+
+/**
+ * @defgroup grp_init Initialization
+ *
+ * Initializing and shutting down libsigrok.
+ *
+ * @{
+ */
+
 /**
  * Initialize libsigrok.
  *
@@ -130,3 +148,5 @@ SR_API int sr_exit(struct sr_context *ctx)
 
        return SR_OK;
 }
+
+/** @} */