Doxygen: Add @file items for the relevant files.

These short descriptions are shown in the "Files" section of the
Doxygen output.

diff --git a/backend.c b/backend.c
index b3e383935a6b23aa12777600e0683b92eded1df7..9f0f119fa5bfc3b29cf37b4d1c7eeeb9e3f472fe 100644 (file)
--- a/backend.c
+++ b/backend.c
@@ -63,6 +63,12 @@
  * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
  */
 
+/**
+ * @file
+ *
+ * Initializing and shutting down libsigrok.
+ */
+
 /**
  * @defgroup grp_init Initialization
  *

diff --git a/datastore.c b/datastore.c
index eac79cec92608e896f6e58932566247ab23cf718..16346695a855b9f0f6be18938387ef9346c7dbcc 100644 (file)
--- a/datastore.c
+++ b/datastore.c
@@ -24,6 +24,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Creating, using, or destroying libsigrok datastores.
+ */
+
 /**
  * @defgroup grp_datastore Datastore
  *

diff --git a/device.c b/device.c
index 26e34c95e7791d02012e6d5cfd30d1e8e9ccc18a..2509c542ba4566816998f58e74de4bd4a6e7c881 100644 (file)
--- a/device.c
+++ b/device.c
@@ -22,6 +22,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Device handling in libsigrok.
+ */
+
 /**
  * @defgroup grp_devices Devices
  *

diff --git a/error.c b/error.c
index 761c94e4da3662fbb87e1f3dd3dd5720a3fa31d8..c9b8589e218991059c3dcc4cd4eeeb6fb4f340e7 100644 (file)
--- a/error.c
+++ b/error.c
@@ -20,6 +20,12 @@
 
 #include "libsigrok.h"
 
+/**
+ * @file
+ *
+ * Error handling in libsigrok.
+ */
+
 /**
  * @defgroup grp_error Error handling
  *

diff --git a/filter.c b/filter.c
index 4e3115cd10d73deda49973289ca645c58b1e20e2..df28a72348500be5dc93ba217f1028fc620563c7 100644 (file)
--- a/filter.c
+++ b/filter.c
@@ -23,6 +23,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Helper functions to filter out unused probes from samples.
+ */
+
 /**
  * @defgroup grp_filter Probe filter
  *

diff --git a/hwdriver.c b/hwdriver.c
index 207052cffc9a23486544dc73ac7984ff60f3b429..8be8a9e2dd8820d6fc813a6e6b45aadd86198c43 100644 (file)
--- a/hwdriver.c
+++ b/hwdriver.c
@@ -26,6 +26,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Hardware driver handling in libsigrok.
+ */
+
 /**
  * @defgroup grp_driver Hardware drivers
  *

diff --git a/input/input.c b/input/input.c
index 1b83c65dda049929ffbdb366c9aba7cad2fe0c27..fd51a874ba9faf0701f4ff04d60a032aa3f413d6 100644 (file)
--- a/input/input.c
+++ b/input/input.c
@@ -20,6 +20,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Input file/data format handling.
+ */
+
 /**
  * @defgroup grp_input Input formats
  *

diff --git a/libsigrok-internal.h b/libsigrok-internal.h
index 563605720c16b769bdce9abc11cb7c9b48ce9a41..38647622d825c0167ee3025b376200a95775ac86 100644 (file)
--- a/libsigrok-internal.h
+++ b/libsigrok-internal.h
@@ -27,6 +27,12 @@
 #include <libusb.h>
 #endif
 
+/**
+ * @file
+ *
+ * libsigrok private header file, only to be used internally.
+ */
+
 /*--- Macros ----------------------------------------------------------------*/
 
 #ifndef ARRAY_SIZE

diff --git a/libsigrok.h b/libsigrok.h
index 4c46734663cfa7bf3be72105f53f0dda55231ddc..fd09492ee0d8ccf9c4970a1ed1cd758a2dc85da3 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -30,6 +30,12 @@
 extern "C" {
 #endif
 
+/**
+ * @file
+ *
+ * The public libsigrok header file to be used by frontends.
+ */
+
 /*
  * All possible return codes of libsigrok functions must be listed here.
  * Functions should never return hardcoded numbers as status, but rather

diff --git a/log.c b/log.c
index a3b807aa95c8fff91217679ceb859888ecda5079..6ebede70418f6f56dd6d53576d24957089482299 100644 (file)
--- a/log.c
+++ b/log.c
@@ -26,7 +26,7 @@
 /**
  * @file
  *
- * Logging support.
+ * Controlling the libsigrok message logging functionality.
  */
 
 /**

diff --git a/output/output.c b/output/output.c
index 457a80c3a886b18cb398cfdef1523a233ccc97bd..d726ad934819f09829444b3f4036de781a5d75bb 100644 (file)
--- a/output/output.c
+++ b/output/output.c
@@ -20,6 +20,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Output file/data format handling.
+ */
+
 /**
  * @defgroup grp_output Output formats
  *

diff --git a/proto.h b/proto.h
index 49b2d7473087b6c16baea3b896ea266c5dbbd7c3..4c9286c103389d3628ce566a439c8eaaa96e7956 100644 (file)
--- a/proto.h
+++ b/proto.h
@@ -20,6 +20,12 @@
 #ifndef LIBSIGROK_SIGROK_PROTO_H
 #define LIBSIGROK_SIGROK_PROTO_H
 
+/**
+ * @file
+ *
+ * Header file containing API function prototypes.
+ */
+
 /*--- backend.c -------------------------------------------------------------*/
 
 SR_API int sr_init(struct sr_context **ctx);

diff --git a/session.c b/session.c
index 0d4c13f725c14681b684f86d5aae0ebaa062065e..81e09b114dc59c44a2300dd85ad927329a7714ba 100644 (file)
--- a/session.c
+++ b/session.c
@@ -25,6 +25,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Creating, using, or destroying libsigrok sessions.
+ */
+
 /**
  * @defgroup grp_session Session handling
  *

diff --git a/session_file.c b/session_file.c
index 5b91f92932e5fe71674f618c3e325b51c8975f6c..41ca36c5fbd04e7a0f3920d9b97cfed80eaa9ab1 100644 (file)
--- a/session_file.c
+++ b/session_file.c
@@ -27,6 +27,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Loading and saving libsigrok session files.
+ */
+
 /**
  * @addtogroup grp_session
  *

diff --git a/strutil.c b/strutil.c
index c147b961eb94a6c1aeb2dc4468aa97f388771950..1cb0db39efe1c1eb40870008e69452f83adc74e6 100644 (file)
--- a/strutil.c
+++ b/strutil.c
@@ -24,6 +24,12 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Helper functions for handling or converting libsigrok-related strings.
+ */
+
 /**
  * @defgroup grp_strutil String utilities
  *

diff --git a/version.c b/version.c
index 37baabecc9b15700cf464d3175d4f9316237c930..a92aa96057d6b4ecbe51b27838b858871db46880 100644 (file)
--- a/version.c
+++ b/version.c
@@ -20,6 +20,12 @@
 
 #include "libsigrok.h"
 
+/**
+ * @file
+ *
+ * Version number querying functions.
+ */
+
 /**
  * @defgroup grp_versions Versions
  *