From 511e164f170152f7e10d626b46a43aab14e3d1eb Mon Sep 17 00:00:00 2001 From: Bastien Nocera Date: Mon, 12 Nov 2018 14:20:28 +0100 Subject: [PATCH] lib: Add @short_description for all the sections So gtk-doc doesn't warn about them any more. --- libfprint/fpi-assembling.c | 1 + libfprint/fpi-async.c | 1 + libfprint/fpi-core.c | 5 +++++ libfprint/fpi-data.c | 3 +++ libfprint/fpi-dev-img.c | 1 + libfprint/fpi-dev.c | 1 + libfprint/fpi-img.c | 2 ++ libfprint/fpi-log.h | 1 + libfprint/fpi-poll.c | 2 ++ libfprint/fpi-ssm.c | 1 + libfprint/fpi-usb.c | 1 + 11 files changed, 19 insertions(+) diff --git a/libfprint/fpi-assembling.c b/libfprint/fpi-assembling.c index b4d74c0..046d4f5 100644 --- a/libfprint/fpi-assembling.c +++ b/libfprint/fpi-assembling.c @@ -34,6 +34,7 @@ /** * SECTION:fpi-assembling * @title: Image frame assembly + * @short_description: Image frame assembly helpers * * Those are the helpers to manipulate capture data from fingerprint readers * into a uniform image that can be further processed. This is usually used diff --git a/libfprint/fpi-async.c b/libfprint/fpi-async.c index cc1e6ed..c367b4b 100644 --- a/libfprint/fpi-async.c +++ b/libfprint/fpi-async.c @@ -29,6 +29,7 @@ /** * SECTION:fpi-async * @title: Asynchronous operations reporting + * @short_description: Asynchronous operations reporting functions * * Those functions are used by primitive drivers to report back their * current status. Most drivers, imaging ones, do not need to use them. diff --git a/libfprint/fpi-core.c b/libfprint/fpi-core.c index 75b2838..e57b050 100644 --- a/libfprint/fpi-core.c +++ b/libfprint/fpi-core.c @@ -33,6 +33,7 @@ GSList *opened_devices = NULL; /** * SECTION:discovery * @title: Device discovery + * @short_description: Device discovery functions * * These functions allow you to scan the system for supported fingerprint * scanning hardware. This is your starting point when integrating libfprint @@ -47,6 +48,7 @@ GSList *opened_devices = NULL; /** * SECTION:drv * @title: Driver operations + * @short_description: Driver operation functions * * Internally, libfprint is abstracted into various drivers to communicate * with the different types of supported fingerprint readers. libfprint works @@ -61,6 +63,7 @@ GSList *opened_devices = NULL; /** * SECTION:dev * @title: Devices operations + * @short_description: Device operation functions * * In order to interact with fingerprint scanners, your software will * interface primarily with libfprint's representation of devices, detailed @@ -114,6 +117,7 @@ GSList *opened_devices = NULL; /** * SECTION:fpi-core * @title: Driver structures + * @short_description: Driver structures * * Driver structures need to be defined inside each driver in * order for the core library to know what function to call, and the capabilities @@ -123,6 +127,7 @@ GSList *opened_devices = NULL; /** * SECTION:fpi-core-img * @title: Image driver structures + * @short_description: Image driver structures * * Image driver structures need to be defined inside each image driver in * order for the core library to know what function to call, and the capabilities diff --git a/libfprint/fpi-data.c b/libfprint/fpi-data.c index 173be86..7f5f2d7 100644 --- a/libfprint/fpi-data.c +++ b/libfprint/fpi-data.c @@ -48,6 +48,7 @@ struct fpi_print_data_item_fp2 { /** * SECTION: print_data * @title: Stored prints + * @short_description: Stored prints functions * * Stored prints are represented by a structure named #fp_print_data. * Stored prints are originally obtained from an enrollment function such as @@ -66,6 +67,7 @@ struct fpi_print_data_item_fp2 { /** * SECTION: fpi-data * @title: Stored prints creation + * @short_description: Stored prints creation functions * * Stored print can be loaded and created by certain drivers which do their own * print matching in hardware. Most drivers will not be using those functions. @@ -582,6 +584,7 @@ API_EXPORTED uint32_t fp_print_data_get_devtype(struct fp_print_data *data) /** * SECTION:dscv_print * @title: Print discovery (deprecated) + * @short_description: Print discovery functions * * The [stored print](libfprint-Stored-prints.html) documentation detailed a simple API * for storing per-device prints for a single user, namely diff --git a/libfprint/fpi-dev-img.c b/libfprint/fpi-dev-img.c index b094da2..2a64075 100644 --- a/libfprint/fpi-dev-img.c +++ b/libfprint/fpi-dev-img.c @@ -28,6 +28,7 @@ /** * SECTION:fpi-dev-img * @title: Image device operations + * @short_description: Image device operation functions * * As drivers work through different operations, they need to report back * to the core as to their internal state, so errors and successes can be diff --git a/libfprint/fpi-dev.c b/libfprint/fpi-dev.c index 9ded0b3..c32f002 100644 --- a/libfprint/fpi-dev.c +++ b/libfprint/fpi-dev.c @@ -23,6 +23,7 @@ /** * SECTION:fpi-dev * @title: Device operations + * @short_description: Device operation functions * * Those macros and functions will help get access to and from struct #fp_dev, * and struct #fp_img_dev types, as well as get and set the instance struct diff --git a/libfprint/fpi-img.c b/libfprint/fpi-img.c index d053246..378dfd7 100644 --- a/libfprint/fpi-img.c +++ b/libfprint/fpi-img.c @@ -31,6 +31,7 @@ /** * SECTION:img * @title: Image operations + * @short_description: Image operation functions * * libfprint offers several ways of retrieving images from imaging devices, * one example being the fp_dev_img_capture() function. The functions @@ -51,6 +52,7 @@ /** * SECTION:fpi-img * @title: Driver Image operations + * @short_description: Driver image operation functions * * Those are the driver-specific helpers for #fp_img manipulation. See #fp_img's * documentation for more information about data formats, and their uses in diff --git a/libfprint/fpi-log.h b/libfprint/fpi-log.h index 0d13400..177e0f7 100644 --- a/libfprint/fpi-log.h +++ b/libfprint/fpi-log.h @@ -23,6 +23,7 @@ /** * SECTION:fpi-log * @title: Logging + * @short_description: Logging functions * * Logging in libfprint is handled through GLib's logging system, and behave the same * way as in the GLib [Message Output and Debugging Functions](https://developer.gnome.org/glib/stable/glib-Message-Logging.html) diff --git a/libfprint/fpi-poll.c b/libfprint/fpi-poll.c index f3303e0..1a4b443 100644 --- a/libfprint/fpi-poll.c +++ b/libfprint/fpi-poll.c @@ -33,6 +33,7 @@ /** * SECTION:events * @title: Initialisation and events handling + * @short_description: Initialisation and events handling functions * * These functions are only applicable to users of libfprint's asynchronous * API. @@ -67,6 +68,7 @@ /** * SECTION:fpi-poll * @title: Timeouts + * @short_description: Timeout handling helpers * * Helper functions to schedule a function call to be made after a timeout. This * is useful to avoid making blocking calls while waiting for hardware to answer diff --git a/libfprint/fpi-ssm.c b/libfprint/fpi-ssm.c index 20a5f2f..2d679b2 100644 --- a/libfprint/fpi-ssm.c +++ b/libfprint/fpi-ssm.c @@ -28,6 +28,7 @@ /** * SECTION:fpi-ssm * @title: Sequential state machine + * @short_description: State machine helpers * * Asynchronous driver design encourages some kind of state machine behind it. * In most cases, the state machine is entirely linear - you only go to the diff --git a/libfprint/fpi-usb.c b/libfprint/fpi-usb.c index 8b06ebb..b140d7e 100644 --- a/libfprint/fpi-usb.c +++ b/libfprint/fpi-usb.c @@ -23,6 +23,7 @@ /** * SECTION:fpi-usb * @title: Helpers for libusb + * @short_description: libusb-related helpers * * A collection of [libusb helpers](http://libusb.sourceforge.net/api-1.0/group__poll.html#details) * to make driver development easier. Please refer to the libusb API documentation for more