Conditionally add available address spaces to the address space enum, for multiple address space architectures.

Update Doxygen configuration file for the latest Doxygen release. Minor documentation updates.
14 years ago · 2efa79d3ec
parent 06d00bb99b
commit 2efa79d3ec
4 changed files with 61 additions and 16 deletions
--- a/LUFA/Common/Endianness.h
+++ b/LUFA/Common/Endianness.h
@ -61,6 +61,10 @@
 			#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
 		#endif
 		
+		#if !(defined(ARCH_BIG_ENDIAN) || defined(ARCH_LITTLE_ENDIAN))
+			#error ARCH_BIG_ENDIAN or ARCH_LITTLE_ENDIAN not set for the specified architecture.
+		#endif
+
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
 			/** Swaps the byte ordering of a 16-bit value at compile-time. Do not use this macro for swapping byte orderings
--- a/LUFA/Doxygen.conf
+++ b/LUFA/Doxygen.conf
@ -1,4 +1,4 @@
-# Doxyfile 1.7.3
+# Doxyfile 1.7.4

 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@ -33,7 +33,9 @@ PROJECT_NAME           = "LUFA Library"

 PROJECT_NUMBER         = 000000

-# 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.
+# 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          =

@ -284,6 +286,13 @@ DISTRIBUTE_GROUP_DOC   = NO

 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).
+
+INLINE_GROUPED_CLASSES = NO
+
 # When TYPEDEF_HIDES_STRUCT 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
@ -459,8 +468,11 @@ SORT_GROUP_NAMES       = YES

 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
+# 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.

 STRICT_PROTO_MATCHING  = NO
@ -829,7 +841,13 @@ HTML_FILE_EXTENSION    = .html

 # The HTML_HEADER tag can be used to specify a personal HTML header for
 # each generated HTML page. If it is left blank doxygen will generate a
-# standard header.
+# standard header. Note that when using a custom header you are responsible
+# for the proper inclusion of any scripts and style sheets that doxygen
+# needs, which is dependent on the configuration options used.
+# It is adviced to generate a default header using "doxygen -w html
+# header.html footer.html stylesheet.css YourConfigFile" and then modify
+# that header. Note that the header is subject to change so you typically
+# have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!

 HTML_HEADER            =

@ -848,6 +866,15 @@ HTML_FOOTER            = ./ManPages/footer.htm

 HTML_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.
+
+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,
@ -1050,9 +1077,10 @@ ECLIPSE_DOC_ID         = org.doxygen.Project

 DISABLE_INDEX          = NO

-# This tag can be used to set the number of enum values (range [0,1..20])
-# 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.
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
+# (range [0,1..20]) 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.

 ENUM_VALUES_PER_LINE   = 1

@ -1111,7 +1139,8 @@ USE_MATHJAX            = NO
 # 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.org site, so you can quickly see the result without installing
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the
+# mathjax.org site, so you can quickly see the result without installing
 # MathJax, but it is strongly recommended to install a local copy of MathJax
 # before deployment.

@ -1190,6 +1219,13 @@ EXTRA_PACKAGES         =

 LATEX_HEADER           =

+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
+# the generated latex document. The footer should contain everything after
+# the last chapter. If it is left blank doxygen will generate a
+# standard footer. Notice: only use this tag if you know what you are doing!
+
+LATEX_FOOTER           =
+
 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
 # contain links (just like the HTML output) instead of page references
@ -1399,7 +1435,7 @@ MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = YES

 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
-# in the INCLUDE_PATH (see below) will be search if a #include is found.
+# pointed to by INCLUDE_PATH will be searched when a #include is found.

 SEARCH_INCLUDES        = YES

@ -1432,7 +1468,8 @@ PREDEFINED             = __DOXYGEN__ \
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.
 # The macro definition that is found in the sources will be used.
-# Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
+# Use the PREDEFINED tag if you want to use a different macro definition that
+# overrules the definition found in the source code.

 EXPAND_AS_DEFINED      =

@ -1625,7 +1662,7 @@ GRAPHICAL_HIERARCHY    = NO
 DIRECTORY_GRAPH        = YES

 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
-# generated by dot. Possible values are png, svg, gif or svg.
+# generated by dot. Possible values are svg, png, jpg, or gif.
 # If left blank png will be used.

 DOT_IMAGE_FORMAT       = png
--- a/LUFA/Drivers/USB/Core/DeviceStandardReq.h
+++ b/LUFA/Drivers/USB/Core/DeviceStandardReq.h
@ -71,8 +71,12 @@
 				 */
 				enum USB_DescriptorMemorySpaces_t
 				{
+					#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE) || defined(__DOXYGEN__)
 					MEMSPACE_FLASH    = 0, /**< Indicates the requested descriptor is located in FLASH memory. */
+					#endif
+					#if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE) || defined(__DOXYGEN__)
 					MEMSPACE_EEPROM   = 1, /**< Indicates the requested descriptor is located in EEPROM memory. */
+					#endif
 					MEMSPACE_RAM      = 2, /**< Indicates the requested descriptor is located in RAM memory. */
 				};
 			#endif
--- a/LUFA/ManPages/LUFAPoweredProjects.txt
+++ b/LUFA/ManPages/LUFAPoweredProjects.txt
@ -44,7 +44,7 @@
 *  - CD Driver Emulator Dongle for ISO Files: http://cdemu.blogspot.com/
 *  - ClockTamer, a configurable clock generator: http://code.google.com/p/clock-tamer/
 *  - DIY PS3 controller emulator: https://code.google.com/p/diyps3controller/
- *  - EMUCOMBOX, a USB-RS422 adapter for E-Mu Emax samplers: http://users.skynet.be/emxp/EMUCOMBOX.htm
+ *  - EMuSer, a USB-RS422 adapter for E-Mu samplers: http://www.emxp.net/EMuSer.htm
 *  - Estick JTAG, an ARM JTAG debugger: http://code.google.com/p/estick-jtag/
 *  - "Fingerlicking Wingdinger" (WARNING: Bad language if no Javascript), a MIDI controller: http://noisybox.net/electronics/wingdinger/
 *  - Flyatar, a real-time fly tracking system: https://github.com/peterpolidoro/Flyatar