Doxygen fixes: Hide private stuff, document some structs.

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 6e81c6f69851dbbb7e33aca7d35198d80fc670bf..6e024352ab6c8c426c4191b1fee1e01d585a3740 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -17,8 +17,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef LIBSIGROK_SIGROK_H
-#define LIBSIGROK_SIGROK_H
+#ifndef LIBSIGROK_LIBSIGROK_H
+#define LIBSIGROK_LIBSIGROK_H
 
 #include <stdio.h>
 #include <sys/time.h>
@@ -299,9 +299,18 @@ enum {
        SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
        /** Time is duration (as opposed to epoch, ...). */
        SR_MQFLAG_DURATION = 0x20000,
+       /** Device is in "avg" mode, averaging upon each new value. */
+       SR_MQFLAG_AVG = 0x40000,
 };
 
-/** sigrok context (opaque). @see sr_init(), sr_exit(). */
+/**
+ * @struct sr_context
+ * Opaque structure representing a libsigrok context.
+ *
+ * None of the fields of this structure are meant to be accessed directly.
+ *
+ * @see sr_init(), sr_exit().
+ */
 struct sr_context;
 
 /** Packet in a sigrok data feed. */
@@ -946,6 +955,8 @@ struct sr_dev_driver {
 };
 
 /**
+ * @struct sr_session
+ *
  * Opaque data structure representing a libsigrok session. None of the fields
  * of this structure are meant to be accessed directly.
  */