diff options
Diffstat (limited to 'LUFA')
| -rw-r--r-- | LUFA/Common/Attributes.h | 10 | ||||
| -rw-r--r-- | LUFA/Doxygen.conf | 4 | ||||
| -rw-r--r-- | LUFA/License.txt | 17 | ||||
| -rw-r--r-- | LUFA/ManPages/Donating.txt | 2 | ||||
| -rw-r--r-- | LUFA/ManPages/LUFAvsAtmelStack.txt | 2 | ||||
| -rw-r--r-- | LUFA/ManPages/Licence.txt | 38 | ||||
| -rw-r--r-- | LUFA/ManPages/LicenceInfo.txt | 20 | ||||
| -rw-r--r-- | LUFA/ManPages/MainPage.txt | 4 | ||||
| -rw-r--r-- | LUFA/ManPages/SoftwareBootloaderJump.txt | 4 |
9 files changed, 52 insertions, 49 deletions
diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h index 62d40734a..fed511a50 100644 --- a/LUFA/Common/Attributes.h +++ b/LUFA/Common/Attributes.h @@ -122,12 +122,16 @@ #endif
/** Places the function in one of the initialization sections, which execute before the main function
- * of the application. The init function number can be specified as "x", as an integer. Refer to the
- * avr-libc manual for more information on the initialization sections.
+ * of the application. Refer to the avr-libc manual for more information on the initialization sections.
+ *
+ * \param[in] x Initialization section number where the function should be placed
*/
#define ATTR_INIT_SECTION(x) __attribute__ ((naked, section (".init" #x )))
- /** Marks a function as an alias for another function of name "x". */
+ /** Marks a function as an alias for another function.
+ *
+ * \param[in] x Name of the function which the given function name should alias
+ */
#define ATTR_ALIAS(x) __attribute__ ((alias( #x )))
#endif
diff --git a/LUFA/Doxygen.conf b/LUFA/Doxygen.conf index 2c7faf3b1..ee8d9291f 100644 --- a/LUFA/Doxygen.conf +++ b/LUFA/Doxygen.conf @@ -296,7 +296,7 @@ TYPEDEF_HIDES_STRUCT = YES # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
-SYMBOL_CACHE_SIZE = 0
+SYMBOL_CACHE_SIZE = 1
#---------------------------------------------------------------------------
# Build related configuration options
@@ -642,7 +642,7 @@ EXCLUDE_SYMBOLS = __* # directories that contain example code fragments that are included (see
# the \include command).
-EXAMPLE_PATH =
+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
diff --git a/LUFA/License.txt b/LUFA/License.txt new file mode 100644 index 000000000..ea3b5d2dd --- /dev/null +++ b/LUFA/License.txt @@ -0,0 +1,17 @@ +Permission to use, copy, modify, and distribute this software
+and its documentation for any purpose is hereby granted without
+fee, provided that the above copyright notice appear in all
+copies and that both that the copyright notice and this
+permission notice and warranty disclaimer appear in supporting
+documentation, and that the name of the author not be used in
+advertising or publicity pertaining to distribution of the
+software without specific, written prior permission.
+
+The author disclaim all warranties with regard to this
+software, including all implied warranties of merchantability
+and fitness. In no event shall the author be liable for any
+special, indirect or consequential damages or any damages
+whatsoever resulting from loss of use, data or profits, whether
+in an action of contract, negligence or other tortious action,
+arising out of or in connection with the use or performance of
+this software.
diff --git a/LUFA/ManPages/Donating.txt b/LUFA/ManPages/Donating.txt index a09707820..ed778eaf2 100644 --- a/LUFA/ManPages/Donating.txt +++ b/LUFA/ManPages/Donating.txt @@ -15,7 +15,7 @@ * donations are <i>greatly</i> appreciated.
*
* Note that commercial entities can remove the attribution portion of the LUFA licence by a one-time fee - see
- * \ref Page_Licence for more details (<b>Note: Please do NOT pay this in advance through the donation link below -
+ * \ref Page_LicenceInfo for more details (<b>Note: Please do NOT pay this in advance through the donation link below -
* contact author for payment details.</b>).
*
* \image html "http://www.pledgie.com/campaigns/6927.png?skin_name=chrome"
diff --git a/LUFA/ManPages/LUFAvsAtmelStack.txt b/LUFA/ManPages/LUFAvsAtmelStack.txt index 89d85c108..8f39b7239 100644 --- a/LUFA/ManPages/LUFAvsAtmelStack.txt +++ b/LUFA/ManPages/LUFAvsAtmelStack.txt @@ -12,7 +12,7 @@ * official Atmel USB stack. Below are just some of the advantages to choosing LUFA over the official stack.
*
* - <b>Licensing:</b>
- * LUFA is released under a very permissive MIT license (see \ref Page_Licence), while the Atmel stack carries several
+ * LUFA is released under a very permissive MIT license (see \ref Page_LicenceInfo), while the Atmel stack carries several
* restrictions as to how and where it can be used. LUFA's licensing should be suitable for both Commercial and Non-Commercial
* entities alike.
*
diff --git a/LUFA/ManPages/Licence.txt b/LUFA/ManPages/Licence.txt deleted file mode 100644 index 2160d7960..000000000 --- a/LUFA/ManPages/Licence.txt +++ /dev/null @@ -1,38 +0,0 @@ -/** \file
- *
- * This file contains special DoxyGen information for the generation of the main page and other special
- * documentation pages. It is not a project source file.
- */
-
-/**
- * \page Page_Licence Source Code Licence
- *
- * The LUFA library is currently released under the MIT licence, included below.
- *
- * Commercial entities can opt out of the public disclosure clause in this license
- * for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which
- * allows for the free use of the LUFA library, bootloaders and (where the sole copyright
- * is attributed to Dean Camera) demos without public disclosure within an organisation, in
- * addition to three free hours of consultation with the library author, and priority support.
- * Please contact the author for more information via the address shown on on \ref Page_Resources.
- *
- * \verbatim
- * Permission to use, copy, modify, and distribute this software
- * and its documentation for any purpose is hereby granted without
- * fee, provided that the above copyright notice appear in all
- * copies and that both that the copyright notice and this
- * permission notice and warranty disclaimer appear in supporting
- * documentation, and that the name of the author not be used in
- * advertising or publicity pertaining to distribution of the
- * software without specific, written prior permission.
- *
- * The author disclaim all warranties with regard to this
- * software, including all implied warranties of merchantability
- * and fitness. In no event shall the author be liable for any
- * special, indirect or consequential damages or any damages
- * whatsoever resulting from loss of use, data or profits, whether
- * in an action of contract, negligence or other tortious action,
- * arising out of or in connection with the use or performance of
- * this software.
- * \endverbatim
- */
diff --git a/LUFA/ManPages/LicenceInfo.txt b/LUFA/ManPages/LicenceInfo.txt new file mode 100644 index 000000000..f105db7dc --- /dev/null +++ b/LUFA/ManPages/LicenceInfo.txt @@ -0,0 +1,20 @@ +/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/**
+ * \page Page_LicenceInfo Source Code Licence
+ *
+ * The LUFA library is currently released under the MIT licence, included below.
+ *
+ * Commercial entities can opt out of the public disclosure clause in this license
+ * for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which
+ * allows for the free use of the LUFA library, bootloaders and (where the sole copyright
+ * is attributed to Dean Camera) demos without public disclosure within an organisation, in
+ * addition to three free hours of consultation with the library author, and priority support.
+ * Please contact the author for more information via the address shown on on \ref Page_Resources.
+ *
+ * \verbinclude License.txt
+ */
diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt index 6bf772728..521b30ba6 100644 --- a/LUFA/ManPages/MainPage.txt +++ b/LUFA/ManPages/MainPage.txt @@ -13,7 +13,7 @@ *
* <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>
*
- * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_Licence).
+ * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenceInfo).
* It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,
* feature rich framework for the development of USB peripherals and hosts.
*
@@ -37,7 +37,7 @@ * - \subpage Page_WhyUseLUFA What are the advantages of using LUFA?
* - \subpage Page_LUFAvsAtmelStack How does LUFA compare to the Atmel USB AVR stack?
* - \subpage Page_AlternativeStacks Alternative USB AVR Stacks
- * - \subpage Page_Licence Project source licence and commercial use information
+ * - \subpage Page_LicenceInfo Project source licence and commercial use information
* - \subpage Page_Donating Donating to support this project
* - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects
*/
diff --git a/LUFA/ManPages/SoftwareBootloaderJump.txt b/LUFA/ManPages/SoftwareBootloaderJump.txt index afdc0b32a..82fce4a6d 100644 --- a/LUFA/ManPages/SoftwareBootloaderJump.txt +++ b/LUFA/ManPages/SoftwareBootloaderJump.txt @@ -31,8 +31,8 @@ * #define MAGIC_BOOT_KEY 0xDC42ACCA
* #define BOOTLOADER_START_ADDRESS ({FLASH_SIZE_BYTES} - {BOOTLOADER_SEC_SIZE_BYTES})
*
- * int Bootloader_Jump_Check(void) ATTR_INIT_SECTION(3);
- * int Bootloader_Jump_Check(void)
+ * void Bootloader_Jump_Check(void) ATTR_INIT_SECTION(3);
+ * void Bootloader_Jump_Check(void)
* {
* // If the bootloader key is correct, clear it and jump to the bootloader
* if (Boot_Key == MAGIC_BOOT_KEY)
|