2010-09-08 11:13:12 +02:00
/**
* @mainpage libnfc reference manual
*
* @section intro_sec Introduction
* This is the developer manual for \b libnfc.
2012-01-31 10:49:43 +01:00
* libnfc is an open source library that allows you to communicate with NFC devices. For more info, see the
2012-01-31 11:02:38 +01:00
* <a href="http://www.libnfc.org">libnfc homepage</a>.
2010-09-08 11:13:12 +02:00
*
* @section quick_start_sec Quick start
2012-01-31 10:49:43 +01:00
* If you are looking for libnfc's public API, you should start with the Modules page which links to the different categories of libnfc's functionality.
2010-09-08 11:13:12 +02:00
* Some commented examples that present how to use \b libnfc can be found here:
* @subpage examples_page
*
2012-01-31 15:28:45 +01:00
* Others example programs can be found in the libnfc source distribution under the "examples" subdirectory \ref examples.
2012-01-31 10:49:43 +01:00
*
2012-01-31 15:28:45 +01:00
* You can also find utils in the libnfc source distribution under the "utils" subdirectory \ref utils.
2012-01-31 10:49:43 +01:00
*
* \section errorhandling Error handling
*
2012-01-31 15:28:45 +01:00
* \b libnfc functions typically return 0 or more on success or a negative error code
2012-01-31 10:49:43 +01:00
* on failure. These negative error codes relate to LIBNFC_ERROR constants
* which are listed on the \ref error "Error reporting" documentation page.
*
2010-09-08 11:13:12 +02:00
* @section upgrading_sec Upgrading from previous version
* If you are upgrading from a previous \b libnfc version, please take care about changes, specially API changes.
* All important changes should be listed in @subpage changelog_page.
*/
/**
* @page examples_page Examples
* @section intro_sec Introduction
2012-01-31 15:28:45 +01:00
* This page presents some examples to help developers which use \b libnfc.
2010-09-08 11:13:12 +02:00
*
* @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).
* @include quick_start_example1.c
*/
/**
2010-09-08 11:16:24 +02:00
* @page changelog_page ChangeLog
2010-09-08 11:13:12 +02:00
* @verbinclude ChangeLog
*/