Doxygen: Add @file items for the relevant files.
These short descriptions are shown in the "Files" section of the Doxygen output.
This commit is contained in:
parent
777e2035d8
commit
393fb9cb18
|
@ -63,6 +63,12 @@
|
||||||
* <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
|
* <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Initializing and shutting down libsigrok.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_init Initialization
|
* @defgroup grp_init Initialization
|
||||||
*
|
*
|
||||||
|
|
|
@ -24,6 +24,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Creating, using, or destroying libsigrok datastores.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_datastore Datastore
|
* @defgroup grp_datastore Datastore
|
||||||
*
|
*
|
||||||
|
|
6
device.c
6
device.c
|
@ -22,6 +22,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Device handling in libsigrok.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_devices Devices
|
* @defgroup grp_devices Devices
|
||||||
*
|
*
|
||||||
|
|
6
error.c
6
error.c
|
@ -20,6 +20,12 @@
|
||||||
|
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Error handling in libsigrok.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_error Error handling
|
* @defgroup grp_error Error handling
|
||||||
*
|
*
|
||||||
|
|
6
filter.c
6
filter.c
|
@ -23,6 +23,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Helper functions to filter out unused probes from samples.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_filter Probe filter
|
* @defgroup grp_filter Probe filter
|
||||||
*
|
*
|
||||||
|
|
|
@ -26,6 +26,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Hardware driver handling in libsigrok.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_driver Hardware drivers
|
* @defgroup grp_driver Hardware drivers
|
||||||
*
|
*
|
||||||
|
|
|
@ -20,6 +20,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Input file/data format handling.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_input Input formats
|
* @defgroup grp_input Input formats
|
||||||
*
|
*
|
||||||
|
|
|
@ -27,6 +27,12 @@
|
||||||
#include <libusb.h>
|
#include <libusb.h>
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* libsigrok private header file, only to be used internally.
|
||||||
|
*/
|
||||||
|
|
||||||
/*--- Macros ----------------------------------------------------------------*/
|
/*--- Macros ----------------------------------------------------------------*/
|
||||||
|
|
||||||
#ifndef ARRAY_SIZE
|
#ifndef ARRAY_SIZE
|
||||||
|
|
|
@ -30,6 +30,12 @@
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* The public libsigrok header file to be used by frontends.
|
||||||
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* All possible return codes of libsigrok functions must be listed here.
|
* All possible return codes of libsigrok functions must be listed here.
|
||||||
* Functions should never return hardcoded numbers as status, but rather
|
* Functions should never return hardcoded numbers as status, but rather
|
||||||
|
|
2
log.c
2
log.c
|
@ -26,7 +26,7 @@
|
||||||
/**
|
/**
|
||||||
* @file
|
* @file
|
||||||
*
|
*
|
||||||
* Logging support.
|
* Controlling the libsigrok message logging functionality.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -20,6 +20,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Output file/data format handling.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_output Output formats
|
* @defgroup grp_output Output formats
|
||||||
*
|
*
|
||||||
|
|
6
proto.h
6
proto.h
|
@ -20,6 +20,12 @@
|
||||||
#ifndef LIBSIGROK_SIGROK_PROTO_H
|
#ifndef LIBSIGROK_SIGROK_PROTO_H
|
||||||
#define LIBSIGROK_SIGROK_PROTO_H
|
#define LIBSIGROK_SIGROK_PROTO_H
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Header file containing API function prototypes.
|
||||||
|
*/
|
||||||
|
|
||||||
/*--- backend.c -------------------------------------------------------------*/
|
/*--- backend.c -------------------------------------------------------------*/
|
||||||
|
|
||||||
SR_API int sr_init(struct sr_context **ctx);
|
SR_API int sr_init(struct sr_context **ctx);
|
||||||
|
|
|
@ -25,6 +25,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Creating, using, or destroying libsigrok sessions.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_session Session handling
|
* @defgroup grp_session Session handling
|
||||||
*
|
*
|
||||||
|
|
|
@ -27,6 +27,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Loading and saving libsigrok session files.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @addtogroup grp_session
|
* @addtogroup grp_session
|
||||||
*
|
*
|
||||||
|
|
|
@ -24,6 +24,12 @@
|
||||||
#include "libsigrok.h"
|
#include "libsigrok.h"
|
||||||
#include "libsigrok-internal.h"
|
#include "libsigrok-internal.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* Helper functions for handling or converting libsigrok-related strings.
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup grp_strutil String utilities
|
* @defgroup grp_strutil String utilities
|
||||||
*
|
*
|
||||||
|
|
Loading…
Reference in New Issue