From 8cfb3d9f09f7b88b58fdc2e882713fa7d27ba44b Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 17 May 2012 21:08:53 +0000 Subject: Update project Doxygen and makefiles so that the resulting project documentation hides the unused version value, and uses the same HTML CSS stylesheet as the library core. --- Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf | 4 ++-- Demos/Host/LowLevel/AndroidAccessoryHost/makefile | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'Demos/Host/LowLevel/AndroidAccessoryHost') diff --git a/Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf b/Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf index 4e6717bbd..7c75b5228 100644 --- a/Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf +++ b/Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf @@ -32,7 +32,7 @@ PROJECT_NAME = "LUFA Library - Android Accessory Mode Host Demo" # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 0.0.0 +PROJECT_NUMBER = # 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 @@ -1131,7 +1131,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # navigation tree you can set this option to NO if you already set # GENERATE_TREEVIEW to YES. -DISABLE_INDEX = NO +DISABLE_INDEX = YES # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. diff --git a/Demos/Host/LowLevel/AndroidAccessoryHost/makefile b/Demos/Host/LowLevel/AndroidAccessoryHost/makefile index bb944a295..b11f45dcd 100644 --- a/Demos/Host/LowLevel/AndroidAccessoryHost/makefile +++ b/Demos/Host/LowLevel/AndroidAccessoryHost/makefile @@ -695,7 +695,7 @@ clean_list : doxygen: @echo Generating Project Documentation \($(TARGET)\)... - @if ( doxygen Doxygen.conf 2>&1 | grep -v "warning: ignoring unsupported tag" ;); then \ + @if ( ( cat Doxygen.conf ; echo "HTML_STYLESHEET=$(LUFA_PATH)/LUFA/DoxygenPages/Style/Style.css" ) | doxygen - 2>&1 | grep -v "warning: ignoring unsupported tag" ;); then \ exit 1; \ fi; @echo Documentation Generation Complete. -- cgit v1.2.3 From c31fdbd03eee95660d65adb0f1bf7c0c397fd435 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Fri, 18 May 2012 18:39:35 +0000 Subject: Minor documentation adjustments to the demos, projects and bootloaders to ensure correct formatting of application device support. --- Demos/Host/LowLevel/AndroidAccessoryHost/AndroidAccessoryHost.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Demos/Host/LowLevel/AndroidAccessoryHost') diff --git a/Demos/Host/LowLevel/AndroidAccessoryHost/AndroidAccessoryHost.txt b/Demos/Host/LowLevel/AndroidAccessoryHost/AndroidAccessoryHost.txt index ce31d006f..70e0935c9 100644 --- a/Demos/Host/LowLevel/AndroidAccessoryHost/AndroidAccessoryHost.txt +++ b/Demos/Host/LowLevel/AndroidAccessoryHost/AndroidAccessoryHost.txt @@ -10,7 +10,7 @@ * * The following list indicates what microcontrollers are compatible with this demo. * - * - Series 7 USB AVRs (AT90USBxxx7) + * \li Series 7 USB AVRs (AT90USBxxx7) * * \section Sec_Info USB Information: * @@ -34,7 +34,7 @@ * Android Accessory Host Specification * * - * Usable Speeds: + * Supported USB Speeds: * Full Speed Mode * * -- cgit v1.2.3 From f2ae4dc255bd86438cffb62c138326b1c0b5725f Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 20 May 2012 10:55:59 +0000 Subject: Upgrade Doxygen configuration files for Doxygen 1.8.1, fix broken stylesheet and footer HTML, add explicit spacing into documentation code fragments to prevent Doxygen from removing empty lines in the output. --- .../LowLevel/AndroidAccessoryHost/Doxygen.conf | 36 +++++++++------------- 1 file changed, 15 insertions(+), 21 deletions(-) (limited to 'Demos/Host/LowLevel/AndroidAccessoryHost') diff --git a/Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf b/Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf index 7c75b5228..36cb2f08e 100644 --- a/Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf +++ b/Demos/Host/LowLevel/AndroidAccessoryHost/Doxygen.conf @@ -1,4 +1,4 @@ -# Doxyfile 1.8.0 +# Doxyfile 1.8.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -32,7 +32,7 @@ PROJECT_NAME = "LUFA Library - Android Accessory Mode Host Demo" # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = # 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 @@ -563,12 +563,6 @@ MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = 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 is YES. @@ -960,12 +954,6 @@ HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = NO -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = 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. For this to work a browser that supports @@ -974,6 +962,17 @@ HTML_ALIGN_MEMBERS = YES HTML_DYNAMIC_SECTIONS = YES +# 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. + +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, introduced with OSX 10.5 (Leopard). @@ -1131,7 +1130,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # navigation tree you can set this option to NO if you already set # GENERATE_TREEVIEW to YES. -DISABLE_INDEX = YES +DISABLE_INDEX = YES # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. @@ -1152,11 +1151,6 @@ GENERATE_TREEVIEW = YES ENUM_VALUES_PER_LINE = 1 -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - # 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. @@ -1725,7 +1719,7 @@ CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = NO -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. -- cgit v1.2.3