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

Doxygen: Fix a bunch of warnings and outdated docs.

This commit is contained in:
Uwe Hermann 2012-10-21 16:52:56 +02:00
parent f21193fa03
commit 9c5332d291
4 changed files with 24 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
device.c
View File

@ -160,9 +160,10 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
}
/**
* Determine whether the specified device has the specified capability.
* Determine whether the specified device instance has the specified
* capability.
*
* @param dev Pointer to the device instance to be checked. Must not be NULL.
* @param sdi Pointer to the device instance to be checked. Must not be NULL.
* If the device's 'driver' field is NULL (virtual device), this
* function will always return FALSE (virtual devices don't have
* a hardware capabilities list).

25
libsigrok.h
View File

@ -323,22 +323,29 @@ struct sr_hwopt {
enum {
SR_HWOPT_DUMMY = 0, /* Used to terminate lists. Must be 0! */
/** Some drivers cannot detect the exact model they're talking to
* (may be phased out). */
/**
* Some drivers cannot detect the exact model they're talking to
* (may be phased out).
*/
SR_HWOPT_MODEL,
/** Specification on how to connect to a device. In combination
/**
* Specification on how to connect to a device. In combination
* with SR_HWOPT_SERIALCOMM, this is a serial port in the form
* which makes sense to the operating system (/dev/ttyS0).
* which makes sense to the operating system (e.g., /dev/ttyS0).
* Otherwise this specifies a USB device, either in the form of
* <bus>.<address> (decimal, e.g. 1.65) or <vendorid>.<productid>
* (hexadecimal, e.g. 1d6b.0001). */
* [bus].[address] (decimal, e.g. 1.65) or [vendorid].[productid]
* (hexadecimal, e.g. 1d6b.0001).
*/
SR_HWOPT_CONN,
/** Serial communication specification, in the form:
* <speed>/<data bits><parity><stop bit> e.g.9600/ 8n1
/**
* Serial communication specification, in the form:
* [speed]/[databits][parity][stop bit], e.g. 9600/8n1
*
* 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.
*/
SR_HWOPT_SERIALCOMM,
};

4
session.c
View File

@ -122,9 +122,9 @@ SR_API int sr_session_dev_remove_all(void)
}
/**
* Add a device to the current session.
* Add a device instance to the current session.
*
* @param dev The device instance to add to the current session. Must not
* @param sdi The device instance to add to the current session. Must not
* be NULL. Also, sdi->driver and sdi->driver->dev_open must
* not be NULL.
*

4
strutil.c
View File

@ -178,7 +178,9 @@ SR_API char *sr_voltage_string(struct sr_rational *voltage)
/**
* Parse a trigger specification string.
*
* @param dev The device for which the trigger specification is intended.
* @param sdi The device instance for which the trigger specification is
* intended. Must not be NULL. Also, sdi->driver and
* sdi->driver->info_get must not be NULL.
* @param triggerstring The string containing the trigger specification for
* one or more probes of this device. Entries for multiple probes are
* comma-separated. Triggers are specified in the form key=value,