pax_global_header00006660000000000000000000000064136617235410014522gustar00rootroot0000000000000052 comment=f02ff51449240102c27a97173dc495e8e7789046 libnfc-libnfc-1.8.0/000077500000000000000000000000001366172354100142205ustar00rootroot00000000000000libnfc-libnfc-1.8.0/.gitignore000066400000000000000000000016701366172354100162140ustar00rootroot00000000000000**/.deps/ **/.libs/ **/Makefile **/Makefile.in *.exe *.la *.lo *.o *~ Doxyfile INSTALL aclocal.m4 ar-lib autom4te.cache/ build compile config.guess config.h config.h.in config.log config.status config.sub configure debian/ depcomp examples/nfc-anticol examples/nfc-dep-initiator examples/nfc-dep-target examples/nfc-emulate-forum-tag2 examples/nfc-emulate-tag examples/nfc-emulate-uid examples/nfc-mfsetuid examples/nfc-poll examples/nfc-relay examples/pn53x-diagnose examples/pn53x-sam examples/pn53x-tamashell examples/quick_start_example1 examples/quick_start_example2 install-sh libnfc.pc libtool ltmain.sh m4/libtool.m4 m4/ltoptions.m4 m4/ltsugar.m4 m4/ltversion.m4 m4/lt~obsolete.m4 missing stamp-h1 test-driver test/run-test.sh.log test/run-test.sh.trs test/test-suite.log utils/nfc-emulate-forum-tag4 utils/nfc-jewel utils/nfc-list utils/nfc-mfclassic utils/nfc-mfultralight utils/nfc-read-forum-tag3 utils/nfc-relay-picc utils/nfc-scan-device libnfc-libnfc-1.8.0/.travis.yml000066400000000000000000000006721366172354100163360ustar00rootroot00000000000000language: c compiler: - clang - gcc env: - BLD=cmake - BLD=autoconf addons: apt: packages: - libusb-dev - doxygen - cmake script: - if [ $BLD == autoconf ]; then autoreconf -vfi && mkdir build && cd build && ../configure --prefix=$HOME/.local/ && make -j2 && make install; fi - if [ $BLD == cmake ]; then mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX=~/.local .. && make -j2 && make install; fi libnfc-libnfc-1.8.0/AUTHORS000066400000000000000000000036121366172354100152720ustar00rootroot00000000000000# Alphabetical cleaned output of "git shortlog -s -e|cut -c 8-" : Adam Laurie Ahti Legonkov Alex Lian Alexander Inyukhin Anugrah Redja Kusuma Audrey Diacre Boris Moiseev Christoph Gritschenberger Dario Carluccio David Kreitschmann Emanuele Bertoldi Emmanuel Dreyfus Eugeny Boger Francois Kooman Frank Morgner Frédéric Bourgeois Hidde Wieringa Jairo Andres Suarez Jiapeng Li Jim Anastassiou John Galt Julien Ehrhart Julien Schueller Laurent Latil Ludovic Rousseau Marcello Morena Marcos Vives Del Sol Mati Vait Maxim Martyanov Mike Auty Nobuhiro Iwamatsu Olliver Schinagl Paul Menzel Peter Meerwald Philippe Teuwen Pim 't Hart Ray Lee Roel Verdult Romain Tartiere Romuald Conty Simon Yorkston bhack lego quantum-x timzi xantares xaqq yerzhanm libnfc-libnfc-1.8.0/CMakeLists.txt000066400000000000000000000263571366172354100167750ustar00rootroot00000000000000cmake_minimum_required (VERSION 2.6) if (NOT DEFINED CMAKE_BUILD_TYPE) set (CMAKE_BUILD_TYPE Release CACHE STRING "Build type") endif () project (libnfc C) SET(VERSION_MAJOR "1") SET(VERSION_MINOR "8") SET(VERSION_PATCH "0") SET(VERSION "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}") SET(PACKAGE_NAME "libnfc") SET(PACKAGE_VERSION ${VERSION}) SET(PACKAGE_STRING "${PACKAGE_NAME} ${PACKAGE_VERSION}") # config.h IF(WIN32) CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/cmake/config_windows.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config.h) SET(LIBNFC_SYSCONFDIR "${CMAKE_INSTALL_PREFIX}/config" CACHE PATH "libnfc configuration directory") INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR}/contrib/win32) ELSE(WIN32) SET(_XOPEN_SOURCE 600) SET(SYSCONFDIR "/etc" CACHE PATH "System configuration directory") CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/cmake/config_posix.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config.h) ENDIF(WIN32) INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR}) ADD_DEFINITIONS("-DHAVE_CONFIG_H") INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/include) # make it easy to locate CMake modules for finding libraries list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake/modules/") # Options option (LIBNFC_LOG "Enable log facility (errors, warning, info and debug messages)" ON) IF(LIBNFC_LOG) ADD_DEFINITIONS(-DLOG) ENDIF(LIBNFC_LOG) option (LIBNFC_ENVVARS "Enable envvars facility" ON) IF(LIBNFC_ENVVARS) ADD_DEFINITIONS(-DENVVARS) ENDIF(LIBNFC_ENVVARS) SET(LIBNFC_DEBUG_MODE OFF CACHE BOOL "Debug mode") IF(LIBNFC_DEBUG_MODE) ADD_DEFINITIONS(-DDEBUG) SET(CMAKE_C_FLAGS "-g3 ${CMAKE_C_FLAGS}") SET(WIN32_MODE "debug") SET(CMAKE_RC_FLAGS "-D_DEBUG ${CMAKE_RC_FLAGS}") ELSE(LIBNFC_DEBUG_MODE) SET(WIN32_MODE "release") ENDIF(LIBNFC_DEBUG_MODE) option (LIBNFC_CONFFILES_MODE "Enable configuration files" ON) IF(LIBNFC_CONFFILES_MODE) ADD_DEFINITIONS(-DCONFFILES) ENDIF(LIBNFC_CONFFILES_MODE) option (BUILD_EXAMPLES "build examples ON/OFF" ON) option (BUILD_UTILS "build utils ON/OFF" ON) option (BUILD_DEBPKG "build debian package ON/OFF" OFF) # Doxygen SET(builddir "${CMAKE_BINARY_DIR}") SET(top_srcdir "${CMAKE_SOURCE_DIR}") INCLUDE(UseDoxygen) IF(DEFINED CMAKE_INSTALL_LIBDIR) SET(libdir ${CMAKE_INSTALL_LIBDIR}) ELSE(DEFINED CMAKE_INSTALL_LIBDIR) SET(CMAKE_INSTALL_LIBDIR lib) SET(libdir ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}) ENDIF(DEFINED CMAKE_INSTALL_LIBDIR) IF(DEFINED INCLUDE_INSTALL_DIR) SET(includedir ${INCLUDE_INSTALL_DIR}) ELSE(DEFINED INCLUDE_INSTALL_DIR) SET(INCLUDE_INSTALL_DIR include) SET(includedir ${CMAKE_INSTALL_PREFIX}/${INCLUDE_INSTALL_DIR}) ENDIF(DEFINED INCLUDE_INSTALL_DIR) IF(NOT DEFINED SHARE_INSTALL_PREFIX) SET(SHARE_INSTALL_PREFIX share) ENDIF(NOT DEFINED SHARE_INSTALL_PREFIX) # Additonnal GCC flags IF(CMAKE_COMPILER_IS_GNUCC) # Make sure we will not miss some warnings ;) SET(CMAKE_C_FLAGS "-Wall -pedantic -std=c99 ${CMAKE_C_FLAGS}") ENDIF(CMAKE_COMPILER_IS_GNUCC) # Workarounds for libusb in C99 ADD_DEFINITIONS(-Du_int8_t=uint8_t -Du_int16_t=uint16_t) IF(MINGW) IF (CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows") # force MinGW-w64 in 32bit mode SET(CMAKE_C_FLAGS "-m32 ${CMAKE_C_FLAGS}") SET(CMAKE_MODULE_LINKER_FLAGS "-m32 -Wl,--enable-stdcall-fixup ${CMAKE_SHARED_LINKER_FLAGS}") SET(CMAKE_SHARED_LINKER_FLAGS "-m32 -Wl,--enable-stdcall-fixup ${CMAKE_SHARED_LINKER_FLAGS}") SET(CMAKE_EXE_LINKER_FLAGS "-m32 -Wl,--enable-stdcall-fixup ${CMAKE_EXE_LINKER_FLAGS}") SET(CMAKE_RC_FLAGS "--target=pe-i386 --output-format=coff ${CMAKE_RC_FLAGS}") ELSE(CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows") IF(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86") # force MinGW-w64 in 32bit mode MESSAGE("Building 32-bit Windows DLL") #SET(CMAKE_C_FLAGS "-m32 ${CMAKE_C_FLAGS}") #SET(CMAKE_MODULE_LINKER_FLAGS "--Wl,--enable-stdcall-fixup ${CMAKE_SHARED_LINKER_FLAGS}") #SET(CMAKE_SHARED_LINKER_FLAGS "--Wl,--enable-stdcall-fixup ${CMAKE_SHARED_LINKER_FLAGS}") #SET(CMAKE_EXE_LINKER_FLAGS "--Wl,--enable-stdcall-fixup ${CMAKE_EXE_LINKER_FLAGS}") SET(CMAKE_RC_FLAGS "--target=pe-i386 --output-format=coff ${CMAKE_RC_FLAGS}") ELSEIF(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64") MESSAGE("Building 64-bit Windows DLL") SET(CMAKE_RC_FLAGS "--target=pe-x86-64 --output-format=coff ${CMAKE_RC_FLAGS}") ELSE(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86") MESSAGE(FATAL_ERROR "Unknown Processor: ${CMAKE_SYSTEM_PROCESSOR}") ENDIF(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86") ENDIF(CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows") FIND_PROGRAM(DLLTOOL dlltool CMAKE_FIND_ROOT_PATH_BOTH) IF (NOT DLLTOOL) MESSAGE(FATAL_ERROR "Could not find dlltool command") ENDIF (NOT DLLTOOL) ENDIF(MINGW) IF(NOT WIN32) # Set some pkg-config variables SET(prefix ${CMAKE_INSTALL_PREFIX}) SET(exec_prefix ${CMAKE_INSTALL_PREFIX}) SET(PACKAGE "libnfc") IF(LIBNFC_DRIVER_PN53X_USB) SET(PKG_REQ ${PKG_REQ} "libusb") ENDIF(LIBNFC_DRIVER_PN53X_USB) IF(LIBNFC_DRIVER_PCSC) SET(PKG_REQ ${PKG_REQ} "libpcsclite") ENDIF(LIBNFC_DRIVER_ACR122) IF(LIBNFC_DRIVER_ACR122_PCSC) SET(PKG_REQ ${PKG_REQ} "libpcsclite") ENDIF(LIBNFC_DRIVER_ACR122_PCSC) # CMake lists are separated by a semi colon, replace with colon STRING(REPLACE ";" "," PKG_CONFIG_REQUIRES "${PKG_REQ}") CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/libnfc.pc.in ${CMAKE_CURRENT_BINARY_DIR}/libnfc.pc @ONLY) INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/libnfc.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) ENDIF(NOT WIN32) INCLUDE(LibnfcDrivers) IF(UNIX AND NOT APPLE) IF(I2C_REQUIRED) # Inspired from http://cmake.3232098.n2.nabble.com/RFC-cmake-analog-to-AC-SEARCH-LIBS-td7585423.html INCLUDE (CheckFunctionExists) INCLUDE (CheckLibraryExists) CHECK_FUNCTION_EXISTS (clock_gettime HAVE_CLOCK_GETTIME) IF (NOT HAVE_CLOCK_GETTIME) CHECK_LIBRARY_EXISTS (rt clock_gettime "" HAVE_CLOCK_GETTIME_IN_RT) IF (HAVE_CLOCK_GETTIME_IN_RT) SET(LIBRT_FOUND TRUE) SET(LIBRT_LIBRARIES "rt") ENDIF (HAVE_CLOCK_GETTIME_IN_RT) ENDIF (NOT HAVE_CLOCK_GETTIME) ENDIF(I2C_REQUIRED) ENDIF(UNIX AND NOT APPLE) IF(PCSC_INCLUDE_DIRS) INCLUDE_DIRECTORIES(${PCSC_INCLUDE_DIRS}) LINK_DIRECTORIES(${PCSC_LIBRARY_DIRS}) ENDIF(PCSC_INCLUDE_DIRS) IF(LIBUSB_INCLUDE_DIRS) INCLUDE_DIRECTORIES(${LIBUSB_INCLUDE_DIRS}) LINK_DIRECTORIES(${LIBUSB_LIBRARY_DIRS}) SET(LIBUSB_FOUND TRUE) ENDIF(LIBUSB_INCLUDE_DIRS) # version.rc for Windows IF(WIN32) # Date for filling in rc file information IF (CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows") MACRO (GET_CURRENT_YEAR RESULT) EXECUTE_PROCESS(COMMAND "cmd" " /C date /T" OUTPUT_VARIABLE ${RESULT}) STRING(REGEX REPLACE "\n" "" ${RESULT} ${${RESULT}}) STRING(REGEX REPLACE ".*(..)/(..)/(....).*" "\\3" ${RESULT} ${${RESULT}}) ENDMACRO (GET_CURRENT_YEAR) ELSE(CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows") MACRO (GET_CURRENT_YEAR RESULT) EXECUTE_PROCESS(COMMAND "date" "+%Y" OUTPUT_VARIABLE ${RESULT}) STRING(REGEX REPLACE "\n" "" ${RESULT} ${${RESULT}}) ENDMACRO (GET_CURRENT_YEAR) ENDIF(CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows") GET_CURRENT_YEAR(CURRENT_YEAR) MESSAGE("Year for copyright is " ${CURRENT_YEAR}) SET(prefix ${CMAKE_INSTALL_PREFIX}) SET(RC_COMMENT "${PACKAGE_NAME} library") SET(RC_INTERNAL_NAME "${PACKAGE_NAME} ${WIN32_MODE}") SET(RC_ORIGINAL_NAME ${PACKAGE_NAME}.dll) SET(RC_FILE_TYPE VFT_DLL) CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/contrib/win32/version.rc.in ${CMAKE_CURRENT_BINARY_DIR}/windows/libnfc.rc @ONLY) ENDIF(WIN32) ADD_SUBDIRECTORY(libnfc) ADD_SUBDIRECTORY(include) if (BUILD_UTILS) add_subdirectory (utils) endif () if (BUILD_EXAMPLES) add_subdirectory (examples) endif () if (NOT MSVC) # config script install path if ( NOT DEFINED LIBNFC_CMAKE_CONFIG_DIR ) set ( LIBNFC_CMAKE_CONFIG_DIR lib${LIB_SUFFIX}/cmake/libnfc ) endif () set ( LIBNFC_INCLUDE_DIR ${includedir} ) set ( LIBNFC_INCLUDE_DIRS ${LIBNFC_INCLUDE_DIR} ) list ( APPEND LIBNFC_INCLUDE_DIRS ${LIBUSB_INCLUDE_DIRS} ) set ( LIBNFC_LIBRARY nfc ) set ( LIBNFC_LIBRARIES ${LIBNFC_LIBRARY} ) list ( APPEND LIBNFC_LIBRARIES ${LIBUSB_LIBRARIES} ) set ( LIBNFC_LIBRARY_DIRS ${libdir} ) set ( LIBNFC_ROOT_DIR ${prefix} ) set ( LIBNFC_VERSION_STRING ${VERSION} ) set ( LIBNFC_VERSION_MAJOR ${VERSION_MAJOR} ) set ( LIBNFC_VERSION_MINOR ${VERSION_MINOR} ) set ( LIBNFC_VERSION_PATCH ${VERSION_PATCH} ) set ( LIBNFC_USE_FILE ${CMAKE_INSTALL_PREFIX}/${LIBNFC_CMAKE_CONFIG_DIR}/UseLibNFC.cmake ) if(CMAKE_VERSION VERSION_LESS 2.8.8) configure_file ( cmake/LibNFCConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/LibNFCConfig.cmake @ONLY ) configure_file ( cmake/LibNFCConfigVersion.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/LibNFCConfigVersion.cmake @ONLY ) else () include(CMakePackageConfigHelpers) configure_package_config_file ( cmake/LibNFCConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/LibNFCConfig.cmake INSTALL_DESTINATION ${LIBNFC_CMAKE_CONFIG_DIR} PATH_VARS LIBNFC_USE_FILE LIBNFC_ROOT_DIR LIBNFC_INCLUDE_DIR LIBNFC_INCLUDE_DIRS LIBNFC_LIBRARY_DIRS NO_CHECK_REQUIRED_COMPONENTS_MACRO ) write_basic_package_version_file ( LibNFCConfigVersion.cmake VERSION ${LIBNFC_VERSION_STRING} COMPATIBILITY AnyNewerVersion ) endif () install ( FILES ${CMAKE_CURRENT_BINARY_DIR}/LibNFCConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/LibNFCConfigVersion.cmake cmake/UseLibNFC.cmake DESTINATION ${LIBNFC_CMAKE_CONFIG_DIR} ) endif () # Binary Package IF(WIN32) SET(CPACK_GENERATOR "ZIP") ELSE(WIN32) SET(CPACK_GENERATOR "TBZ2") IF(BUILD_DEBPKG) SET(CPACK_GENERATOR "DEB") ENDIF(BUILD_DEBPKG) ENDIF(WIN32) SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Near Field Communication (NFC) library") SET(CPACK_PACKAGE_VENDOR "Roel Verdult") SET(CPACK_PACKAGE_CONTACT "Roel Verdult ") #Readme file IF(WIN32) SET(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README-Windows.md") ELSE(WIN32) SET(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README.md") ENDIF(WIN32) SET(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/COPYING") SET(CPACK_PACKAGE_INSTALL_DIRECTORY "libnfc") SET(CPACK_PACKAGE_VERSION_MAJOR ${VERSION_MAJOR}) SET(CPACK_PACKAGE_VERSION_MINOR ${VERSION_MINOR}) SET(CPACK_PACKAGE_VERSION_PATCH ${VERSION_PATCH}) SET(CPACK_COMPONENT_LIBRARIES_DISPLAY_NAME "NFC Library") SET(CPACK_COMPONENT_EXAMPLES_DISPLAY_NAME "Example Applications") SET(CPACK_COMPONENT_HEADERS_DISPLAY_NAME "Development Headers") IF(NOT WIN32) SET(CPACK_COMPONENT_MANUALS_DISPLAY_NAME "Example Applications Manuals") SET(CPACK_COMPONENT_MANUALS_DISABLED TRUE) SET(CPACK_COMPONENT_MANUALS_DEPENDS examples) ENDIF(NOT WIN32) SET(CPACK_COMPONENT_HEADERS_DISABLED TRUE) SET(CPACK_COMPONENT_HEADERS_DEPENDS libraries) SET(CPACK_COMPONENT_EXAMPLES_DEPENDS libraries) # Source Package IF(WIN32) SET(CPACK_SOURCE_GENERATOR "ZIP") ELSE(WIN32) SET(CPACK_SOURCE_GENERATOR "ZIP;TBZ2") ENDIF(WIN32) SET(CPACK_SOURCE_PACKAGE_FILE_NAME "libnfc-${VERSION}") SET(CPACK_SOURCE_IGNORE_FILES "~$" "/\\\\.git/" "bin/") INCLUDE(CPack) libnfc-libnfc-1.8.0/COPYING000066400000000000000000000167251366172354100152660ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. libnfc-libnfc-1.8.0/ChangeLog000066400000000000000000001146561366172354100160070ustar00rootroot00000000000000May 22, 2020 - 1.8.0 -------------------- Fixes: - Restore nfc_modulation_type enum order to keep compatibility with libnfc 1.7.1 Changes: - Bump revision due to changes in API introduced in v1.7.2 - Bump library version to 6.0.0 May 21, 2020 - 1.7.2 (avoid using it, incompatible with 1.7.1) -------------------- Fixes: - Remove unreachable code - nfc_emulate_uid: cleaner exit on interrupt - Fix reporting of modulations and baud rates by nfc-scan-device -v - Fix out-of-bounds access in nfc-mfultralight - Several Cygwin compilation fixes - Fix comparison when nfc_initiator_target_is_present() with a specified target - Fix nfc_initiator_poll_target without tag on PN532 - Export iso14443b* symbols - Fix udev rule which was executed too early - Fix improper device name initialization - Fix setenv()/unsetenv() for Windows - Fix win32/nfc.def according to nfc.h - Fix missing timeout in pn53x_initiator_select_passive_target() - nfc-mfclassic: fix option to tolerate write errors - nfc-poll: fix card removing check - nfc-relay-picc: fix wrong open mode for file descriptor Improvements: - Allow ISO14443A to be used at higher baud rates - nfc_initiator_select_passive_target() now checks against reported modulations and baud rates for current device - More serial devices on MAC OS X - Add section to README to help to configure libnfc - Various cmake improvements - Drop PCRE dependency on Windows - Remove deprecated readdir_r - Markdown conversion of the text files - Use hardcoded PN533 descriptors to be more robust on Windows - Add support for SCL3712 - Add support for ACR1222U-C1 - Add support for NetBSD - Add support for PN532 on RPi3 UART - Add support for cross-compilation of 32b & 64b versions of the library for Windows - Add pn533_usb to the kernel modules blacklist - Add support for pn71xx NXP's NFC Controllers through Linux Libnfc-nci (untested) - Add support for contactless PC/SC readers (only as initiator) - Add support for Feitian R502 and bR500 into pcsc driver - Add support for HID iClass (Picopass) support (nfc-iclass tool in external nfc-tools repo) - Allows for sending empty data in nfc_initiator_transceive_bits - driver i2c: respect proper timing specifications - driver i2c: add retry on error mechanism - nfc-mfclassic: improvements fo magic cards - nfc-mfclassic: add option to specify UID - nfc-mfclassic/nfc-mfsetuid: add support for new gen (1b) of magic 4K cards - nfc-mfclassic: Add RATS support indicator - nfc-mfsetuid: allow to write complete Block0, instead of only UID - nfc-mfultralight: add automatic modes and --check-magic - nfc-mfultralight: add support for magic gen2 cards - nfc-mfultralight: add option to specify UID - nfc-mfultralight: add support for Ultralight NTAG213/215/216 - nfc-barcode: new command to read and decode NFC Barcodes (Tag-Talks-First) Changes: - nfc_device_get_supported_baud_rate() takes now a "mode" parameter - New nfc_device_get_supported_baud_rate_target_mode() - New NFC modulation type NMT_BARCODE and nfc_barcode_info struct to support Thinfilm NFC Barcode protocol - New NFC modulation type NMT_ISO14443BICLASS and NMT_ISO14443BICLASS struct to support HID iClass (Picopass) - pn53x_transceive() is now part of public API Special thanks to: - Jim Anastassiou, Frédéric Bourgeois, Dario Carluccio, Emmanuel Dreyfus, Julien Ehrhart, S. Fabri, John Galt, Christoph Gritschenberger, Alexander Inyukhin, Arnaud Kapp, David Kreitschmann, Adam Laurie, Ray Lee, Maxim Martyanov, Paul Menzel, Boris Moiseev, Yerzhan Mukhamejan, Olliver Shinagl, Jairo Andres Suarez, Mati Vait, Marcos Vives Del Sol, Hidde Wieringa, Simon Yorkston, timzi, usk-johnny-s, xantares, Hanno Heinrichs, jgeslin, Mikolaj Stawiski, rstular, Khem Raj, Frank Morgner, jpwidera, Feitian Technologies Feb 24, 2014 - 1.7.1 -------------------- Fixes: - Fix several issues reported by Coverity Scan (mem leaks, buff overflows, reuse after free, etc) - More robust when several conflicting uart drivers are in the config - Fix racing condition with uart_flush_input() - Silent pn53x_check_communication error messages when scanning - Fix nfc_target_init(), was returning success in case of timeout - Windows: fix several compilation issues - On tag selection, save current target info also for ISO14443B* - nfc-read-forum-tag3: fix incomplete NDEF retrieval and size of output file Improvements: - nfc-list: New option to choose which technologies to poll for - UART: drivers now supported under kFreeBSD - New LIBNFC_DEVICE env var to use one reader and exclude all other readers while LIBNFC_DEFAULT_DEVICE only prepends it to the configured devices list - New LIBNFC_AUTO_SCAN env var to enable(default)/disable auto scan - On tag selection, save current target info even if pnt=NULL - On tag selection, grant NP_INFINITE_SELECT also for ISO14443B* - Save & restore NP_INFINITE_SELECT status when changing it internally - nfc-mfclassic: add format/wipe command (thanks to Adam Laurie) - nfc-jewel: new utility to read/write Topaz/Jewel tags (thanks to Pim 't Hart) - nfc_initiator_select_passive_target() provides defaults if pbtInitData=NULL - nfc-read-forum-tag3: add -q option, add full parsing of NDEF Attribute Block Fixes & improvements specific to nfc_initiator_target_is_present(): - Supports fully PN532 & PN533, not tested on other chips - Fix usage after nfc_initiator_poll_target() - Set correctly last_error - Fix issue when there was no saved target - Allow NULL pointer to tag - Fix issues in case of tear off conditions - Now works with: * MFUL, MFC, MFC Mini, MFC 7-byte (re-selection: you'll need to auth again) * ISO14443-4A, ISO14443-4B * ISO14443-4B', ASK CTx, ST SRx * Jewel * FeliCa Sep 03, 2013 - 1.7.0 -------------------- Fixes: - pn53x: only create a current target when at least one have been found - pn532_uart: fix 'operation abort' feature with this driver - pn532_uart: let more time to PN532 to wake-up, this fix some specific cases where PN532 shown one of two runs (Thanks to Marcello Morena) - nfc-mfclassic: allow option f for read operation too - Avoid clash with system's htole32 if it exists - Include , required for getenv(3) - usb: fix USB enumeration issue (Thanks to Mike Auty) - acr122_pcsc: fix compilation on Mac OSX 10.8.4 - Fix pn53x_initiator_transceive_bytes_timed() measures for TypeB - Various minor fixes: warnings, style, etc. Improvements: - New PN532 over I2C driver, see contrib/libnfc/pn532_i2c_on_rpi.conf.sample - ACR122/Touchatag: misc improvements - ReadMobib/ReadNavigo: improve shell script portability - Add ISO14443-4 chaining support for RX (MI) - UART: add support for BeagleBone serial ports (Thanks to Johan Henselmans) - nfc-mfultralight: allow setting of UID for special 'chinese' ultralight cards Special thanks to: - Laurent Latil (new pn532_i2c driver for linux) - Nobuhiro Iwamatsu (warning fixes and debian package) Apr 05, 2013 - 1.7.0-rc7 (release candidate) -------------------------------------------- Fixes: - Fix bug when compiling without libusb - Fix several memory leaks in error handling conditions - Remove calls to exit() from the library - Create safer snprint_nfc_*() instead of sprint_nfc_*() functions - Fix warnings returned by cppcheck & clang/scan-build - Obsolete function 'usleep' => nanosleep() - Non reentrant function 'readdir' => readdir_r() - Non reentrant function 'strtok' => new connstring_decode() - Buffer may not be null-terminated after call to strncpy() - scanf without field width limits can crash with huge input data - Resource leaks: missing fclose() - Dead code, unused vars & vars scopes warnings - Unify copyright notices & update authors lists - Windows: Fix compilation due to new usbbus file - Windows: Clean up compiler/linker warnings - Fixed the suppression of the auto-fixup for linking against MS built libs - Fixed all the formatting warnings by shifting to inttypes.h specifiers - shifted to %lu for DWORD printf - nfc-anticol: fix ATS length - nfc-mfclassic: fix reporting of processed blocks total - nfc-mfclassic: detect MIFARE Plus 2K as 2K instead of 1K - pn53x_usb/acr122_usb: check usb_open() returns before using it Improvements: - New PN532 over SPI driver, see contrib/libnfc/pn532_spi_on_rpi.conf.sample - Devels HACKING file: introduce clang/scan-build & cppcheck for better code - Better internal dependencies handling (bus <> drivers) - Cleaner handling of portability patches - Windows: logging via OutputDebugString(), ease debugging - nfc-mfclassic: use smaller files for cards < 4k - nfc-mfclassic: by defaut don't authorise wrong keyfile, use "f" to force - quick_start_example1.c: remove err.h dependency, easier for Windowsians - nfc-mfclassic: support some new magic cards with writeable sector #0 - nfc-anticol: add -t option to use timed functions Changes: - Upon malloc error, nfc_init() doesn't force exit() anymore so now you should test if context != NULL after nfc_init() call - API: nfc_initiator_target_is_present() & str_nfc_target() now take a pointer to nfc_target as argument instead of passing by value Special thanks to: - Eugeny Boger (new pn532_spi driver for linux) Mar 03, 2013 - 1.7.0-rc6 (release candidate) -------------------------------------------- Fixes: - Fix several memory leaks (nfc_drivers, libusb, config parser) - Fix stack smash while displaying long data transmission (LOG_HEX) - pn53x-tamashell: allow larger commands up to full extended frame - Add missing windows file in archive (version.rc.in) - Fix compilation warnings & potential bugs - Fix documentation - Fix missing malloc() calls checks - Fix missing free() calls in some error handlers Improvements: - Allow to disable conffils & envvar supports on embedded platforms - Add option to nfc-mfclassic to tolerate RW errors Changes: - Replace usb_set_debug() in applications by LIBNFC_LOG_LEVEL libusb group Feb 16, 2013 - 1.7.0-rc5 (release candidate) -------------------------------------------- Fixes: - Add missing sample configuration file in archive - Add missing windows files in archive - Preserve error code while using pn53x_set_property_bool() with NP_AUTO_ISO14443_4 flag Improvements: - New nfc_register_driver() function allowing to hook custom drivers - New nfc_free() function to free allocated buffers Special thanks to: - Ahti Legonkov (new nfc_register_driver()) Feb 04, 2013 - 1.7.0-rc4 (release candidate) -------------------------------------------- Fixes: - Fix tag selection for nfc-mfclassic, nfc-mfultralight, nfc-read-forum-tag3 and nfc-relay-picc - Fix crash in nfc-relay-picc -i/-t if fd3 or fd4 is missing Improvements: - Windows support build with CMake Changes: - Configuration directory (ie. libnfc.conf) can now be set a compile-time - Log can be enabled/disabled using CMake Special thanks to: - Alex Lian (Windows support improvements) - Nobuhiro Iwamatsu (Debian package improvements) Jan 31, 2013 - 1.7.0-rc3 (release candidate) -------------------------------------------- Fixes: - Fix pn53x_usb bulk write timeout - Fix BCC in nfc-emulate-uid example - Fix nfc-relay-picc example - Fix a miss returned value within some internal functions (user program could be affected) - Fix nfc-scan-device -i option - Remove wrong exit() calls in library - Fix issue in driver acr122_usb affecting Touchatag - Reenable some idle in all drivers, add selectively PowerDown when possible Changes: - nfc_emulate_target() now takes timeout parameter Special thanks to: - Alex Lian (Windows support refresh) Jan 20, 2013 - 1.7.0-rc2 (release candidate) -------------------------------------------- Fixes: - Fix API version in debian files - Fix wrong condition to display a warning when user disables autoscan - Fix unit tests - Fix ISO14443B' ATS Improvements: - Allow device.optional=true to tolerate missing device Changes: - pn532_uart driver is now enabled by default Dec 09, 2012 - 1.7.0-rc1 (release candidate) -------------------------------------------- Fixes: - nfc_initiator_deselect_target() now returns 0 on success (as expected by caller) - example/pn532-sam: Fix few bugs - Fix ACR122S device detection when no ACR122S device available (endless UART receive) - Suppress a lot of compiler warnings !.. which fixes many potential bugs - Display right driver name while detecting PCSC - Correctly handle PCSC header files on Mac OS X - Fix nfc-emulation (now works with utils/nfc-emulate-forum-tag4 and Nexus S) Improvements: - New nfc_initiator_init_secure_element() function to set SAM as wired card (only relevant with a PN532 SAM-equipped) - New str_nfc_target(), str_nfc_modulation_type(), str_nfc_baud_rate() function to convert some libnfc's types into allocated string - New nfc_device_target_is_present() to check if passed target is in the field - --enable-serial-autoprobe option at compile time to replace it with some run-time options - New -i option to nfc-scan-device to allow intrusive scan - New feature, libnfc now uses configuration files: * main configuration file can be used to set options (ie. intrusive, autoscan, log-level) * main configuration file can contains a device as default device, HIGHLY recommended for UART devices users * multiple devices files can be used to declare multiple devices and ordered them - UART port scan now includes ttyAMA* to detect UART-devices connected on Raspberry Pi (e.g. `nfc-scan-device -i`) - Support for OpenPCD2 (with a dedicated firmware) - Support for FTDI dongle under MacOS - Enhance messages display - Provides modprobe configuration file and instructions for Linux >3.1 with PN533 users. - Greatly improve log facility with log level filter, configurable using conf file (ie. /etc/nfc/libnfc.conf) or environment var LIBNFC_LOG_LEVEL - New man page for nfc-read-forum-tag3 utility (Thanks to UNFORGiVEN512) - New man page for nfc-scan-device utility - New man page for nfc-emulate-forum-tag2 example - README: Add few words about device permissions and udev/devd rules available in package - utils/nfc-emulate-forum-tag4: add support for v2.0 of the spec - New "make style" command to have a beautiful code - Code cleanup (indentation, white spaces, etc.) Changes: - New nfc_device_get_information_about() now allocates returned string - No more in/out paramaters in nfc_initiator_transceive_*() functions - Rename nfc-probe to nfc-scan-device - Rename abtUid from struct mifare_param_auth into abtAuthUid: this is not the UID while using 7-bytes UID MIFARE Classic tags. - utils/nfc-list: always display the card type when a card is found - nfc-utils: new fingerprinting method closer to AN10833, (Thanks to Balazs Bucsay) See NEWS file for major changes (ie. API changes) Special thanks to: - Ludovic Rousseau (Code cleanup, tests under MacOS, etc.) - Frank Morgner Feb 27, 2012 - 1.6.0-rc1 (release candidate) -------------------------------------------- Fixes: - utils/nfc-mfclassic: use MIFARE instead of Mifare typo - utils/nfc-list: continue to attempt to reach devices after a connection failure - libnfc: avoid readline auto-detection when cross-compiling - driver/pn53x_usb: fix path usage for FreeBSD - doc: quick_start_example1.c fixed - utils/*: verbose option back for nfc-list, and newly implemented in nfc-poll Improvements: - libnfc: enhanced documentation - libnfc: debug facility back without external depends - libnfc: add nfc_device_get_supported_modulation() and nfc_device_get_supported_baud_rate() functions - libnfc: enhanced code indent - drivers: implement driver for ACR122S device - utils/nfc-mfclassic: remove non-conscistent "extract payload" option in nfc-mfclassic - utils/nfc-emulate-forum-tag2: add missing manpage - utils/nfc-read-forum-tag3: add missing manpage - tests/*: fix some warnings in test - tests/test_dep*: add some DEP tests (Active/Passive in several baud rates) - doc: quick_start_example1 is now compiled when running make check or distcheck - libnfc: a printf-based logging replaces log4c - libnfc: various minor fixes/enhancements - utils/*: nfc-probe example added to show devices connection strings Changes: - PN53x specific errors are not public anymore; - Timeouts are now integers instead of timeval structure - Removes libusb types workaround (r200) as it seems to not be needed anymore but may disturb compiler - Removes parse_args() from nfc-utils.[hc] - Move nfc-emulate-forum-tag2 from utils to examples. - contrib: move udev and devd files into contrib/ - debian: udev rules file renamed See NEWS file for major changes (ie. API changes) Special thanks to: - Thomas Hood (Debian packages and various fixes/contributions) - Anugrah Redja (ACR122S driver) Oct 17, 2011 - 1.5.1 (unstable) ------------------------------- Fixes: - libnfc: fix invalid memory access when a new driver is probing for hardware and the number of requested devices was already reached - chips/pn53x: fix bug in _timed fcts - drivers/pn53x_usb: fix crash when usb_bulk_read() fails. - drivers/pn53x_usb: continue to search a available device on usb errors (ie. Device Busy) - drivers/pn53x_usb: make PN53x usb connection more stable - examples/nfc-relay: fix UID problem - windows: fix uart_receive() under Win32 platform Improvements: - libnfc: add logging facility using log4c. - libnfc: abort mecanism is now implemented in driver layer, so it can use pipe-based mecanism (as PN532_UART or ARYGON driver does under POSIX system) or flag-based mecanism. - libnfc: add ISO/IEC 14443 B' aka Type B' modulation partial support - libnfc: add partial support (list) for ISO14443B-3 ST SRx & ASK CTx cards - libnfc: compile unit tests only on demand unless using --enable-debug. - libnfc: error handling improvements - libnfc: new function nfc_idle() to set the NFC device in idle mode - libnfc: add partial support for Sony S360 reader - libnfc: some manual test reports have been added - libnfc: list_targets support for ASK CTS512B (no anticol support yet) - libnfc: nfc_disconnect() now switches NFC device into idle before disconnecting - libnfc: nfc_initiator_poll_target() is now available for all devices - libnfc: implement software polling for non-PN532 equipped device - chips/pn53x: add pn53x_data_new() function to alloc and init pn53x_data structure - chips/pn53x: add some SFR registers description - chips/pn53x: implement WriteBack cache - chips/pn53x: new pn53x_PowerDown wrapper for PowerDown (PN532) command - chips/pn53x: prints a debug trace when reading PN53x registers - chips/pn53x: set some parameters in ISO/IEC 14443A when using DEP mode (ie. SAK says ISO/IEC 18092 compliant) (Android NFC stack now detects the target as DEP) - chips/pn53x: some optimisations in registers initialisation - chips/pn53x: list_passive_targets() fixed for TypeB on LoGO - chips/pn53x: pn53x_data now have a operating_mode enum to know the current running mode (initiator, target or idle) - drivers/*: all commands are now abortable - drivers/pn532_uart,arygon: make valgrind happy with UART-based drivers - drivers/pn53x*: use shared pn53x_ack_frame[] and pn53x_nack_frame[] instead of local declaration - drivers/pn53x_usb: all USB errors are now reported in text format - drivers/pn53x_usb: enable progressive field on init to allow pn53x-tamashell to works (note: it does not distrib progressive field enabling when nfc_list_passive_target() is used) - drivers/pn53x_usb: implement PN53x extended information frames with USB devices - drivers/pn53x_usb: use progressive field on/off only for ISO14443 Type B target listing - buses/uart: now provides an abort mecanism for windows users - buses/uart: UART based drivers could now use uart_flush_input() to discard junk bytes on input. - examples/nfc-anticol: add -f option to force RATS - examples/nfc-mfclassic: handle 7-byte UID cards & MFC Mini - examples/nfc-anticol: now use nfc_abort_command() - examples/nfc-dep-*: disconnect from NFC device on error. - examples/nfc-emulate-forum-tag2: add new example to emulate a NFC Forum Tag Type 2 - examples/nfc-emulate-forum-tag4: add document references. - examples/nfc-emulate-forum-tag4: this example now fails with ENOTSUPP when used with a non-PN532 chip. - examples/nfc-mfclassic: write special Mifare 1K cards, including Block 0 / UID - examples/nfc-mfsetuid: add a new example to set UID of special Mifare 1K cards - examples/nfc-read-forum-tag3: add new example to read a NFC Forum Tag Type 3 - examples/pn53x-tamashell-scripts: minor enhancements - tests/test-dep: add a threaded DEP test to check DEP communication between two local devices - debian: enable all drivers at compile time - debian: improve debian packaging (Thanks to Thomas Hood) - debian: use a numbering that allow to have libnfc pre-version and debian package pre-version too. (Thanks to Thomas Hood) - freebsd: add FreeBSD devd(8) snippet configuration for Sony S330 readers. - windows: implement abort mecanism in pn532_uart driver (Based on provided patch: many thanks to Edwin Evans) - windows: USB drivers now relies on libusb-win32 with version >= 1.2.4.x (1.2.4.6 recommended) (Many thanks to Glenn) - windows: implement automatic uart port detection and input flush (Thanks to Edwin Evans) Changes: - libnfc: add 'struct timeval *timeout' parameter for pn53x_transceive(), pn53x_target_receive_bytes() and pn53x_target_send_bytes(). Apr 29, 2011 - 1.5.0 (unstable) ------------------------------- Fixes: - libnfc: silent warnings with more strict CFLAGS - libnfc: update devd(8) rules file for FreeBSD - libnfc: make libnfc compile under Windows - libnfc: fix nfc_pick_device() when called from nfc_connect with NULL nfc_device_desc_t parameter - chips/pn53x: fix a bug when value is larger than mask when using WriteRegister - chips/pn53x: adapt MaxRetries to avoid issue with 2 tags on PN531 - examples/nfc-mfclassic: UID was shown reverse-ordered Improvements: - libnfc: use a new way to handle drivers, introduce a real HAL - libnfc: use absolute include path instead of relative ones - libnfc: move some nfc_device_t members in a better place - libnfc: improve nfc_driver_t struct to embedded HAL API - libnfc: nfc_device_t now embeddeds driver data and chip data pointers (useful to be more generic) - libnfc: use more readable variables instead of strange coding convention - libnfc: move PRINT_HEX macro into nfc-internal.h - libnfc: introduce an abort mecanism - libnfc: suppress any PN53x references in nfc.c - libnfc: nfc-mfclassic and nfc-mfcultralight examples are now compiled under Windows - chips/pn53x: use the powerful C99 writing to construct PN53x commands - chips/pn53x: remove almost all memcpy() - chips/pn53x: WriteRegister, ReadRegister and SetParameters command wrappers are correctly named - chips/pn53x: introduce chip state (SLEEP, NORMAL or EXECUTE) - chips/pn53x: add SAMConfiguration command wrapper (need to be improved) - chips/pn53x: remove almost all const arrays - chips/pn53x: use human readable defines for commands instead of hex values - chips/pn53x: in debug mode, the PN53x command is shown in human-readable string, awesome isn't it? ;-) - chips/pn53x: try to determine IC version instead of hardcode it. - chips/pn53x: new fonction to build frames instead of build them in each driver - chips/pn53x: enable aborting blocking commands (e.g. TgInitAsTarget) and refactor *_check_communication() as pn53x_check_communication(). - chips/pn53x: add timed versions of transceive_bytes/bits, allow to detect emulated/non-emulated tags and more... - chips/pn53x: support CRC auto-handling in ...transceive_bytes_timed - drivers/pn53x_usb: ASK LoGO: enable progressive field feature. - drivers/pn532_uart: major improvement of UART handling - drivers/pn532_uart: check PN53x frames when received - drivers/pn53x_usb: enhance ASK LoGO dedicated code - drivers/pn53x_usb: add LEDs support for ASK LoGO and SCL3711 - drivers/pn532_uart: implement extended frame send/receive for PN532_UART driver. - drivers/arygon: use the new way to drive UART (its far more stable) - drivers/arygon: do not hard code PN532 chip type: pn53x_init() determine it and ARYGON device seems to not need to be waken up. - drivers/arygon: reject too heavy payload (ARYGON does not support PN53x extended frame even with PN532 equipped device) - drivers/pn532_uart & arygon: now runs almost twice faster than the previous stable release - buses/uart: receive() is now based on expected bytes instead of calculated timeouts.. - buses/uart: simplify uart_send() on POSIX systems. - examples/nfc-emulate-tag: minor comments improvements. - examples: remove nfc-message.h usage from examples. - examples/nfc-emulate-forum-tag4: fully reworked example: it now support all NFC-Forum device in read and write mode - examples/pn53x-tamashell: add an example for LoGO LEDs - examples/pn53x-tamashell: add a script to read Mobib card. - examples/pn53x-tamashell: add a script to read Navigo card. Changes: - libnfc: merge macros from nfc-messages.h into nfc-internal.h - libnfc: remove useless files: nfc-messages.h, buses.h and chips.h - API: new nfc_emulate_target() that ease target emulation for developer - macros: show PRINT_HEX result on stderr in debug mode (that helps to sync with debug msg which are printed on standard error output.) - drivers: split transceive() into send() and receive() to be able to handle more cases (differed replies, abort commands, etc) later - drivers: use a const structure of functions instead of -dirty- callbacks array - drivers/pn53x_usb: pn531_usb and pn533_usb drivers are now merged and use the pn53x IC version autodetection - buses/uart: use a smart way to determine available ports on POSIX systems (tested on Linux and FreeBSD) Feb 21, 2011 - 1.4.2 -------------------- Fixes: - libnfc: fgets instead of getline, bring MacOSX / BSD without glibc alive - libnfc: add missing CMake files to generated tarball needed by windows users (Thanks to Glenn) - drivers/pn532_uart: fix pn532 wakeup response handling - buses/uart: prevent from retrieving more than buffer length (potential buffer overflow) - buses/uart: intent to speed up interface - nfc-emulate-uid: use a correct UID - nfc-mfclassic: fixes a segfault when using only 1 argument Improvements: - libnfc: silent some compilation warnings - drivers/pn533_usb: support new device: ASK / LoGO. (Thanks to ASK for sending one sample) - chips/pn53x: set register directly if mask cover whole value. - pn53x-tamashell: accepts script as arg, this makes shebang possible - pn53x-tamashell: add pause command & doc - documentation: add a README-Windows.txt file - documentation: add more pcsc-lite related instruction in README Feb 1, 2011 - 1.4.1 ------------------- Fixes: - libnfc: fix missing pn53x-tamashell-scripts in generated tarball. (Thanks to usermeister) - buses/uart: improved UART communication on POSIX systems: slower devices can be detected and high speed devices works better - buses/uart: serial autoprobe now skips invalid devices but checks all ports in the list - drivers/pn53x_usb: prevent from stack corruption when using PN533-based device and add errors handling for ReadRegister and WriteRegister - drivers/arygon: fix polling on ARYGON devices - examples/nfc-emulate-tag: switch off easy framing when we are not emulating a ISO14443-4 target - examples/nfc-mfclassic: fix crash when file cannot be opened for writing - examples/nfc-mfultralight: fix 7 bytes UID display Improvements: - libnfc: add a "troubleshooting" section in README to document ACR122 problems with pcsclite. - libnfc: inform user if target UID can not be emulated - example/nfc-mfultralight: handle lock page writing - examples/nfc-emulate-tag: handle HALT & READ - tests: add register access test Experimental: Windows platform support (Thanks to Glenn Ergeerts) Nov 17, 2010 - 1.4.0 -------------------- Fixes: - libnfc: fix Felica listing - libnfc: fix storage of ISO14443B targets data - libnfc: fix MacOS build - libnfc: fix some errors string (ie. well-known "Invalid Parameter") - libnfc: fix memory leak while using *_pick() - drivers/pn53x_usb: fix ZLP USB issue - drivers/pn53x_usb: workaround for PN532 toggle bit USB bug - drivers/pn53x_usb: fix timeout problem in emulation mode - drivers/pn53x_usb,pn532_uart,arygon: more robust recovery from unstable states such as interrupted emulation modes - drivers/acr122: fix escape ioctl under Linux - buses/uart: fix UART default serial ports under Linux. - examples/nfc-anticol: fix bug preventing to run nfc-anticol after some other programs - examples/nfc-anticol: fix display of UID - ... and many other minor fixes Improvements: - libnfc: major emulation improvements: libnfc can now be used to emulate ISO/IEC 14443 type A tag (MIFARE, ISO14443-4), FeliCa and D.E.P. target - libnfc: documentation improvements - libnfc: decode select/initialization datas for almost all supported target types (ISO14443 A/B, Jewel/Topaz, FeliCa) - libnfc: add ISO/IEC 14443B baud rates: 212, 424 and 847 kbps - libnfc: cache some chip registers for faster communication - libnfc: greatly improved D.E.P. support - buses/uart: adjust UART's timeouts from baud rate: faster communication at high speed and more reliable at low speed (affect pn532_uart and arygon drivers) - drivers/arygon: retrieve ARYGON µC firmware version - examples/nfc-anticol: adds support for CL3 - examples/nfc-anticol: cascade based on SAK rather than CT, better for educational purpose - examples/nfc-anticol: Computes CRC rather than hardcoded one. - examples/nfc-utils: print_iso14443b_info() now displays many decoded information in verbose mode - examples/nfc-utils: print_iso14443a_info() now displays many decoded information and shows attempt to determine tag name in verbose mode - examples/nfc-list: new option -v for verbose mode - examples/nfc-list: now support for Jewel/Topaz too - examples/nfc-poll: now poll using all supported modulations - examples/nfc-dep-target: add hack to allow to use two devices on the same machine (for tests/debug purpose) - examples/pn53x-tamashell: New PN53x TAMA communication demonstration shell (support scripting) - examples/nfc-relay-picc: New tool to relay ISO14443-4 communications (even over network... Enjoy!) - examples/nfc-emulate-forum-tag4: New example to emulate a NFC Forum tag type 4 - examples/nfc-emulate-tag: New example to emulate tags - examples: add missing man pages - ... and many other minor improvements Changes: - API: Many changes, see NEWS file for more info how to migrate - buses/uart: split UART implementations: one file for POSIX and another one for Windows - examples: nfcip-* renamed to nfc-dep-* - examples: nfc-sam renamed to pn53x-sam - examples: nfc-emulate renamed to nfc-emulate-uid - examples: change examples license for the sake of consistency: LGPL covers library, re-usable examples code is now under BSD license. Aug 31, 2010 - 1.3.9 -------------------- Fixes: - libnfc: fix ATS - pn53x_usb: fix USB issues - nfc-mfultralight: fix read and write counters Improvments: - libnfc: rearrange source code - libnfc: enhance documentation - libnfc: add regression tests (not as much as expected but its here!) - build: configure script now supports --with-drivers option instead of --disable-pcsclite and --disable-libusb (see --help) - nfc-mfultralight: we now can write OTP bytes if user want to Changes: - API: nfc_initiator_select_tag() is now nfc_initiator_select_passive_target() - API: nfc_initiator_deselect_tag() is now nfc_initiator_deselect_target() - API: new function nfc_initiator_list_passive_targets() to list available targets in field - API: new nfc_perror(), nfc_strerror() and nfc_strerror_r() functions to handle errors - API: new types: nfc_target_type_t and nfc_target_t - API: new configuration option NDO_AUTO_ISO14443_4 to enable/disable auto iso14443-4 mode. - API: new configuration option NDO_EASY_FRAMING to enable/disable auto frames encapsulation and chaining - API: nfc_initiator_transceive_dep_bytes(), nfc_target_receive_dep_bytes() and nfc_target_send_dep_bytes() have been removed (unset NDO_EASY_FRAMING instead of these functions) - API: (experimental) new nfc_initiator_poll_targets() which allow to use hardware polling function - examples: add draft of a new example: nfc-sam. It tests the comunication with a connected SAM (Secure Access Module) - examples: add new example to show how to use new polling function - examples: add new example to diagnose basic elements (communication, rom and ram) of pn53x - nfc-mfultralight: on write failure, continue if authenticate works. - nfc-mfclassic: take care of 16-blocks-long sectors of Mifare Classic 4K in the nfc-mfclassic example's blocks counting routine. - nfc-mfclassic: now fails ealier when something goes wrong (this allow to prevent from false-success). - nfc-mfclassic: disable ISO14443-4 auto-switching in order to read devices that emulate Mifare Classic with ISO14443-4 compliance.(e.g. Nokia 6212 Classic) Note: This release will not install extra headers (like mifare.h), programs that depends on should copy theses files into their sources. Apr 6, 2010 - 1.3.4 -------------------- Fixes: - Fix CT (Cascade Tag) byte when using 10 bytes long UID. - Strip CT (Cascade Tag) from UIDs in nfc_initiator_select_tag(). - Fix CMake build (mainly on Windows related stuff) - Minors fixes in documentation. - Suppress almost all compilation warnings. Changes: - API: Provide ISO14443A CRC function. - Remove annoying info message when probing uart devices while serial autoprobing is disabled. - Rename README-Windows.txt (compilation using CMake) into CMake-Windows.txt - Add README for Windows compilation using win32/Makefile. Note: Windows users could now take main tarball using CMake to build or Windows specific archive using MinGW GNU/Make. Feb 17, 2010 - 1.3.3 -------------------- Fixes: - libnfc: Attempt to fix build on Windows using CMake; - libnfc: Fix build on NetBSD; - libnfc: Fix build on MacOS X; - nfc-relay: fix usage of two devices that use the same driver. Feb 01, 2010 - 1.3.2 -------------------- Fixes: - libnfc: Fix compilation issue under FreeBSD (should now compile on FreeBSD 6, 7 and 8). Note: Experimental CMake files are provided with this release, issues reports are welcome. Jan 20, 2010 - 1.3.1 -------------------- Fixes: - libnfc: Fix compilation issue under Windows; - uart bus: Fix possible invalid file descriptor in uart_close(); - uart bus: Serial autoprobing is now DISABLED to avoid UART disturbing. (Feature can be enabled using –enable-serial-autoprobe option while configure). Jan 14, 2010 - 1.3.0 -------------------- Fixes: - build: Add workarounds for libusb when compiling using C99; - build: Attempt to fix rpath issue on linux platform (it is already deprecated in main distributions. i.e. http://wiki.debian.org/RpathIssue); - build: wrong paths in pkg-config file; - libnfc: Remove warnings when compiling; - libnfc: Various code fixes and cleanup; - bus uart: Added support for recv/send of larger data chunks (>default_os_buffer); - bus uart: Fix some some buffer synchronization problems under POSIX system; - bus uart: Add configure option: --disable-serial-autoprobe to disable autoprobing; - libnfc: Fix nfc_target_init doesn't correctly reset the parity during initalization; - libnfc: added support for WUPA and 7,10 byte UID in nfc_initiator_select_tag(); - libnfc: Fix tag re-selection with UID length > 4 bytes (like DESFire or Ultralight); - nfc-mfclassic: Fix authenticated only with KEYA; Improvements: - build: Build on FreeBSD; - build: Add alternative build system (CMake); - build: Add new files usefull for desktop GNU/Linux users: some rules for udev to allow non-root access to PN53x USB devices; - build: Update msinttypes up to revision 26. (used when compiling under Windows); - build: Add "make doc" directive: it will build API documentation using Doxygen. (--enable-doc flag is required at configure time); - libnfc: Add C++ compatibility; - libnfc: Add driver agnostic nfc_pick_device(), nfc_list_devices(); - libnfc: It is now possible to specify a wanted device using new struct "nfc_device_desc_t"; - libnfc: Add device name to device descriptions (nfc_device_desc_t) to select a given PCSC device; - libnfc: Finally removed all dirty globals, it 'should' be thread-safe now; - libnfc: Less confusing message for bitstreams display; - libnfc: chips level introduction with pn53x.h/c; - drivers: Add PN532 UART driver; - drivers pn533_usb and pn531_usb: Lets search continuing to find other USB readers if any in PN531 and PN533 USB drivers; - drivers pn533_usb and pn531_usb: Support for the generic vendorid/productid of the NXP chip; - drivers pn533_usb and pn531_usb: Consolidate duplicated code; - examples: Add MIFARE Ultratag tool; - examples: Add man page for nfc-mfultool; - examples: MIFARE examples (mftool and mfultool) have now a better help message; - examples: Add NFCIP (NDEP) as experimental feature; - examples: add quiet mode to improve timing of emulate, relay and anticol commands; - nfc-list: List all devices in nfc-list(1); - nfc-list: Simply turns off the RF field upon exit; - nfc-emulate: allow UID to be specified; - nfc-relay: Initialize initiator device explicitly; - nfc-relay: Capture ctrl-c for quitting cleanly the relay attack application; - nfc-relay: exit properly if emulator initialization failed; - nfc-mfclassic: Add default keys tries; Changes: - API: Rename tag_info to nfc_target_info_t; - API: Rename init_modulation to nfc_modulation_t; - API: Rename dev_config_option to nfc_device_option_t; - API: Use NULL instead of INVALID_DEVICE_INFO to know if device is valid; - API: Rename chip_type to nfc_chip_t; - API: Rename dev_spec to nfc_device_spec_t; - API: Rename dev_info struct to nfc_device_t; - API: Variables have been renamed to match coding conventions; - API: Changed length parmeters from uint32_t to size_t; - Files: Remove defines.h public header; - Files: Prefix messages.h and types.h headers by "nfc-"; - Files: Revamp libnfc source tree; - Files: Move examples into src/examples subdirectory; - Examples: Rename nfc-mftool to nfc-mfclassic; - Examples: Rename nfc-mfultool to nfc-mfultralight; Jul 24, 2009 - 1.2.1 -------------------- - Fix ACR122 on 64 bits architecture under GNU/Linux. Jul 22, 2009 - 1.2.0 -------------------- - License changed from GPLv3 to LGPLv3 - ARYGON ADRA-USB/ADRB-USB reader support - PN533 support - C99 standard (all custom defined types have been renamed) - Autotoolized for GNU/Linux, *BSD and MacOSX - nfc examples (anticol, emulate, list, mftool, relay) are now prefixed by "nfc-" Mar 27, 2009 - 1.1.0 -------------------- - Next generation, support for ACR122v2 and PN531 USB devices Feb 12, 2009 - 1.0.0 -------------------- - Initial release libnfc-libnfc-1.8.0/Doxyfile.in000066400000000000000000003225231366172354100163420ustar00rootroot00000000000000# Doxyfile 1.8.13 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = libnfc # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = @VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = @builddir@/doc # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 2 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 0. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 0 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = YES # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = YES # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = Doxygen.log #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. 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. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. FILE_PATTERNS = *.c \ *.h \ *.dox # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = @top_srcdir@/libnfc/drivers.h \ @top_srcdir@/libnfc/iso14443-subr.c \ @top_srcdir@/libnfc/iso7816.h \ @top_srcdir@/libnfc/log-printf.c \ @top_srcdir@/libnfc/log.h \ @top_srcdir@/libnfc/mirror-subrc.c \ @top_srcdir@/libnfc/mirror-subrc.h # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = .git/* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = @top_srcdir@/ \ @top_srcdir@/src/examples/doc # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = ChangeLog \ *.c # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse-libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = NO # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NONE # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /