BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doxygen: Various fixes in libsigrok.h.

This commit is contained in:
Uwe Hermann 2012-10-22 01:13:36 +02:00
parent 393fb9cb18
commit a02d77bce9
1 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
libsigrok.h
View File

@ -161,7 +161,7 @@ enum {
SR_MQ_CONDUCTANCE, SR_MQ_CONDUCTANCE,
/** Electrical power, usually in W, or dBm. */ /** Electrical power, usually in W, or dBm. */
SR_MQ_POWER, SR_MQ_POWER,
/** Gain (e.g. a transistor's gain, or hFE). */ /** Gain (a transistor's gain, or hFE, for example). */
SR_MQ_GAIN, SR_MQ_GAIN,
}; };
@ -205,7 +205,7 @@ enum {
SR_MQFLAG_RMS = 0x04, SR_MQFLAG_RMS = 0x04,
/** Value is voltage drop across a diode, or NAN. */ /** Value is voltage drop across a diode, or NAN. */
SR_MQFLAG_DIODE = 0x08, SR_MQFLAG_DIODE = 0x08,
/** Device is in "hold" mode, i.e. repeating the last measurement. */ /** Device is in "hold" mode (repeating the last measurement). */
SR_MQFLAG_HOLD = 0x10, SR_MQFLAG_HOLD = 0x10,
/** Device is in "max" mode, only updating upon a new max value. */ /** Device is in "max" mode, only updating upon a new max value. */
SR_MQFLAG_MAX = 0x20, SR_MQFLAG_MAX = 0x20,
@ -246,7 +246,7 @@ struct sr_datafeed_meta_analog {
struct sr_datafeed_analog { struct sr_datafeed_analog {
int num_samples; int num_samples;
/** Measured quantity (e.g. voltage, current, temperature). */ /** Measured quantity (voltage, current, temperature, and so on). */
int mq; int mq;
/** Unit in which the MQ is measured. */ /** Unit in which the MQ is measured. */
int unit; int unit;
@ -337,8 +337,8 @@ struct sr_hwopt {
/** Hardware driver options. */ /** Hardware driver options. */
enum { enum {
/** Used to terminate lists. Must be 0! */ /** Used to terminate lists. */
SR_HWOPT_DUMMY = 0, SR_HWOPT_DUMMY = 0, /* Must be 0! */
/** /**
* Some drivers cannot detect the exact model they're talking to * Some drivers cannot detect the exact model they're talking to
@ -347,18 +347,23 @@ enum {
SR_HWOPT_MODEL, SR_HWOPT_MODEL,
/** /**
* Specification on how to connect to a device. In combination * Specification on how to connect to a device.
* with SR_HWOPT_SERIALCOMM, this is a serial port in the form *
* which makes sense to the operating system (e.g., /dev/ttyS0). * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in
* the form which makes sense to the OS (e.g., /dev/ttyS0).
* Otherwise this specifies a USB device, either in the form of * Otherwise this specifies a USB device, either in the form of
* [bus].[address] (decimal, e.g. 1.65) or [vendorid].[productid] * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
* @verbatim <vendorid>.<productid> @endverbatim
* (hexadecimal, e.g. 1d6b.0001). * (hexadecimal, e.g. 1d6b.0001).
*/ */
SR_HWOPT_CONN, SR_HWOPT_CONN,
/** /**
* Serial communication specification, in the form: * Serial communication specification, in the form:
* [baudrate]/[databits][parity][stopbits], e.g. 9600/8n1 *
* @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
*
* Example: 9600/8n1
* *
* This is always an optional parameter, since a driver typically * This is always an optional parameter, since a driver typically
* knows the speed at which the device wants to communicate. * knows the speed at which the device wants to communicate.
@ -368,8 +373,8 @@ enum {
/** Hardware device capabilities. */ /** Hardware device capabilities. */
enum { enum {
/** Used to terminate lists. Must be 0! */ /** Used to terminate lists. */
SR_HWCAP_DUMMY = 0, SR_HWCAP_DUMMY = 0, /* Must be 0! */
/*--- Device classes ------------------------------------------------*/ /*--- Device classes ------------------------------------------------*/
@ -447,25 +452,25 @@ enum {
/*--- Acquisition modes ---------------------------------------------*/ /*--- Acquisition modes ---------------------------------------------*/
/** /**
* The device supports setting a sample time limit, i.e. how long the * The device supports setting a sample time limit (how long
* sample acquisition should run (in ms). * the sample acquisition should run, in ms).
*/ */
SR_HWCAP_LIMIT_MSEC, SR_HWCAP_LIMIT_MSEC,
/** /**
* The device supports setting a sample number limit, i.e. how many * The device supports setting a sample number limit (how many
* samples should be acquired. * samples should be acquired).
*/ */
SR_HWCAP_LIMIT_SAMPLES, SR_HWCAP_LIMIT_SAMPLES,
/** /**
* The device supports setting a frame limit, i.e. how many * The device supports setting a frame limit (how many
* frames should be acquired. * frames should be acquired).
*/ */
SR_HWCAP_LIMIT_FRAMES, SR_HWCAP_LIMIT_FRAMES,
/** /**
* The device supports continuous sampling, i.e. neither a time limit * The device supports continuous sampling. Neither a time limit
* nor a sample number limit has to be supplied, it will just acquire * nor a sample number limit has to be supplied, it will just acquire
* samples continuously, until explicitly stopped by a certain command. * samples continuously, until explicitly stopped by a certain command.
*/ */