diff --git a/demos/device/keyboard/descriptors.c b/demos/device/keyboard/descriptors.c index 7c342f278..54c5ed9e1 100644 --- a/demos/device/keyboard/descriptors.c +++ b/demos/device/keyboard/descriptors.c @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack */ #include "descriptors.h" diff --git a/demos/device/keyboard/descriptors.h b/demos/device/keyboard/descriptors.h index 61278f22b..277806439 100644 --- a/demos/device/keyboard/descriptors.h +++ b/demos/device/keyboard/descriptors.h @@ -27,7 +27,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack */ #ifndef _DESCRIPTORS_H_ diff --git a/doxygen.Doxyfile b/doxygen.Doxyfile index 66457bdf7..344d965de 100644 --- a/doxygen.Doxyfile +++ b/doxygen.Doxyfile @@ -360,12 +360,12 @@ LOOKUP_CACHE_SIZE = 0 # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = 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. -EXTRACT_PRIVATE = NO +EXTRACT_PRIVATE = YES # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. @@ -375,7 +375,7 @@ EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = 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. @@ -404,7 +404,7 @@ EXTRACT_ANON_NSPACES = NO # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. -HIDE_UNDOC_MEMBERS = YES +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. @@ -661,7 +661,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = tinyusb/class tinyusb/common tinyusb/host tinyusb/common/arch tinyusb/common/compiler tinyusb tinyusb\device +INPUT = tinyusb/class tinyusb/common tinyusb/host tinyusb/common/arch tinyusb/common/compiler tinyusb tinyusb\device overview.md license.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/license.md b/license.md new file mode 100644 index 000000000..a088666af --- /dev/null +++ b/license.md @@ -0,0 +1,27 @@ +# License + +Software License Agreement (BSD License)
+Copyright (c) 2012, hathach (tinyusb.net)
+All rights reserved.
+ +Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+ +1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+2. 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.
+3. The name of the author may not be used to endorse or promote products
+ derived from this software without specific prior written permission.
+ +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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. \ No newline at end of file diff --git a/licence.txt b/license.txt similarity index 100% rename from licence.txt rename to license.txt diff --git a/overview.md b/overview.md new file mode 100644 index 000000000..695690143 --- /dev/null +++ b/overview.md @@ -0,0 +1,3 @@ +# What is tinyUSB + +![tinyUSB diagram](overview.png) diff --git a/tinyusb/class/cdc.c b/tinyusb/class/cdc.c index 539981348..d62b7aa7d 100644 --- a/tinyusb/class/cdc.c +++ b/tinyusb/class/cdc.c @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ #include "cdc.h" diff --git a/tinyusb/class/cdc.h b/tinyusb/class/cdc.h index 25a666f78..668e2bf2d 100644 --- a/tinyusb/class/cdc.h +++ b/tinyusb/class/cdc.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/class/hid.c b/tinyusb/class/hid.c index 4058ea5db..579860b9e 100644 --- a/tinyusb/class/hid.c +++ b/tinyusb/class/hid.c @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ #include "hid.h" diff --git a/tinyusb/class/hid.h b/tinyusb/class/hid.h index 306e122c8..bde715b87 100644 --- a/tinyusb/class/hid.h +++ b/tinyusb/class/hid.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/arch/arch.h b/tinyusb/common/arch/arch.h index d67c5510e..aa806d3b0 100644 --- a/tinyusb/common/arch/arch.h +++ b/tinyusb/common/arch/arch.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/arch/arch_lpc11xx.h b/tinyusb/common/arch/arch_lpc11xx.h index 6e5990f33..38d391700 100644 --- a/tinyusb/common/arch/arch_lpc11xx.h +++ b/tinyusb/common/arch/arch_lpc11xx.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/arch/arch_lpc134x.h b/tinyusb/common/arch/arch_lpc134x.h index f4539acf7..a1c42ca7e 100644 --- a/tinyusb/common/arch/arch_lpc134x.h +++ b/tinyusb/common/arch/arch_lpc134x.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/arch/arch_lpc43xx.h b/tinyusb/common/arch/arch_lpc43xx.h index b80f44c65..a83d18c94 100644 --- a/tinyusb/common/arch/arch_lpc43xx.h +++ b/tinyusb/common/arch/arch_lpc43xx.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/arch/arm_mx.h b/tinyusb/common/arch/arm_mx.h index 074f466f1..b806f7b73 100644 --- a/tinyusb/common/arch/arm_mx.h +++ b/tinyusb/common/arch/arm_mx.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/common.h b/tinyusb/common/common.h index 44158f487..b35639574 100644 --- a/tinyusb/common/common.h +++ b/tinyusb/common/common.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/compiler/compiler.h b/tinyusb/common/compiler/compiler.h index 3ff94b3a4..61db9a936 100644 --- a/tinyusb/common/compiler/compiler.h +++ b/tinyusb/common/compiler/compiler.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/compiler/compiler_gcc.h b/tinyusb/common/compiler/compiler_gcc.h index a68d509d8..787f9f6ae 100644 --- a/tinyusb/common/compiler/compiler_gcc.h +++ b/tinyusb/common/compiler/compiler_gcc.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/errors.c b/tinyusb/common/errors.c index a1042b058..db93d5d84 100644 --- a/tinyusb/common/errors.c +++ b/tinyusb/common/errors.c @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ char const* const TUSB_ErrorStr[] = { diff --git a/tinyusb/common/errors.h b/tinyusb/common/errors.h index 48ff86aa2..e9644bb3d 100644 --- a/tinyusb/common/errors.h +++ b/tinyusb/common/errors.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/common/errors_def b/tinyusb/common/errors_def index 55c9fdbdf..9a69df2f7 100644 --- a/tinyusb/common/errors_def +++ b/tinyusb/common/errors_def @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ ERROR_ENUM(tERROR_NONE) diff --git a/tinyusb/common/fifo.c b/tinyusb/common/fifo.c index e72a5988d..71e9af4e1 100644 --- a/tinyusb/common/fifo.c +++ b/tinyusb/common/fifo.c @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ #include "fifo.h" diff --git a/tinyusb/common/fifo.h b/tinyusb/common/fifo.h index c0340517c..b23c56f0d 100644 --- a/tinyusb/common/fifo.h +++ b/tinyusb/common/fifo.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/device/dcd.c b/tinyusb/device/dcd.c index 40a6044e3..eb0077214 100644 --- a/tinyusb/device/dcd.c +++ b/tinyusb/device/dcd.c @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ #include "dcd.h" diff --git a/tinyusb/device/dcd.h b/tinyusb/device/dcd.h index ffd89b0a9..2db802e70 100644 --- a/tinyusb/device/dcd.h +++ b/tinyusb/device/dcd.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/host/hcd.c b/tinyusb/host/hcd.c index aa8e0f691..4a510d678 100644 --- a/tinyusb/host/hcd.c +++ b/tinyusb/host/hcd.c @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ #include "hcd.h" diff --git a/tinyusb/host/hcd.h b/tinyusb/host/hcd.h index e118d9e24..8ab648450 100644 --- a/tinyusb/host/hcd.h +++ b/tinyusb/host/hcd.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/tusb.h b/tinyusb/tusb.h index 29f05b3bd..81affc6c0 100644 --- a/tinyusb/tusb.h +++ b/tinyusb/tusb.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file diff --git a/tinyusb/tusb_cfg.h b/tinyusb/tusb_cfg.h index 466b08fea..34c28da07 100644 --- a/tinyusb/tusb_cfg.h +++ b/tinyusb/tusb_cfg.h @@ -32,7 +32,7 @@ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * - * This file is part of the tiny usb stack. + * This file is part of the tinyUSB stack. */ /** \file