From 983d4932f3e89bb2b621ec9ad1ef5553a11e6dd3 Mon Sep 17 00:00:00 2001 From: Audrey Diacre Date: Tue, 31 Jan 2012 14:28:45 +0000 Subject: [PATCH] documentation: add utils and examples and hide internal files. --- Doxyfile.in | 4 ++-- libnfc/additional-pages.dox | 8 ++++---- libnfc/chips/pn53x.c | 1 - libnfc/nfc.c | 10 +++++----- utils/mifare.c | 5 ++++- utils/mifare.h | 2 +- utils/nfc-utils.c | 5 ++++- 7 files changed, 20 insertions(+), 15 deletions(-) diff --git a/Doxyfile.in b/Doxyfile.in index f394562..d83ed57 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -578,7 +578,7 @@ WARN_LOGFILE = Doxygen.log # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @top_srcdir@/libnfc @top_srcdir@/examples @top_srcdir@/include +INPUT = @top_srcdir@/libnfc @top_srcdir@/examples @top_srcdir@/include/nfc @top_srcdir@/utils # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -603,7 +603,7 @@ FILE_PATTERNS = *.c \ # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. -RECURSIVE = YES +RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a diff --git a/libnfc/additional-pages.dox b/libnfc/additional-pages.dox index 339f845..0971a19 100644 --- a/libnfc/additional-pages.dox +++ b/libnfc/additional-pages.dox @@ -11,13 +11,13 @@ * Some commented examples that present how to use \b libnfc can be found here: * @subpage examples_page * - * Others example programs can be found in the libnfc source distribution under the "examples" subdirectory. + * Others example programs can be found in the libnfc source distribution under the "examples" subdirectory \ref examples. * - * You can also find utils in the libnfc source distribution under the "utils" subdirectory. + * You can also find utils in the libnfc source distribution under the "utils" subdirectory \ref utils. * * \section errorhandling Error handling * - * libnfc functions typically return 0 or more on success or a negative error code + * \b libnfc functions typically return 0 or more on success or a negative error code * on failure. These negative error codes relate to LIBNFC_ERROR constants * which are listed on the \ref error "Error reporting" documentation page. * @@ -29,7 +29,7 @@ /** * @page examples_page Examples * @section intro_sec Introduction - * This page present some examples to help developers which use \b libnfc. + * This page presents some examples to help developers which use \b libnfc. * * @section example_1_sec Simple tag UID reader. * This short commented code example should be helpful to quick start development with \b libnfc, it grab the first available NFC device and print the first found ISO14443-A tag (e.g. MIFARE Classic, MIFARE Ultralight). diff --git a/libnfc/chips/pn53x.c b/libnfc/chips/pn53x.c index 39fb96e..bdd774f 100644 --- a/libnfc/chips/pn53x.c +++ b/libnfc/chips/pn53x.c @@ -20,7 +20,6 @@ */ /** - * @internal * @file pn53x.c * @brief PN531, PN532 and PN533 common functions */ diff --git a/libnfc/nfc.c b/libnfc/nfc.c index 363b043..6b21a87 100644 --- a/libnfc/nfc.c +++ b/libnfc/nfc.c @@ -38,23 +38,23 @@ */ /** * @defgroup initiator NFC initiator - * act as "reader" + * This page details how to act as "reader". */ /** * @defgroup target NFC target - * act as tag (i.e. MIFARE Classic) or NFC target device. + * This page details how to act as tag (i.e. MIFARE Classic) or NFC target device. */ /** * @defgroup error Error reporting - * + * Most libnfc functions return 0 on success or one of error codes defined on failure. */ /** * @defgroup data Special data accessors - * + * The functionnality documented below allow to access to special data as device name or device connstring. */ /** * @defgroup properties Properties accessors - * + * The functionnality documented below allow to configure parameters and registers. */ /** * @defgroup misc Miscellaneous diff --git a/utils/mifare.c b/utils/mifare.c index d9ea0b0..be46e28 100644 --- a/utils/mifare.c +++ b/utils/mifare.c @@ -27,7 +27,10 @@ * Note that this license only applies on the examples, NFC library itself is under LGPL * */ - +/** + * @file mifare.c + * @brief provide samples structs and functions to manipulate MIFARE Classic and Ultralight tags using libnfc + */ #include "mifare.h" #include diff --git a/utils/mifare.h b/utils/mifare.h index 5260308..1b0a353 100644 --- a/utils/mifare.h +++ b/utils/mifare.h @@ -29,7 +29,7 @@ */ /** - * @file mifaretag.h + * @file mifare.h * @brief provide samples structs and functions to manipulate MIFARE Classic and Ultralight tags using libnfc */ diff --git a/utils/nfc-utils.c b/utils/nfc-utils.c index 2c9ace7..9278f05 100644 --- a/utils/nfc-utils.c +++ b/utils/nfc-utils.c @@ -27,7 +27,10 @@ * Note that this license only applies on the examples, NFC library itself is under LGPL * */ - +/** + * @file nfc-utils.c + * @brief Provide some examples shared functions like print, parity calculation, options parsing. + */ #include #include