new-driver: Cosmetics, whitespace, add comments.

[sigrok-util.git] / source / drv-protocol.h

diff --git a/source/drv-protocol.h b/source/drv-protocol.h
index c12e6ba6d11fe0194f45e559a9f4ff6ebfeda3b7..dae5ffed5e3c665df998412e1b757126d6541ffb 100644 (file)
--- a/source/drv-protocol.h
+++ b/source/drv-protocol.h
@@ -17,19 +17,21 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef LIBSIGROK_${upper}_H
 #define LIBSIGROK_${upper}_H
 
-/* Private, per-device-instance driver context. */
+/** Private, per-device-instance driver context. */
 struct dev_context {
+       /** The current sampling limit (in number of samples). */
        uint64_t limit_samples;
+
+       /** The current sampling limit (in ms). */
        uint64_t limit_msec;
 
-       /* Opaque pointer passed in by the frontend. */
+       /** Opaque pointer passed in by the frontend. */
        void *cb_data;
 
-       /* Runtime. */
+       /** The current number of already received samples. */
        uint64_t num_samples;
 };