diff --git a/.gitmodules b/.gitmodules index e2a18f42..a7b495ef 100644 --- a/.gitmodules +++ b/.gitmodules @@ -13,3 +13,7 @@ [submodule "components/mqtt/esp-mqtt"] path = components/mqtt/esp-mqtt url = ../../espressif/esp-mqtt.git + +[submodule "components/coap/libcoap"] + path = components/coap/libcoap + url = ../../espressif/libcoap diff --git a/components/coap/CMakeLists.txt b/components/coap/CMakeLists.txt index 5d423d61..925ed75e 100644 --- a/components/coap/CMakeLists.txt +++ b/components/coap/CMakeLists.txt @@ -1,43 +1,41 @@ -set(COMPONENT_ADD_INCLUDEDIRS port/include port/include/coap libcoap/include libcoap/include/coap) +if(CONFIG_ENABLE_COAP) + set(include_dirs port/include port/include/coap libcoap/include libcoap/include/coap2) -set(COMPONENT_SRCS - libcoap/src/address.c - libcoap/src/async.c - libcoap/src/block.c - libcoap/src/coap_time.c - libcoap/src/debug.c - libcoap/src/encode.c - libcoap/src/hashkey.c - libcoap/src/mem.c - libcoap/src/net.c - libcoap/src/option.c - libcoap/src/pdu.c - libcoap/src/resource.c - libcoap/src/str.c - libcoap/src/subscribe.c - libcoap/src/uri.c - port/coap_io_socket.c - ) + set(srcs + "libcoap/src/address.c" + "libcoap/src/async.c" + "libcoap/src/block.c" + "libcoap/src/coap_event.c" + "libcoap/src/coap_hashkey.c" + "libcoap/src/coap_session.c" + "libcoap/src/coap_time.c" + "libcoap/src/coap_debug.c" + "libcoap/src/encode.c" + "libcoap/src/mem.c" + "libcoap/src/net.c" + "libcoap/src/option.c" + "libcoap/src/pdu.c" + "libcoap/src/resource.c" + "libcoap/src/str.c" + "libcoap/src/subscribe.c" + "libcoap/src/uri.c" + "libcoap/src/coap_notls.c" + "port/coap_io.c") -set(COMPONENT_REQUIRES lwip) + set(COMPONENT_REQUIRES lwip) -register_component() + idf_component_register(SRCS "${srcs}" + INCLUDE_DIRS "${include_dirs}" + REQUIRES lwip) -# Needed for coap headers in public builds, also. -# -# TODO: find a way to move this to a port header -target_compile_definitions(${COMPONENT_LIB} PUBLIC WITH_POSIX) + # Silence format truncation warning, until it is fixed upstream + set_source_files_properties(libcoap/src/coap_debug.c PROPERTIES COMPILE_FLAGS -Wno-format-truncation) -set_source_files_properties( - libcoap/src/debug.c - libcoap/src/pdu.c - PROPERTIES COMPILE_FLAGS - -Wno-write-strings) + # Needed for coap headers in public builds, also. + # + # TODO: find a way to move this to a port header + target_compile_definitions(${COMPONENT_LIB} PUBLIC WITH_POSIX) +else() + register_component() +endif() -# Temporary suppress "fallthrough" warnings until they are fixed in libcoap repo -set_source_files_properties( - libcoap/src/option.c - PROPERTIES COMPILE_FLAGS - -Wno-implicit-fallthrough) - -target_compile_definitions(${COMPONENT_LIB} PUBLIC -D WITH_POSIX) diff --git a/components/coap/Kconfig b/components/coap/Kconfig new file mode 100644 index 00000000..825b8dea --- /dev/null +++ b/components/coap/Kconfig @@ -0,0 +1,10 @@ +menu "COAP" + +config ENABLE_COAP + bool "Enable coap" + default n + select LWIP_IPV6 + help + Enable this option and coap is to be used, IPv6 is to be Enable. +endmenu + diff --git a/components/coap/Makefile.projbuild b/components/coap/Makefile.projbuild deleted file mode 100644 index e900b0f9..00000000 --- a/components/coap/Makefile.projbuild +++ /dev/null @@ -1 +0,0 @@ -CPPFLAGS += -DWITH_POSIX diff --git a/components/coap/component.mk b/components/coap/component.mk index 5bef303d..a656dbc2 100644 --- a/components/coap/component.mk +++ b/components/coap/component.mk @@ -2,13 +2,15 @@ # Component Makefile # -COMPONENT_ADD_INCLUDEDIRS := port/include port/include/coap libcoap/include libcoap/include/coap +ifdef CONFIG_ENABLE_COAP +COMPONENT_ADD_INCLUDEDIRS := port/include port/include/coap libcoap/include libcoap/include/coap2 -COMPONENT_OBJS = libcoap/src/address.o libcoap/src/async.o libcoap/src/block.o libcoap/src/coap_time.o libcoap/src/debug.o libcoap/src/encode.o libcoap/src/hashkey.o libcoap/src/mem.o libcoap/src/net.o libcoap/src/option.o libcoap/src/pdu.o libcoap/src/resource.o libcoap/src/str.o libcoap/src/subscribe.o libcoap/src/uri.o port/coap_io_socket.o +COMPONENT_OBJS = libcoap/src/address.o libcoap/src/async.o libcoap/src/block.o libcoap/src/coap_event.o libcoap/src/coap_hashkey.o libcoap/src/coap_session.o libcoap/src/coap_time.o libcoap/src/coap_debug.o libcoap/src/encode.o libcoap/src/mem.o libcoap/src/net.o libcoap/src/option.o libcoap/src/pdu.o libcoap/src/resource.o libcoap/src/str.o libcoap/src/subscribe.o libcoap/src/uri.o libcoap/src/coap_notls.o port/coap_io.o COMPONENT_SRCDIRS := libcoap/src libcoap port -libcoap/src/debug.o: CFLAGS += -Wno-write-strings -libcoap/src/pdu.o: CFLAGS += -Wno-write-strings -# Temporary suppress "fallthrough" warnings until they are fixed in libcoap repo -libcoap/src/option.o: CFLAGS += -Wno-implicit-fallthrough +COMPONENT_SUBMODULES += libcoap + +# Silence format truncation warning, until it is fixed upstream +libcoap/src/coap_debug.o: CFLAGS += -Wno-format-truncation +endif diff --git a/components/coap/libcoap b/components/coap/libcoap new file mode 160000 index 00000000..cfec0d07 --- /dev/null +++ b/components/coap/libcoap @@ -0,0 +1 @@ +Subproject commit cfec0d072c5b99ed3e54828ca50ea2f6b91e1f50 diff --git a/components/coap/libcoap/.gitignore b/components/coap/libcoap/.gitignore deleted file mode 100644 index 3b1d4b23..00000000 --- a/components/coap/libcoap/.gitignore +++ /dev/null @@ -1,64 +0,0 @@ -# .gitignore for libcoap - -# ignoring autogenerated files and directories by autoreconf -INSTALL -Makefile -Makefile.in -aclocal.m4 -ar-lib -autom4te.cache/ -coap_config.h* -compile -config.* -configure -debian/ -depcomp -install-sh -libcoap-*.tar.bz2 -libtool -ltmain.sh -m4/libtool.m4 -m4/ltoptions.m4 -m4/ltsugar.m4 -m4/ltversion.m4 -m4/lt~obsolete.m4 -missing -stamp-h1 - -# ignoring more files generated by the configure script or the make actions -.libs/ -libcoap*.la -libcoap*.pc -src/.deps/ -src/.dirstamp -src/.libs/ -src/*.o -src/*.lo - -# the doc/ folder -doc/Doxyfile -doc/Makefile.in -doc/doxyfile.stamp -doc/doxygen_sqlite3.db -doc/html/ - -# the examples/ folder -examples/.deps/ -examples/*.o -examples/coap-client -examples/coap-rd -examples/coap-server -examples/coap-client.5 -examples/coap-client.txt -examples/coap-rd.5 -examples/coap-rd.txt -examples/coap-server.5 -examples/coap-server.txt - -# the include/ folder -include/coap/coap.h - -# the tests/ folder -tests/.deps -tests/testdriver -tests/*.o diff --git a/components/coap/libcoap/.travis.yml b/components/coap/libcoap/.travis.yml deleted file mode 100644 index d574e1d2..00000000 --- a/components/coap/libcoap/.travis.yml +++ /dev/null @@ -1,34 +0,0 @@ -sudo: required -dist: trusty - -language: c -compiler: - - gcc - - clang - -env: - - PLATFORM=posix TESTS=yes - - PLATFORM=contiki - - PLATFORM=lwip - -addons: - apt_packages: - - pkg-config - - graphviz - - libcunit1-dev - - doxygen - - libxml2-utils - - xsltproc - - docbook-xml - - docbook-xsl - - asciidoc - -branches: - only: - - master - - develop - - /^release-.*$/ - -before_script: ./autogen.sh --clean && ./autogen.sh - -script: scripts/build.sh diff --git a/components/coap/libcoap/AUTHORS b/components/coap/libcoap/AUTHORS deleted file mode 100644 index d747a4e7..00000000 --- a/components/coap/libcoap/AUTHORS +++ /dev/null @@ -1,3 +0,0 @@ -libcoap authors - -Olaf Bergmann, Universität Bremen diff --git a/components/coap/libcoap/CONTRIBUTE b/components/coap/libcoap/CONTRIBUTE deleted file mode 100644 index 9e6d3ee2..00000000 --- a/components/coap/libcoap/CONTRIBUTE +++ /dev/null @@ -1,219 +0,0 @@ - ####################################################### - # Developer information for contributing to libcoap # - ####################################################### - -1. The basics -~~~~~~~~~~~~~ -The libcoap project is a FOSS project that is dual licensed. The maintainer -for the libcoap is Olaf Bergmann . -Any contributions have to be made dual licensed under the terms of the -license - - * BSD 2-Clause (The BSD 2-Clause License) - -and - - * GPL v2+ (The GNU General Public License 2.0 or later) - -The used VCS for libcoap is Git, the main repository is living on GitHub. -You can clone (or fork directly on GitHub) on the repository site: - - https://github.com/obgm/libcoap - -Please refer also to the libcoap website for additional information - - https://libcoap.net/ - -The build environment is grounded on the classical autotools, the GNU GCC and -the LLVM C-compiler (CLang) are supported. The Windows systems are not -currently supported (until someone is creating support for it). - -Doxygen is used for creating a HTML based online documentation of the -libcoap library. - -2. Communications -~~~~~~~~~~~~~~~~~ -The main discussion and development platform for libcoap is the mailing list -on Sourceforge. -No matter if you just have a simple question, some specific problem or -want to discuss some patches, please write it to the mailing list. Please -avoid personal mailings to the maintainer (or some other contributor) if -your questions will probably be in the interest of other users too. -You can subscribe to the list here: - - https://lists.sourceforge.net/lists/listinfo/libcoap-developers - -The archive of the list can be found on: - - https://sourceforge.net/p/libcoap/mailman/libcoap-developers - -3. Starting contributing -~~~~~~~~~~~~~~~~~~~~~~~~ -As written above libcoap is maintained with the Git tools so you should be -familiar with the various git commands. -The libcoap project is using just two main branches, the 'master' branch is -holding the point releases, all the development process is going on in the -'develop' branch. -To start any contributing you first have to clone the git tree from the main -repository on GitHub: - - git clone https://github.com/obgm/libcoap.git - -4. Working on the source -~~~~~~~~~~~~~~~~~~~~~~~~ -As one golden rule you should work on improvements within *your* own local -development branch! To do so you have to first checkout the 'develop' branch -as local branch and then start on top on this branch your own branch. So -create (or better say checkout) the local 'develop' branch: - - cd libcoap - git checkout develop origin/develop - -Now you can simply start your own local branch (for example 'my-develop') -with the 'origin/develop' as parent so you can later create the patches -against the the upstream development branch: - - git checkout -b my-develop - -At this point you can now work as known with git, modify the source, commit -the changes, amend if needed and test your work. -At some point you will have to generate patches to post them on the mailing -list (and/or push your changes into your public Git tree). It's a good idea to -post your patch series on the mailing list so other contributors will see your -work and give further suggestions or discuss your work. - -To be able to send a patch series you will now create the series itself as -single patches, this will be going easy with the 'git format-patch' command -against the 'develop' branch, remind this is the upstream main development -branch. -To not mix up your series with probably unrelated patches let git place the -patches within a defined directory. Also, while create the patches, tell git to -create a cover letter patch so you can append some introducing words that will -hold probably explanations why you create the patches in the way you have done. - - git format-patch --cover-letter -o ../patches4libcoap - -This command will create a patch series in ../patches4libcoap where you find a -patch named '0000-cover-letter.patch'. Please modify this patch with some -useful information's for the mailing list. After finish this you now can send -your patches to libcoap-developers@lists.sourceforge.net - - git send-email ../patches4libcoap/* --to=libcoap-developers@lists.sourceforge.net - -5. Coding rules -~~~~~~~~~~~~~~~ -As every FOSS project the libcoap project needs also some rules for coding. -There are loss but the main of them are important! - -5.1 License and Copyright -------------------------- -Every new file must contain a license and the copyright holder(s). Please -take a look into existing files and adopt the needed changes to your new -file(s). - -5.2 Source Code Indentation ---------------------------- -* For better reading the indentation is set to 2 characters as spaces, this - is depended on the often used nested functions like 'if-else'. Don't use - TABs any there! Avoid trailing white spaces at the end of a line. - It's appropriate to set up a modline like this one at first line within - the source file: - ---8<---- -/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 * -*- */ ---->8-- - -* Single lines within the source code should not be longer then 78 - characters. - -* If there a functions with a lot of parameters that do not fit into the above - rule split the declaration (in the *.h) and the implementation (in the *.c) - into single lines per parameter. For example like this (from src/block.c): - ---8<---- -int -coap_add_block(coap_pdu_t *pdu, - unsigned int len, - const unsigned char *data, - unsigned int block_num, - unsigned char block_szx); ---->8-- - -5.3 Source Code Documentation ------------------------------ -* A useful source code documentation is mandatory. Mostly to be done within the - source code files, but more complex description should be done in extra - README files. - -* Please set up/adjust the doxygen documentation if you create new functions or - change existing functions. The doxygen documentation has to be done in the - header files as they are the public part of the libcoap and only use the - @-syntax for doxygen commands (akin to javadoc). - -5.4 API Changes ---------------- -* Never break the API! - Don't remove old functions and if there some changes are needed in some kind - always provide a wrapper for the old call to let the library be backward - compatible and mark the old function as @deprecated in the doxygen comment. - Please discuss needed changes on the mailing list. - -5.5 Patches and Commits ------------------------ -* Git commits must be atomic and contain a declarative subject line (max 50 - characters if possible) and a body for a statement if needed. - Use the possibility to write a good explanation why your patch/commit is - handle the changes in the way you have done. Remind that other user can - read your code but not necessary understand why the code is written this - way. Don't use something to generic like "bugfix commit". - -* A patch/commit or a series of patches/commits have to ensure that the - whole project is able to build up every thing, in short: Do not break - any make target and test your work. - -* Every patch/commit should handle one single logical change. If more than - one patch/commit is needed for a change explain it, respect the point - above. If your subject line become much larger than 50 characters then - typically your patch is to big for one single commit. - -* Commit message should begin with a submodule or unit the commit is for. By - this your commit message helps to find thematic other changes. If you have - to search and find something with 'git log | grep [foo]' you will see why - this is useful. Examples: - - rd.c: Fixed type-specifier warning - Makefile.am: Added missing src/address.c - address.[hc]: make coap_address_equals() not inline on POSIX - -6. Where to start contributing? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -There are various things you could starting on to contribute, the best -is you simply pick up an issue you blindly see and just improve the -situation. Please take also a look into the file TODO and choose a point -from there or point the maintainer to add other things here too. - -* Documentation -We are always lacking on a better documentation on the source code, so -maybe you can improve the doxygen documentation. -Also a good documentation on the usage of the libcoap and the example -binaries is always improvable. So we appreciate any help on this. - -* Man Pages -The source is providing some example binaries which originally just should show -how the libcoap can be used. Right now these binaries are fully usable and -quite more than simple examples on a system. There are man pages for these -binaries available, if you found there is a improvement needed please do so and -write to the mailing list explained in section 2. -Maybe you can write up some good HowTo's on the usage for these binaries. A man -page for the library itself would be also a improvement. - -* HowTo's -The libcoap library has now a lot of functions you can use. -Unfortunately there is no good user guide on how to use the libcoap in -any external project. This means there is no HowTo or CheatSheet for a -programming person available. You want to write up something? - -* missed Functionality -There are some features that are still missing inside the libcoap. For -example some DTLS implementations and proxy functionality. - diff --git a/components/coap/libcoap/COPYING b/components/coap/libcoap/COPYING deleted file mode 100644 index 6f0c0fd2..00000000 --- a/components/coap/libcoap/COPYING +++ /dev/null @@ -1,6 +0,0 @@ -libcoap is published as open-source software without any warranty of any kind. - -Use is permitted under the terms of the GNU General Public License (GPL), -Version 2 or higher, OR the simplified BSD license. - -The respective license file are shipped as LICENSE.BSD and LICENSE.GPL. diff --git a/components/coap/libcoap/ChangeLog b/components/coap/libcoap/ChangeLog deleted file mode 100644 index 477be8df..00000000 --- a/components/coap/libcoap/ChangeLog +++ /dev/null @@ -1,220 +0,0 @@ -2016-02-16 Olaf Bergmann - - * Fixed build for Contiki3 and LwIP - * .travis.yml: Enabled continuous integration for platforms - POSIX and Contiki - -2015-03-11 Olaf Bergmann - - * include/coap/resource.h: Replaced custom list structures by - utlist macros. - -2015-03-09 Olaf Bergmann - - * src/uri.c (coap_split_path): Fixed URI parser bug and - removed broken parse iterator. - -2015-03-05 Olaf Bergmann - - * src/coap_time.c (coap_ticks): Changed POSIX implementation - to fixed point arithmetic and removed clock_offset. - -2015-02-21 Olaf Bergmann - - * net.c (coap_send_confirmed): Use fixed point arithmetic - to calculate retransmission timeout. - -2015-02-20 Olaf Bergmann - - * coap_list.[hc]: Moved old list implementation into - sub-directory examples and replaced by linked lists - from utlist.h. As a result, the list must be sorted - explicitly with LL_SORT). - -2015-02-19 Olaf Bergmann - - * net.c (coap_send_confirmed): Fixed retransmission timeout - calculation and renamed transmission parameters according to - Section 4.8 of RFC 7252. - -2015-02-17 Olaf Bergmann - - * major rework to get Contiki and lwip running - * many fixed bugs and warnings - -2014-06-18 Olaf Bergmann - - * mem.c (coap_malloc_type): New functions for allocating memory. - On POSIX systems, coap_malloc_type() and coap_free_type() are just - wrapper functions for malloc() and free(), while on Contiki and - LWIP distinct arrays are used for each type. - -2014-03-09 Olaf Bergmann - - * net.c (coap_cancel): Removed 7.31 again and implemented new - method for cancelling observe relationships. - -2014-02-25 Olaf Bergmann - - * net.c (coap_cancel): Handling of 7.31 responses to cancel - notifications (see Section 4.6 of draft-ietf-core-observe-12) - -2014-02-04 Olaf Bergmann - - * resource.c (coap_print_link): This function now takes an offset - where printing starts. This is used for generating blocks on the - fly. - - * net.c (wellknown_response): Added support for Block2 options - when generating a response for .well-known/core. - - * block.h (coap_opt_block_num): Fixed handling of zero-length - options. COAP_OPT_BLOCK_LAST now returns NULL when the option - value's length is zero. - -2014-01-07 Olaf Bergmann - - * resource.c (coap_print_link): Output partial resource - descriptions. The function now provides a sliding window over the - textual representation of the resource. Output starts at the given - offset and ends at the buffer's upper bound. The meaning of the - return value has changed to allow distinguishing whether or not - the resource description has been truncated at the buffer's upper - bound. - (print_wellknown): Support for the new coap_print_link(). An - additional parameter now is used to provide the offset into the - resource description. The meaning of the return value has been - adjusted accordingly. - -2013-12-23 Olaf Bergmann - - * configure.in: merged with LWIP port from chrysn - . This - introduces new compiler flags WITH_POSIX and WITH_LWIP to - distinguish target platforms. - -2013-09-03 Olaf Bergmann - - * option.h (coap_option_setb): increased size of option type - argument - - * tests/test_error_response.c (t_init_error_response_tests): new - tests for error response generation - - * tests/test_pdu.c (t_encode_pdu5): fixed number for option Accept - - * net.c (coap_new_error_response): fixed option size calculation - -2013-07-04 Olaf Bergmann - - * net.c (coap_new_context): register critical Accept option - - * pdu.c: option codes for Accept and Size1 according to coap-18 - -2013-02-01 Olaf Bergmann - - * coap_time.h (coap_clock_init_impl): fix invalid preprocessor - directive. #warning is now only used for gcc only (close sf bug #15) - - * net.c (wellknown_response): applied patch from chrysn to - fix bug in generation of .well-known/core representation - -2013-01-21 Olaf Bergmann - - * option.h: renamed option field in coap_opt_iterator_t to - next_option to detect erroneous use in old code - -2013-01-18 Olaf Bergmann - - * configure.in: new option --with-tests to enable unit tests - - * tests/testdriver.c: unit tests for parser functions - - * pdu.c (coap_pdu_parse): new PDU parser for Klaus-encoding - according to coap-13 - - * net.c (coap_read): call coap_pdu_parse() to check PDU integrity - - * option.c: Klaus-encoding for coap-13, including new option - iterator interface - -2012-11-20 Olaf Bergmann - - * net.c (next_option_safe): made option parsing more robust in - presence of option jumps - - * pdu.h: new option codes from draft-ietf-core-coap-12 - - * option.c (coap_opt_setlength): new function to set option length - - * uri.c (make_decoded_option): use coap_opt_setlength() instead of - obsolete macro COAP_OPT_SETLENGTH. - -2012-11-19 Olaf Bergmann - - * uri.c (make_decoded_option): use coap_opt_encode() instead of writing - -2012-11-03 Olaf Bergmann - - * net.c (coap_read): read new option encoding - -2012-11-01 Olaf Bergmann - - * option.c (coap_opt_size, coap_opt_value, coap_opt_length): - several functions to access fields of options (possibly preceeded - by option jump) - -2012-10-25 Olaf Bergmann - - * option.c (coap_opt_encode): new function for option encoding - with option jumps - -2012-03-23 Olaf Bergmann - - * examples/client.c (clear_obs): clear observation relationship after - user-specified duration - -2012-03-21 Olaf Bergmann - - * resource.c (print_wellknown): filtering by attributes - -2012-03-19 Olaf Bergmann - - * pdu.c (coap_add_option): allow more than 15 options. - -2012-03-15 Olaf Bergmann - - * examples/client.c (cmdline_uri): split path and query here to - make it easier to include these options in subsequent requests for - block transfer. - -2012-03-14 Olaf Bergmann - - * examples/etsi_iot_01.c: Support for POST, PUT, DELETE on /test - -2012-03-13 Olaf Bergmann - - * encode.c (coap_encode_var_bytes): more efficient coding for 0 - -2012-03-11 Olaf Bergmann - - * examples/etsi_iot_01.c: Test cases for 1st ETSI CoAP Plugtest, - March 24/25, 2012 in Paris, France. - -2012-03-10 Olaf Bergmann - - * block.c: support for block transfer. - -2012-03-07 Olaf Bergmann - - * examples/client.c (usage): new command line options - -B to set timeout after which the main loop is left. - -e to specify a payload (incompatible with -f) - (message_handler): bugfixes - - * resource.h: (coap_method_handler_t): new API for method handlers. - - -Copyright 2012 Olaf Bergmann, TZI -Copying and distribution of this file, with or without modification, are -permitted provided the copyright notice and this notice are preserved. diff --git a/components/coap/libcoap/LICENSE.BSD b/components/coap/libcoap/LICENSE.BSD deleted file mode 100644 index b3d19496..00000000 --- a/components/coap/libcoap/LICENSE.BSD +++ /dev/null @@ -1,26 +0,0 @@ -Copyright (c) 2010--2015, Olaf Bergmann -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - o Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - - o Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/components/coap/libcoap/LICENSE.GPL b/components/coap/libcoap/LICENSE.GPL deleted file mode 100644 index d8cf7d46..00000000 --- a/components/coap/libcoap/LICENSE.GPL +++ /dev/null @@ -1,280 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS diff --git a/components/coap/libcoap/Makefile.am b/components/coap/libcoap/Makefile.am deleted file mode 100644 index 15e4881a..00000000 --- a/components/coap/libcoap/Makefile.am +++ /dev/null @@ -1,180 +0,0 @@ -# Makefile.am for libcoap -# -# Copyright (C) 2010-2015 Olaf Bergmann -# (C) 2015-2016 Carsten Schoenert -# -# This file is part of the CoAP C library libcoap. Please see README and -# COPYING for terms of use. - -## Place generated object files (.o) into the same directory as their source -## files, in order to avoid collisions when non-recursive make is used. -AUTOMAKE_OPTIONS = subdir-objects - -ACLOCAL_AMFLAGS = ${ACLOCAL_FLAGS} -I m4 - -## Additional files for the distribution archive -EXTRA_DIST = \ - CONTRIBUTE \ - TODO \ - $(pkgconfig_DATA).in \ - libcoap-$(LIBCOAP_API_VERSION).map \ - libcoap-$(LIBCOAP_API_VERSION).sym \ - examples/coap_list.h \ - tests/test_options.h \ - tests/test_pdu.h \ - tests/test_error_response.h \ - tests/test_sendqueue.h \ - tests/test_uri.h \ - tests/test_wellknown.h - -AM_CFLAGS = -I$(top_builddir)/include/coap -I$(top_srcdir)/include/coap $(WARNING_CFLAGS) -std=c99 - -SUBDIRS = . $(DOC_DIR) tests examples - -## Define a libtool archive target "libcoap-@LIBCOAP_API_VERSION@.la", with -## @LIBCOAP_API_VERSION@ substituted into the generated Makefile at configure -## time. -## The libtool archive file (.la) will be installed into the directory named -## by the predefined variable $(bindir), along with the actual shared library -## file (.so). -lib_LTLIBRARIES = libcoap-@LIBCOAP_API_VERSION@.la - -libcoap_@LIBCOAP_API_VERSION@_la_CFLAGS = \ - -fPIC \ - -fPIE \ - $(AM_CFLAGS) - -## Define the source file list for the "libcoap.la" target. -## Note that it is not necessary to list header files which are already listed -## elsewhere in a _HEADERS variable assignment. -libcoap_@LIBCOAP_API_VERSION@_la_SOURCES = \ - src/address.c \ - src/async.c \ - src/block.c \ - src/coap_io.c \ - src/coap_time.c \ - src/debug.c \ - src/encode.c \ - src/hashkey.c \ - src/mem.c \ - src/net.c \ - src/option.c \ - src/pdu.c \ - src/resource.c \ - src/str.c \ - src/subscribe.c \ - src/uri.c - -## Define the list of public header files and their install location. -## The list defined here will be used within the include/Makefile.am -## and is only a variable because the content is needed also for the -## generating of the symbol mapping file. -libcoap_includedir = $(includedir)/coap/ -libcoap_include_HEADERS = \ - $(top_srcdir)/include/coap/address.h \ - $(top_srcdir)/include/coap/async.h \ - $(top_srcdir)/include/coap/bits.h \ - $(top_srcdir)/include/coap/block.h \ - $(top_builddir)/include/coap/coap.h \ - $(top_srcdir)/include/coap/coap_io.h \ - $(top_srcdir)/include/coap/coap_time.h \ - $(top_srcdir)/include/coap/debug.h \ - $(top_srcdir)/include/coap/encode.h \ - $(top_srcdir)/include/coap/hashkey.h \ - $(top_srcdir)/include/coap/libcoap.h \ - $(top_srcdir)/include/coap/mem.h \ - $(top_srcdir)/include/coap/net.h \ - $(top_srcdir)/include/coap/option.h \ - $(top_srcdir)/include/coap/pdu.h \ - $(top_srcdir)/include/coap/prng.h \ - $(top_srcdir)/include/coap/resource.h \ - $(top_srcdir)/include/coap/str.h \ - $(top_srcdir)/include/coap/subscribe.h \ - $(top_srcdir)/include/coap/uri.h \ - $(top_srcdir)/include/coap/uthash.h \ - $(top_srcdir)/include/coap/utlist.h - -# If there is a API change to something $(LIBCOAP_API_VERSION) > 1 the install -# prefix for the header files has to change to not conflict the older version -# if the user want's to install both versions. There will be something used like -# libcoap_include_HEADERS = \ -# $(top_srcdir)/include/coap-$(LIBCOAP_API_VERSION)/* - - -## Instruct libtool to include API version information in the generated shared -## library file (.so). The library ABI version will later defined in configure.ac, -## so that all version information is kept in one place. -libcoap_@LIBCOAP_API_VERSION@_la_LDFLAGS = \ - -version-info $(LT_LIBCOAP_CURRENT):$(LT_LIBCOAP_REVISION):$(LT_LIBCOAP_AGE) \ - @libcoap_SYMBOLS@ \ - -pie - -## Collect symbols here we want to ignore while building the helper files -## libcoap-$(LIBCOAP_API_VERSION).{map,sym} for the linker. -CTAGS_IGNORE=-I "coap_packet_extract_pbuf coap_pdu_from_pbuf" - -# This helper is called by libcoap-$(LIBCOAP_API_VERSION).{map,sym} to see if -# configure has detected a usable version of the ctags program and aborts if not. -check_ctags: - @if [ "$(CTAGS_PROG)" = "" ]; then \ - echo ;\ - echo "There was no ctags program found by the configure script!" ;\ - echo "ctags is needed for running this target! Please note the warning about the missed ctags program of the configure script." ;\ - echo ;\ - exit 1;\ - fi - -## Helper target to generate the symbol table needed by libtool. -## The .map format is used when ld supports linker scripts, otherwise -## it must fall back to a plain symbol file. -update-map-file: libcoap-$(LIBCOAP_API_VERSION).map libcoap-$(LIBCOAP_API_VERSION).sym - -libcoap-$(LIBCOAP_API_VERSION).map: check_ctags $(libcoap_include_HEADERS) - ( echo "VER_$(LIBCOAP_API_VERSION) {" ; \ - echo "global:" ; \ - $(CTAGS_PROG) $(CTAGS_IGNORE) -f - --c-kinds=p $(libcoap_include_HEADERS) | awk '/^coap_/ { print " " $$1 ";" }' | sort ; \ - echo "local:" ; \ - echo " *;" ; \ - echo "};" ) > $@.new - mv $@.new $@ - -libcoap-$(LIBCOAP_API_VERSION).sym: check_ctags $(libcoap_include_HEADERS) - ( $(CTAGS_PROG) $(CTAGS_IGNORE) -f - --c-kinds=p $(libcoap_include_HEADERS) | awk '/^coap_/ { print $$1 }' | sort ) \ - > $@.new - mv $@.new $@ - -## Install the generated pkg-config file (.pc) into the expected location for -## architecture-dependent package configuration information. Occasionally, -## pkg-config files are also used for architecture-independent data packages, -## in which case the correct install location would be $(datadir)/pkgconfig. -pkgconfigdir = $(libdir)/pkgconfig -pkgconfig_DATA = libcoap-$(LIBCOAP_API_VERSION).pc - -## Define an independent executable script for inclusion in the distribution -## archive. However, it will not be installed on an end user's system due to -## the noinst_ prefix. -dist_noinst_SCRIPTS = autogen.sh - -## various *-local targets -## Remove the helper files for the linker and the pkg-config file if there -## is 'make distclean' called. NOTE: To re create the *.{map,sym} files you -## need to call the target update-map-file after the configure script was -## running! -distclean-local: - rm -f libcoap-$(LIBCOAP_API_VERSION).map - rm -f libcoap-$(LIBCOAP_API_VERSION).sym - rm -f libcoap-$(LIBCOAP_API_VERSION).pc - @echo - @echo " ---> Please note the following important advice! <---" - @echo " The files libcoap-$(LIBCOAP_API_VERSION).{map,sym} are removed by the distclean target!" - @echo " To regenerate this two files you need to call 'make update-map-file' first before any" - @echo " other Make target. Otherwise the build of libcoap will fail!" - @echo - -## Ensure we have actual *.{map,sym} files if we create a release tarball. -dist-local: update-map-file - -## Finaly some phony targets, just to ensure those targets are always buildable -## no matter if the user has created same called files. -.PHONY: update-map-file check_ctags - diff --git a/components/coap/libcoap/Makefile.libcoap b/components/coap/libcoap/Makefile.libcoap deleted file mode 100644 index 122e0faa..00000000 --- a/components/coap/libcoap/Makefile.libcoap +++ /dev/null @@ -1,7 +0,0 @@ -libcoap_src = pdu.c net.c debug.c encode.c uri.c subscribe.c resource.c hashkey.c str.c option.c async.c block.c mem.c coap_io.c - -libcoap_dir := $(filter %libcoap,$(APPDS)) -vpath %c $(libcoap_dir)/src - -# set include path for coap sources -CFLAGS += -I$(libcoap_dir)/include/coap -DCOAP_RESOURCES_NOHASH diff --git a/components/coap/libcoap/NEWS b/components/coap/libcoap/NEWS deleted file mode 100644 index e69de29b..00000000 diff --git a/components/coap/libcoap/README b/components/coap/libcoap/README deleted file mode 100644 index a582dbfe..00000000 --- a/components/coap/libcoap/README +++ /dev/null @@ -1,30 +0,0 @@ -libcoap: A C implementation of IETF Constrained Application Protocol (RFC 7252) - -Copyright (C) 2010--2015 by Olaf Bergmann - -ABOUT LIBCOAP -============= - -libcoap is a C implementation of a lightweight application-protocol -for devices that are constrained their resources such as computing -power, RF range, memory, bandwith, or network packet sizes. This -protocol, CoAP, is standardized by the IETF as RFC 7252. For further -information related to CoAP, see . - -PACKAGE CONTENTS -================ - -This directory contains a protocol parser and basic networking -functions for platform with support for malloc() and BSD-style -sockets. The examples directory contains a client and a server to -demonstrate the use of this library. - -LICENSE INFORMATION -=================== - -This library is published as open-source software without any warranty -of any kind. Use is permitted under the terms of the GNU General -Public License (GPL), Version 2 or higher, OR the simplified BSD -license. Please refer to LICENSE.GPL oder LICENSE.BSD for further -details. - diff --git a/components/coap/libcoap/README.md b/components/coap/libcoap/README.md deleted file mode 100644 index a582dbfe..00000000 --- a/components/coap/libcoap/README.md +++ /dev/null @@ -1,30 +0,0 @@ -libcoap: A C implementation of IETF Constrained Application Protocol (RFC 7252) - -Copyright (C) 2010--2015 by Olaf Bergmann - -ABOUT LIBCOAP -============= - -libcoap is a C implementation of a lightweight application-protocol -for devices that are constrained their resources such as computing -power, RF range, memory, bandwith, or network packet sizes. This -protocol, CoAP, is standardized by the IETF as RFC 7252. For further -information related to CoAP, see . - -PACKAGE CONTENTS -================ - -This directory contains a protocol parser and basic networking -functions for platform with support for malloc() and BSD-style -sockets. The examples directory contains a client and a server to -demonstrate the use of this library. - -LICENSE INFORMATION -=================== - -This library is published as open-source software without any warranty -of any kind. Use is permitted under the terms of the GNU General -Public License (GPL), Version 2 or higher, OR the simplified BSD -license. Please refer to LICENSE.GPL oder LICENSE.BSD for further -details. - diff --git a/components/coap/libcoap/TODO b/components/coap/libcoap/TODO deleted file mode 100644 index 503ea7a0..00000000 --- a/components/coap/libcoap/TODO +++ /dev/null @@ -1,61 +0,0 @@ -This is a simple file for all kinds of stuff related on devlopment for -libcoap. Please append (and remove) any issue you think its worthy. - -Classification of issues: - Critical -> Break the library in some kind or a missing feature, maybe not - directly but later - Serious -> No regression on the user side, more likly on the libcoap - development - Minor -> Things that are nice to have, but they are not time critical - -================= -* CRITICAL ISSUES -================= --> Remove the #include "coap_config.h" directive from the public header files. --> Remove #ifdef HAVE_ASSERT_H and so on from the public headers. --> Use coap.h as the only header to include from the public view. --> DTLS functionality - -> Adding DTLS functions based on openssl - -> Bill Benett has starting some improvements here, please contact him - first before starting something --> Proxy functionality - -> A coap-server should be able to act as proxy server - -================ -* SERIOUS ISSUES -================ --> Create some development rules like: - --> How to submit patches? What about pull requests? - --> How to implement/change platform related code? --> Adding some documentation for classical users on how to use the libcoap --> Clean up the various inclusion for #ifdef __cplusplus #extern "C" {} --> Adding additional config options (like --with-pdu-size) --> Split of the platform related code into [foo]_platform.c files --> In general, improving the online doxygen documentation like creating some - additional information for doxygen (startpage, development information, - ...) --> In special, improving ... - Adding prams and return explanation in: - include/coap/coap_io.h - include/coap/option.h - include/coap/net.h - include/coap/resource.h - include/coap/str.h - include/coap/subscribe.h - include/coap/uri.h - Adding @brief directive - include/coap/block.h - include/coap/coap_io.h - include/coap/debug.h - include/coap/encode.h - include/coap/net.h - include/coap/str.h - include/coap/subscribe.h - include/coap/uri.h - -============== -* MINOR ISSUES -============== --> Remove the not needed Makefile.in.old files --> Adding a logo for libcoap - diff --git a/components/coap/libcoap/autogen.sh b/components/coap/libcoap/autogen.sh deleted file mode 100755 index 0b8694e9..00000000 --- a/components/coap/libcoap/autogen.sh +++ /dev/null @@ -1,133 +0,0 @@ -#!/bin/sh -e - -# uncomment the set command for debugging -#set -x - -# function to check for needed helper tools -check_helper() { -#echo "Checking for $1 ..." -TOOL=`which "$1" || echo none` - -if [ "$TOOL" = "none" ]; then - echo - echo "Couldn't find '$1'!" - RET=1 -else - RET=0 -fi -} - -PROJECT="libcoap" - -AUTOGEN_FILES=" -INSTALL -aclocal.m4 ar-lib -coap_config.h coap_config.h.in* compile config.guess config.h* config.log config.status config.sub configure -depcomp -doc/Doxyfile doc/doxyfile.stamp doc/doxygen_sqlite3.db doc/Makefile doc/Makefile.in -examples/*.o examples/coap-client examples/coap-server examples/coap-rd -examples/coap-*.5 examples/coap-*.txt examples/Makefile.in -include/coap/coap.h -install-sh -libcoap-1.pc libtool ltmain.sh -missing -Makefile Makefile.in -stamp-h1 src/.dirstamp libcoap*.la* src/*.*o -tests/*.o tests/Makefile tests/testdriver -m4/libtool.m4 m4/lt~obsolete.m4 m4/ltoptions.m4 m4/ltsugar.m4 m4/ltversion.m4 -" - -AUTOGEN_DIRS=" -.deps -.libs autom4te.cache/ -doc/html/ -examples/.deps/ examples/.libs -src/.deps/ src/.libs/ -tests/.deps/ -" - -# checking for cleaner argument -echo -if [ "$1" = "--clean" ]; then - echo "removing autogerated files ..." - rm -rf $AUTOGEN_FILES $AUTOGEN_DIRS - echo "done" - exit -else - echo "[HINT] You can run 'autogen.sh --clean' to remove all generated files by the autotools." - echo -fi - -# checking for autoreconf -check_helper autoconf -if [ "$RET" = "1" ]; then - echo "You probably need to install the package 'autoconf'." - ERROR=1 -else - echo "Found 'autoconf'." -fi - -# checking for aclocal -check_helper aclocal -if [ "$RET" = "1" ]; then - echo "You probably need to install the package 'automake'." - ERROR=1 -else - echo "Found 'aclocal'." -fi - -# checking for pkg-config -check_helper pkg-config -if [ "$RET" = "1" ]; then - echo "You probably need to install the package 'pkg-config|pkgconf'." - ERROR=1 -else - echo "Found 'pkg-config'." -fi - -# checking for libtool -# The libtool helper maybe installed as 'libtoolize', checking for 'libtool' first. -check_helper libtool -if [ "$RET" = "1" ]; then - # O.k. libtool not found, searching for libtoolize. - check_helper libtoolize - if [ "$RET" = "1" ]; then - echo "You probably need to install the package 'libtool'." - # That's bad, we found nothing! - ERROR=1 - else - echo "Found 'libtoolize'." - break - fi -else - echo "Found 'libtool'." -fi - -# exit if one tool isn't available -if [ "$ERROR" = "1" ]; then - echo - echo "One or more needed tools are missing, exiting ..." - echo "Please install the needed software packages and restart 'autogen.sh' again." - echo - exit 1 -fi - -echo -echo " ---> Found all needed tools! That's fine." -echo - -# countinue otherwise -test -n "$srcdir" || srcdir=`dirname "$0"` -test -n "$srcdir" || srcdir=. - -# Creating the directory m4 before calling autoreconf to -# not struggle with old versions of aclocal. -mkdir -p $srcdir/m4 - -echo "Generating needed autotools files for $PROJECT by running autoreconf ..." -autoreconf --force --install --verbose "$srcdir" - -echo -echo "You can now run 'configure --help' to see possible configuration options." -echo "Otherwise process the configure script to create the makefiles and generated helper files." -echo diff --git a/components/coap/libcoap/configure.ac b/components/coap/libcoap/configure.ac deleted file mode 100644 index 8ae8840e..00000000 --- a/components/coap/libcoap/configure.ac +++ /dev/null @@ -1,423 +0,0 @@ -# configure.ac for the libcoap package -# -# Copyright (C) 2010-2015 Olaf Bergmann -# (C) 2015-2016 Carsten Schoenert -# -# Please run 'autogen.sh' to let autoconf produce a configure script. - -# Define the libcoap software version here. Note! The libtool versions are -# defined later. -m4_define([libcoap_major_version], [4]) -m4_define([libcoap_minor_version], [1]) -m4_define([libcoap_micro_version], [2]) - -m4_define([libcoap_version],[libcoap_major_version.libcoap_minor_version.libcoap_micro_version]) - -AC_INIT([libcoap], [libcoap_version], [libcoap-developers@lists.sourceforge.net], [libcoap], [https://libcoap.net/]) -AC_PREREQ([2.64]) -AM_INIT_AUTOMAKE([1.10 -Wall no-define no-dist-gzip dist-bzip2]) -PKG_PROG_PKG_CONFIG([0.20]) - -# Generate one configuration header file for building the library itself with -# an autogenerated template. We need later a second one (include/libcoap.h) -# that will be installed alongside the library. -AC_CONFIG_HEADERS([coap_config.h]) - -AC_PROG_CC -AM_PROG_CC_C_O -AC_PROG_SED -AC_CONFIG_MACRO_DIR([m4]) -m4_pattern_allow([AM_PROG_AR]) -AM_PROG_AR - -AC_C_BIGENDIAN - -# enable the automatically build of shared and static libraries, the unit -# tests needs the static library -LT_INIT([shared static]) - -# Setting the libtool versioning -################################################################################### -# # -# To set the version of the library, libtool provides the -version-info # -# parameter, which accepts three numbers, separated by colons, that are called # -# respectively, current, revision and age. Both their name and their behaviour, # -# nowadays, have to be considered fully arbitrary, as the explanation provided # -# in the official documentation is confusing to say the least, and can be, in # -# some cases, considered completely wrong. # -# https://autotools.io/libtool/version.html # -# # -################################################################################### -# -# How to work with the libtool versioning? -# -# Follow the followings steps from top to bottom. This means allways start at point 1 -# if you plan to make a release and change the values. -# Every new library starts with a version 'current' (short 'c') = 0 -# 'revision' (short 'r') = 0 -# 'age' (short 'a') = 0 -# -# Update the libtool versioning only immediately before a public release of libcoap. -# -# 1. If the library source code has changed at all since the last update, then -# increment revision (c:r:a becomes c:r+1:a). -# --> Increase the 'LT_LIBCOAP_REVISION' value with *everey* new software release. -# -# 2. If any interfaces [exported functions or data] have been added, removed, or -# changed since the last update, increment current, and set revision to 0 -# (c:r:a becomes c+1:r=0:a). -# --> Increase the 'LT_LIBCOAP_CURRENT' value whenever as an interface has been added, -# removed or changed. This implies also a API change! You mostly have to change -# the 'libcoap_major_version' then too! -# --> Set 'LT_LIBCOAP_REVISION' to 0. -# -# 3. If any interfaces have been added since the last public release, then increment -# age (c:r:a becomes c:r:a+1). Adding new interfaces will make the library allways -# backwards compatable. -# --> Increase the 'LT_LIBCOAP_AGE' value only if the changes made to the ABI are -# backward compatible. -# -# 4. If any interfaces whitin the library have been removed since the last public -# release, then set age to 0. -# --> Set 'LT_LIBCOAP_AGE' to 0. - -LT_LIBCOAP_CURRENT=0 -LT_LIBCOAP_REVISION=0 -LT_LIBCOAP_AGE=0 -LIBCOAP_SO_VERSION=$LT_LIBCOAP_CURRENT.$LT_LIBCOAP_REVISION.$LT_LIBCOAP_AGE - -# Announce the libtool version -AC_SUBST(LT_LIBCOAP_CURRENT) -AC_SUBST(LT_LIBCOAP_REVISION) -AC_SUBST(LT_LIBCOAP_AGE) -AC_SUBST(LIBCOAP_SO_VERSION) - -# Defining the API Version -LIBCOAP_API_VERSION=1 -AC_SUBST(LIBCOAP_API_VERSION) - -# Adding some default warning options for code QS -# see https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html -# and http://www.gnu.org/software/automake/manual/html_node/Flag-Variables-Ordering.html -WARNING_CFLAGS="\ --pedantic \ --Wall \ --Wextra \ --Wformat-security \ --Winline \ --Wmissing-declarations \ --Wmissing-prototypes \ --Wnested-externs \ --Wpointer-arith \ --Wshadow \ --Wstrict-prototypes \ --Wswitch-default \ --Wswitch-enum \ --Wunused \ -" - -# check whether or not the compiler supports -Wlogical-op (clang does not...) -AX_CHECK_COMPILE_FLAG([-Wlogical-op], [WARNING_CFLAGS="$WARNING_CFLAGS -Wlogical-op"],,[-Werror]) -AX_CHECK_COMPILE_FLAG([-fdiagnostics-color], [CFLAGS="$CFLAGS -fdiagnostics-color"],,[-Werror]) -AX_CHECK_COMPILE_FLAG([-Wunused-result], [WARNING_CFLAGS="$WARNING_CFLAGS -Wunused-result"]) - -AC_SUBST([WARNING_CFLAGS]) - -AX_CHECK_LINK_FLAG([-Wl,--version-script=./libcoap-${LIBCOAP_API_VERSION}.map], - [libcoap_SYMBOLS="-Wl,--version-script=\$(srcdir)/libcoap-\$(LIBCOAP_API_VERSION).map"], - [libcoap_SYMBOLS="-export-symbols \$(srcdir)/libcoap-\$(LIBCOAP_API_VERSION).sym"]) - -AC_SUBST(libcoap_SYMBOLS) - -# configure options -# __documentation__ -AC_ARG_ENABLE([documentation], - [AC_HELP_STRING([--enable-documentation], - [Enable building the documentation [default=yes]])], - [build_documentation="$enableval"], - [build_documentation="yes"]) - -if test "x$build_documentation" = "xyes"; then - # Check for doxygen - AC_PATH_PROGS([DOXYGEN], [doxygen]) - if test -z "$DOXYGEN"; then - if test "x$build_documentation" = "xyes"; then - AC_MSG_WARN([==> Doxygen not found - continuing without Doxygen support]) - AC_MSG_WARN([==> The libcoap html documentation will not be build!]) - doxygen_version="not found" - fi - else - AC_MSG_CHECKING([for compatible doxygen version (>= 1.7.0)]) - doxygen_version=`$DOXYGEN --version` - AS_VERSION_COMPARE([$doxygen_version], [1.7.0], - [AC_MSG_RESULT([no]) - DOXYGEN=""], - [AC_MSG_RESULT([yes $doxygen_version])], - [AC_MSG_RESULT([yes $doxygen_version])]) - if test "x$DOXYGEN" = "x" -a "x$build_documentation" = "xyes"; then - AC_MSG_ERROR([==> Doxygen $doxygen_version too old. Doxygen 1.7+ required for documentation build.]) - AC_MSG_ERROR([==> Install required doxygen version or disable the documentation using --disable-documentation]) - else - # we found doxygen and the version is valid - DOC_DIR=doc - AC_SUBST(DOC_DIR) - # now checking dot (needed for graphics) - AC_PATH_PROG([DOT], [dot]) - if test "x$DOT" = "x"; then - AC_MSG_WARN([==> dot not found - continuing without DOT support]) - AC_MSG_WARN([==> The libcoap html documentation will be build without DOT graphics!]) - HAVE_DOT="NO" - USE_CALL_GRAPH="NO" - else - AC_MSG_CHECKING([for compatible dot version (>= 2.26.0)]) - case $host in - *-freebsd1*) - # csh and tcsh have a different output redirection than more recent shells - # cmd >& file # Redirect both stdout and stderr to file. - # cmd >>& file # Append both stdout and stderr to file. - # cmd1 | cmd2 # pipe stdout to cmd2 - # cmd1 |& cmd2 # pipe stdout and stderr to cmd2 - # Using a explicit call with the default always available C-shell on FreeBSD, - # the user may have installed another shell from a port which we don't know here - dot_version=`export DOT=$DOT && csh -c '$DOT -V |& cut -f5 -d" "'` - ;; - - *) - dot_version=`$DOT -V 2>&1 | cut -f5 -d" "` - ;; - - esac - AS_VERSION_COMPARE([$dot_version], [2.26.0], - [AC_MSG_RESULT([no]) - DOT=""], - [AC_MSG_RESULT([yes $dot_version])], - [AC_MSG_RESULT([yes $dot_version])]) - if test "x$DOT" = "x" -a "x$build_documentation" = "xyes"; then - AC_MSG_WARN([==> Graphviz dot $dot_version too old. Graphviz 2.26+ required for documentation build.]) - AC_MSG_ERROR([==> Install required graphviz version or disable the documentation using --disable-documentation]) - fi - # we found dot and the version is valid - HAVE_DOT="YES" - # let doxygen create caller graphics - # see http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_call_graph - USE_CALL_GRAPH="YES" - # exporting the tests to doc/Doxygen(.in) - AC_SUBST(HAVE_DOT) - AC_SUBST(USE_CALL_GRAPH) - fi - fi - fi -fi -AM_CONDITIONAL(BUILD_DOCUMENTATION, [test "x$build_documentation" = "xyes"]) - -AM_CONDITIONAL([HAVE_DOXYGEN], - [test -n "$DOXYGEN"])AM_COND_IF([HAVE_DOXYGEN], - [AC_CONFIG_FILES([doc/Doxyfile])]) - -# configure options -# __tests__ -AC_ARG_ENABLE([tests], - [AC_HELP_STRING([--enable-tests], - [Enable building the binary testsuite [default=no]])], - [build_tests="$enableval"], - [build_tests="no"]) - -if test "x$build_tests" = "xyes"; then - PKG_CHECK_MODULES([CUNIT], - [cunit], - [have_cunit=yes - AC_DEFINE(HAVE_LIBCUNIT, [1], [Define if the system has libcunit])], - [have_cunit=no - AC_MSG_WARN([==> You want to build the testing binary but the pkg-config file cunit.pc could not be found or installed CUnit version is too old!]) - AC_MSG_ERROR([==> Install the package(s) containing the development files for CUnit or disable the testing binary using --disable-tests.]) - ]) -fi -AM_CONDITIONAL(HAVE_CUNIT, [test "x$CUNIT_LIBS" != "x"]) - -# configure options -# __examples__ -AC_ARG_ENABLE([examples], - [AC_HELP_STRING([--enable-examples], - [Enable building the example binaries [default=yes]])], - [build_examples="$enableval"], - [build_examples="yes"]) - -if test "x$build_examples" = "xyes" -a "x$build_documentation" = "xyes"; then - AC_ARG_VAR([A2X], [a2x command]) - AC_PATH_PROG([A2X], [a2x]) - if test "x$A2X" = "x"; then - AC_MSG_WARN([==> You want to build the examples binaries, that is also including the respective manpages but a2x was not found!]) - AC_MSG_ERROR([==> Install the package containg a2x (mostly asciidoc) or disable the build of the examples using --disable-examples.]) - fi - build_examples="yes" -fi -AM_CONDITIONAL(BUILD_EXAMPLES, [test "x$build_examples" = "xyes"]) - -# end configure options -####################### - -########################################## -# from configure options independed checks - -# Check for (ex)ctags binary -# The needed ctags binary name differs on FreeBSD and Linux, on Linux -# systems we search for 'ctags', on FreeBSD for 'exctags' -case $host in - # FreeBSD has exctags from the ctags port - *-freebsd1*) - AC_ARG_VAR([CTAGS_PROG],[the 'exctags' program to use for make target 'update-map-file']) - AC_PATH_PROG([CTAGS_PROG],[exctags],[HAVE_CTAGS=no]) - ;; - - *) - # Linux distributions have exuberant-ctags - AC_ARG_VAR([CTAGS_PROG],[the 'ctags' program to use for make target 'update-map-file']) - AC_PATH_PROG([CTAGS_PROG],[ctags],[HAVE_CTAGS=no]) - ;; - -esac - -if test "x$HAVE_CTAGS" = "xno"; then - AC_MSG_NOTICE([==> Note: '(ex)ctags' command not found!]) - AC_MSG_WARN([==> Without ctags you will be unable to run the target 'update-map-file'!]) - AC_MSG_WARN([==> This is no problem if you just want to build the library libcoap.]) -else - if test "`$CTAGS_PROG --help | grep '\---kinds'`" = ""; then - AC_MSG_NOTICE([==> Note: Your ctags binary does not support '--c-kinds'!]) - AC_MSG_NOTICE([==> Most likely, you are using the GNU Emacs ctag and not exuberant ctag.]) - AC_MSG_WARN([==> This option is required for the target 'update-map-file'.]) - AC_MSG_WARN([==> which is not a problem if you just want to build the library libcoap.]) - fi -fi - -# Checks for header files. -AC_CHECK_HEADERS([assert.h arpa/inet.h limits.h netdb.h netinet/in.h \ - stdlib.h string.h strings.h sys/socket.h sys/time.h \ - time.h unistd.h sys/unistd.h syslog.h]) - -# Checks for typedefs, structures, and compiler characteristics. -AC_TYPE_SIZE_T -AC_TYPE_SSIZE_T - -# Checks for library functions. -AC_CHECK_FUNCS([memset select socket strcasecmp strrchr getaddrinfo \ - strnlen malloc]) - -# Check if -lsocket -lnsl is required (specifically Solaris) -AC_SEARCH_LIBS([socket], [socket]) -AC_SEARCH_LIBS([inet_ntop], [nsl]) - -# Check if clock_gettime() requires librt, when available -AC_SEARCH_LIBS([clock_gettime], [rt]) - -AC_MSG_CHECKING([operating system]) - -# Set up here some extra platform depended defines and variables. -# The "ADDITIONAL_CFLAGS" is need as this stand-alone definition -# for the doxygen part. -case $host in - *-linux* | *-uclinux*) - AC_MSG_RESULT([Linux]) - ADDITIONAL_CFLAGS="-D_GNU_SOURCE -DWITH_POSIX" - - # Not yet needed but if some code definitions have to depend on the platform. - #AC_DEFINE(OS_LINUX, 1, [Linux backend]) - #AC_SUBST(OS_LINUX) - ;; - - *-solaris*) - AC_MSG_RESULT([Solaris]) - # set _XOPEN_SOURCE and _XOPEN_SOURCE_EXTENDED to enable XPG4v2 (POSIX 2004) - # set __EXTENSION__ to shut up feature test macros that restrict -std=c99 - # to only C99 (and nothing newer) - ADDITIONAL_CFLAGS="-D_XOPEN_SOURCE=600 -D_XOPEN_SOURCE_EXTENDED=600 -D__EXTENSIONS__=1 -DWITH_POSIX" - ;; - - *-darwin*) - AC_MSG_RESULT([Darwin]) - ADDITIONAL_CFLAGS="-D_GNU_SOURCE -DWITH_POSIX" - - AC_DEFINE(__APPLE_USE_RFC_3542, 1, [Define this to 1 for ancillary data on MacOS]) - - # Not yet needed but if some code definitions have to depend on the platform. - #AC_DEFINE(OS_MACOS, 1, [MacOS backend]) - #AC_SUBST(OS_MACOS) - ;; - - *-freebsd1*) - AC_MSG_RESULT([FreeBSD-1x]) - ADDITIONAL_CFLAGS="-D_GNU_SOURCE -DWITH_POSIX" - ;; - - *kfreebsd*) - AC_MSG_RESULT([kFreeBSD]) - ADDITIONAL_CFLAGS="-D_GNU_SOURCE -DWITH_POSIX" - ;; - - *) - AC_MSG_WARN([==> Currently unsupported operating system '${host}' !]) - AC_MSG_ERROR([==> If you can provide patches to support your operating system please write to 'libcoap-developers@lists.sourceforge.net'.]) -esac - -# Exporting the PREDEFINED_CFLAGS definition -PREDEFINED_CFLAGS=`echo $ADDITIONAL_CFLAGS | $SED -e 's/-D//g'` -AC_SUBST(PREDEFINED_CFLAGS) - -# And finaly combining the CFLAGS together ... -CFLAGS="$CFLAGS $ADDITIONAL_CFLAGS" - -# Override the various template files, currently just makefiles and the -# pkgconfig *.pc file. -# Later if the API version is changing dont forget to change the -# libcoap-$LIBCOAP_API_VERSION.pc.in file too!! You will have to change -# the 'Cflags' variable to something like -# Cflags: -I${includedir}/coap-@LIBCOAP_API_VERSION@ -# -AC_CONFIG_FILES([ -Makefile -doc/Makefile -examples/Makefile -examples/coap-client.txt -examples/coap-server.txt -examples/coap-rd.txt -include/coap/coap.h -tests/Makefile -libcoap-$LIBCOAP_API_VERSION.pc:libcoap-$LIBCOAP_API_VERSION.pc.in -]) - -AC_OUTPUT - -AC_MSG_RESULT([ -libcoap configuration summary: - libcoap package version : "$PACKAGE_VERSION" - libcoap library version : "$LIBCOAP_SO_VERSION" - libcoap API version : "$LIBCOAP_API_VERSION" - host system : "$host"]); -if test "x$build_documentation" = "xyes" -a "x$DOXYGEN" != "x"; then - AC_MSG_RESULT([ build documentation : "yes"]) - AC_MSG_RESULT([ --> Doxygen around : "yes" ($DOXYGEN $doxygen_version)]) - if test "x$DOT" = "x"; then - AC_MSG_RESULT([ --> dot around : "no" (DOT not found!)]) - else - AC_MSG_RESULT([ --> dot around : "yes" ($DOT $dot_version)]) - fi -else - if test "x$build_documentation" = "xno"; then - AC_MSG_RESULT([ build documentation : "no"]) - fi -fi -if test "x$build_tests" = "xyes"; then - AC_MSG_RESULT([ build unit test binary : "yes"]) -else - AC_MSG_RESULT([ build unit test binary : "no"]) -fi -if test "x$build_examples" = "xyes"; then - AC_MSG_RESULT([ build examples : "yes"]) - if test "x$A2X" != "x"; then - AC_MSG_RESULT([ --> use a2x : "yes" ($A2X)]) - else - AC_MSG_RESULT([ --> use a2x : "no"]) - fi -else - AC_MSG_RESULT([ build examples : "no"]) -fi diff --git a/components/coap/libcoap/doc/Doxyfile.in b/components/coap/libcoap/doc/Doxyfile.in deleted file mode 100644 index e7639ff6..00000000 --- a/components/coap/libcoap/doc/Doxyfile.in +++ /dev/null @@ -1,2354 +0,0 @@ -# Doxyfile 1.8.8 - -# 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 = @PACKAGE_NAME@ - -# 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 = @PACKAGE_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 an logo or 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 = - -# 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 = - -# 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 = YES - -# 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 = 4 - -# 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 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 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 - -# 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 = YES - -# 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. When 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 = NO - -# 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 = NO - -# 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 = NO - -# 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 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 - -# 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 = - -#--------------------------------------------------------------------------- -# 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. -# Note: If this tag is empty the current directory is searched. - -INPUT = @top_srcdir@/src \ - @top_srcdir@/include/coap - -# 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. 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, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = - -# 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@/src/coap_io_lwip.c \ - @top_srcdir@/include/coap/lwippools.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 = - -# 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 = - -# 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 = - -# 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. - -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. - -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 -# compiled with the --with-libclang option. -# 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 therefor more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra stylesheet files is of importance (e.g. the last -# stylesheet 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 stylesheet 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 NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - -# 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 = libcoap build system - -# 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 = org.doxygen.Project - -# 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 stylesheets (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 = NO - -# 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 - -# When 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 prerendered 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 -# , /