documentation: add utils and examples and hide internal files.

This commit is contained in:
Audrey Diacre 2012-01-31 14:28:45 +00:00
parent 908fa416bf
commit 983d4932f3
7 changed files with 20 additions and 15 deletions

View file

@ -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

View file

@ -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).

View file

@ -20,7 +20,6 @@
*/
/**
* @internal
* @file pn53x.c
* @brief PN531, PN532 and PN533 common functions
*/

View file

@ -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

View file

@ -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 <string.h>

View file

@ -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
*/

View file

@ -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 <nfc/nfc.h>
#include <err.h>