From 3dc5c4a6deabcc4c217fc2e8b5005db2ccd23d98 Mon Sep 17 00:00:00 2001 From: Bastien Nocera Date: Fri, 9 Nov 2018 15:06:54 +0100 Subject: [PATCH] doc: Add LIBFPRINT_DEPRECATED to the docs --- doc/libfprint-sections.txt | 1 + libfprint/fprint.h | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/doc/libfprint-sections.txt b/doc/libfprint-sections.txt index 7c6c983..103d010 100644 --- a/doc/libfprint-sections.txt +++ b/doc/libfprint-sections.txt @@ -3,6 +3,7 @@ fprint.h events Initialisation and events handling +LIBFPRINT_DEPRECATED fp_set_debug fp_init fp_exit diff --git a/libfprint/fprint.h b/libfprint/fprint.h index 49f19c1..c6efecc 100644 --- a/libfprint/fprint.h +++ b/libfprint/fprint.h @@ -29,6 +29,13 @@ extern "C" { #include #include +/** + * LIBFPRINT_DEPRECATED: + * + * Expands to the GNU C deprecated attribute if the compiler is `gcc`. When + * called with the `-Wdeprecated-declarations` option, `gcc` will generate warnings + * when deprecated interfaces are used. + */ #define LIBFPRINT_DEPRECATED __attribute__((__deprecated__)) /**