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

input: Fix up API documentation.

This commit is contained in:
Bert Vermeulen 2014-08-10 18:44:39 +02:00
parent 17bfaca62a
commit 0f3dbc9530
1 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/input/input.c
View File

@ -31,7 +31,7 @@
/** /**
* @file * @file
* *
* Input file/data format handling. * Input module handling.
*/ */
/** /**
@ -40,13 +40,13 @@
* Input file/data module handling. * Input file/data module handling.
* *
* libsigrok can process acquisition data in several different ways. * libsigrok can process acquisition data in several different ways.
* Aside from acquiring data from a hardware device, it can also take it from * Aside from acquiring data from a hardware device, it can also take it
* a file in various formats (binary, CSV, VCD, and so on). * from a file in various formats (binary, CSV, VCD, and so on).
* *
* Like everything in libsigrok that handles data, processing is done in a * Like all libsigrok data handling, processing is done in a streaming
* streaming manner -- input should be supplied to libsigrok a chunk at a time. * manner: input should be supplied a chunk at a time. This way anything
* This way anything that processes data can do so in real time, without the * that processes data can do so in real time, without the user having
* user having to wait for the whole thing to be finished. * to wait for the whole thing to be finished.
* *
* Every input module is "pluggable", meaning it's handled as being separate * Every input module is "pluggable", meaning it's handled as being separate
* from the main libsigrok, but linked in to it statically. To keep things * from the main libsigrok, but linked in to it statically. To keep things
@ -75,7 +75,11 @@ static const struct sr_input_module *input_module_list[] = {
NULL, NULL,
}; };
/** @since 0.4.0 */ /**
* Returns a NULL-terminated list of all available input modules.
*
* @since 0.4.0
*/
SR_API const struct sr_input_module **sr_input_list(void) SR_API const struct sr_input_module **sr_input_list(void)
{ {
return input_module_list; return input_module_list;
@ -164,7 +168,7 @@ SR_API const struct sr_option *sr_input_options_get(const struct sr_input_module
/** /**
* After a call to sr_input_options_get(), this function cleans up all * After a call to sr_input_options_get(), this function cleans up all
* the resources allocated by that call. * resources allocated by that call.
* *
* @since 0.4.0 * @since 0.4.0
*/ */
@ -194,9 +198,9 @@ SR_API void sr_input_options_free(const struct sr_input_module *o)
* This function is used when a client wants to use a specific input * This function is used when a client wants to use a specific input
* module to parse a stream. No effort is made to identify the format. * module to parse a stream. No effort is made to identify the format.
* *
* <code>options</code> is a *HashTable with the keys corresponding with * @param options GHashTable consisting of keys corresponding with
* the module options' <code>id</code> field. The values should be GVariant * the module options \c id field. The values should be GVariant
* pointers with sunk * references, of the same GVariantType as the option's * pointers with sunk references, of the same GVariantType as the option's
* default value. * default value.
* *
* @since 0.4.0 * @since 0.4.0
@ -447,6 +451,12 @@ SR_API const struct sr_input *sr_input_scan_file(const char *filename)
return in; return in;
} }
/**
* Return the input instance's (virtual) device instance. This can be
* used to find out the number of channels and other information.
*
* @since 0.4.0
*/
SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in) SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
{ {
return in->sdi; return in->sdi;