Updated documentation.
This commit is contained in:
		
							parent
							
								
									e6da273119
								
							
						
					
					
						commit
						9f14e2c4b8
					
				
							
								
								
									
										237
									
								
								doc/Doxyfile
								
								
								
								
							
							
						
						
									
										237
									
								
								doc/Doxyfile
								
								
								
								
							|  | @ -1,4 +1,4 @@ | ||||||
| # Doxyfile 1.7.4 | # Doxyfile 1.8.1.2 | ||||||
| 
 | 
 | ||||||
| # This file describes the settings to be used by the documentation system | # This file describes the settings to be used by the documentation system | ||||||
| # doxygen (www.doxygen.org) for a project | # doxygen (www.doxygen.org) for a project | ||||||
|  | @ -22,8 +22,9 @@ | ||||||
| 
 | 
 | ||||||
| DOXYFILE_ENCODING      = UTF-8 | DOXYFILE_ENCODING      = UTF-8 | ||||||
| 
 | 
 | ||||||
| # The PROJECT_NAME tag is a single word (or a sequence of words surrounded  | # The PROJECT_NAME tag is a single word (or sequence of words) that should  | ||||||
| # by quotes) that should identify the project. | # identify the project. Note that if you do not use Doxywizard you need  | ||||||
|  | # to put quotes around the project name if it contains spaces. | ||||||
| 
 | 
 | ||||||
| PROJECT_NAME           = "Arduino MIDI Library" | PROJECT_NAME           = "Arduino MIDI Library" | ||||||
| 
 | 
 | ||||||
|  | @ -204,6 +205,13 @@ TAB_SIZE               = 4 | ||||||
| 
 | 
 | ||||||
| ALIASES                =  | 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  | # 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.  | # 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  | # For instance, some of the names that are used will be different. The list  | ||||||
|  | @ -242,6 +250,15 @@ OPTIMIZE_OUTPUT_VHDL   = NO | ||||||
| 
 | 
 | ||||||
| EXTENSION_MAPPING      =  | EXTENSION_MAPPING      =  | ||||||
| 
 | 
 | ||||||
|  | # If MARKDOWN_SUPPORT is enabled (the default) 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. | ||||||
|  | 
 | ||||||
|  | MARKDOWN_SUPPORT       = YES | ||||||
|  | 
 | ||||||
| # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want  | # 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  | # 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  | # set this tag to YES in order to let doxygen match functions declarations and  | ||||||
|  | @ -293,6 +310,15 @@ SUBGROUPING            = YES | ||||||
| 
 | 
 | ||||||
| INLINE_GROUPED_CLASSES = NO | INLINE_GROUPED_CLASSES = NO | ||||||
| 
 | 
 | ||||||
|  | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and  | ||||||
|  | # unions with only public data 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 (the default),  | ||||||
|  | # structs, classes, and unions are shown on a separate page (for HTML and Man  | ||||||
|  | # pages) or section (for LaTeX and RTF). | ||||||
|  | 
 | ||||||
|  | INLINE_SIMPLE_STRUCTS  = NO | ||||||
|  | 
 | ||||||
| # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum  | # 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  | # 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  | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct  | ||||||
|  | @ -315,10 +341,21 @@ TYPEDEF_HIDES_STRUCT   = NO | ||||||
| # a logarithmic scale so increasing the size by one will roughly double the  | # a logarithmic scale so increasing the size by one will roughly double the  | ||||||
| # memory usage. The cache size is given by this formula:  | # memory usage. The cache size is given by this formula:  | ||||||
| # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,  | # 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 | # corresponding to a cache size of 2^16 = 65536 symbols. | ||||||
| 
 | 
 | ||||||
| SYMBOL_CACHE_SIZE      = 0 | SYMBOL_CACHE_SIZE      = 0 | ||||||
| 
 | 
 | ||||||
|  | # Similar to the SYMBOL_CACHE_SIZE 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 appear 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. | ||||||
|  | 
 | ||||||
|  | LOOKUP_CACHE_SIZE      = 0 | ||||||
|  | 
 | ||||||
| #--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||||
| # Build related configuration options | # Build related configuration options | ||||||
| #--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||||
|  | @ -335,6 +372,11 @@ EXTRACT_ALL            = YES | ||||||
| 
 | 
 | ||||||
| EXTRACT_PRIVATE        = 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. | ||||||
|  | 
 | ||||||
|  | EXTRACT_PACKAGE        = NO | ||||||
|  | 
 | ||||||
| # If the EXTRACT_STATIC tag is set to YES all static members of a file  | # If the EXTRACT_STATIC tag is set to YES all static members of a file  | ||||||
| # will be included in the documentation. | # will be included in the documentation. | ||||||
| 
 | 
 | ||||||
|  | @ -522,12 +564,6 @@ MAX_INITIALIZER_LINES  = 30 | ||||||
| 
 | 
 | ||||||
| SHOW_USED_FILES        = YES | 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       = NO |  | ||||||
| 
 |  | ||||||
| # Set the SHOW_FILES tag to NO to disable the generation of the Files page.  | # 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  | # This will remove the Files entry from the Quick Index and from the  | ||||||
| # Folder Tree View (if specified). The default is YES. | # Folder Tree View (if specified). The default is YES. | ||||||
|  | @ -552,13 +588,23 @@ FILE_VERSION_FILTER    = | ||||||
| 
 | 
 | ||||||
| # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed  | # 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  | # by doxygen. The layout file controls the global structure of the generated  | ||||||
| # output files in an output format independent way. The create the layout file  | # output files in an output format independent way. To create the layout file  | ||||||
| # that represents doxygen's defaults, run doxygen with the -l option.  | # that represents doxygen's defaults, run doxygen with the -l option.  | ||||||
| # You can optionally specify a file name after the option, if omitted  | # You can optionally specify a file name after the option, if omitted  | ||||||
| # DoxygenLayout.xml will be used as the name of the layout file. | # DoxygenLayout.xml will be used as the name of the layout file. | ||||||
| 
 | 
 | ||||||
| LAYOUT_FILE            =  | LAYOUT_FILE            =  | ||||||
| 
 | 
 | ||||||
|  | # The CITE_BIB_FILES tag can be used to specify one or more bib files  | ||||||
|  | # containing the references data. This must be a list of .bib files. The  | ||||||
|  | # .bib extension is automatically appended if omitted. Using this command  | ||||||
|  | # 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. | ||||||
|  | 
 | ||||||
|  | CITE_BIB_FILES         =  | ||||||
|  | 
 | ||||||
| #--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||||
| # configuration options related to warning and progress messages | # configuration options related to warning and progress messages | ||||||
| #--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||||
|  | @ -620,7 +666,8 @@ WARN_LOGFILE           = | ||||||
| # with spaces. | # with spaces. | ||||||
| 
 | 
 | ||||||
| INPUT                  = ../ \ | INPUT                  = ../ \ | ||||||
|                          ../src |                          ../src \ | ||||||
|  |                          ./midi_DoxygenMainPage.h | ||||||
| 
 | 
 | ||||||
| # This tag can be used to specify the character encoding of the source files  | # 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  | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is  | ||||||
|  | @ -668,21 +715,24 @@ FILE_PATTERNS          = *.c \ | ||||||
|                          *.f90 \ |                          *.f90 \ | ||||||
|                          *.f \ |                          *.f \ | ||||||
|                          *.vhd \ |                          *.vhd \ | ||||||
|                          *.vhdl |                          *.vhdl \ | ||||||
|  |                          *.ino | ||||||
| 
 | 
 | ||||||
| # The RECURSIVE tag can be used to turn specify whether or not subdirectories  | # The RECURSIVE tag can be used to turn specify whether or not subdirectories  | ||||||
| # should be searched for input files as well. Possible values are YES and NO.  | # should be searched for input files as well. Possible values are YES and NO.  | ||||||
| # If left blank NO is used. | # If left blank NO is used. | ||||||
| 
 | 
 | ||||||
| RECURSIVE              = NO | RECURSIVE              = YES | ||||||
| 
 | 
 | ||||||
| # The EXCLUDE tag can be used to specify files and/or directories that should  | # 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  | # 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.  | # 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                =  | EXCLUDE                =  | ||||||
| 
 | 
 | ||||||
| # The EXCLUDE_SYMLINKS tag can be used select whether or not files or  | # 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  | # directories that are symbolic links (a Unix file system feature) are excluded  | ||||||
| # from the input. | # from the input. | ||||||
| 
 | 
 | ||||||
|  | @ -708,7 +758,7 @@ EXCLUDE_SYMBOLS        = | ||||||
| # directories that contain example code fragments that are included (see  | # directories that contain example code fragments that are included (see  | ||||||
| # the \include command). | # the \include command). | ||||||
| 
 | 
 | ||||||
| EXAMPLE_PATH           =  | EXAMPLE_PATH           = ../res/Examples | ||||||
| 
 | 
 | ||||||
| # If the value of the EXAMPLE_PATH tag contains directories, you can use the  | # 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  | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  | ||||||
|  | @ -722,7 +772,7 @@ EXAMPLE_PATTERNS       = * | ||||||
| # commands irrespective of the value of the RECURSIVE tag.  | # commands irrespective of the value of the RECURSIVE tag.  | ||||||
| # Possible values are YES and NO. If left blank NO is used. | # Possible values are YES and NO. If left blank NO is used. | ||||||
| 
 | 
 | ||||||
| EXAMPLE_RECURSIVE      = NO | EXAMPLE_RECURSIVE      = YES | ||||||
| 
 | 
 | ||||||
| # The IMAGE_PATH tag can be used to specify one or more files or  | # The IMAGE_PATH tag can be used to specify one or more files or  | ||||||
| # directories that contain image that are included in the documentation (see  | # directories that contain image that are included in the documentation (see  | ||||||
|  | @ -781,7 +831,7 @@ INLINE_SOURCES         = YES | ||||||
| 
 | 
 | ||||||
| # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct  | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct  | ||||||
| # doxygen to hide any special comment blocks from generated source code  | # doxygen to hide any special comment blocks from generated source code  | ||||||
| # fragments. Normal C and C++ comments will always remain visible. | # fragments. Normal C, C++ and Fortran comments will always remain visible. | ||||||
| 
 | 
 | ||||||
| STRIP_CODE_COMMENTS    = YES | STRIP_CODE_COMMENTS    = YES | ||||||
| 
 | 
 | ||||||
|  | @ -867,7 +917,7 @@ HTML_FILE_EXTENSION    = .html | ||||||
| # standard header. Note that when using a custom header you are responsible   | # standard header. Note that when using a custom header you are responsible   | ||||||
| # for the proper inclusion of any scripts and style sheets that doxygen  | # for the proper inclusion of any scripts and style sheets that doxygen  | ||||||
| # needs, which is dependent on the configuration options used.  | # needs, which is dependent on the configuration options used.  | ||||||
| # It is adviced to generate a default header using "doxygen -w html  | # It is advised to generate a default header using "doxygen -w html  | ||||||
| # header.html footer.html stylesheet.css YourConfigFile" and then modify  | # header.html footer.html stylesheet.css YourConfigFile" and then modify  | ||||||
| # that header. Note that the header is subject to change so you typically  | # 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  | # have to redo this when upgrading to a newer version of doxygen or when  | ||||||
|  | @ -930,20 +980,23 @@ HTML_COLORSTYLE_GAMMA  = 80 | ||||||
| 
 | 
 | ||||||
| HTML_TIMESTAMP         = YES | HTML_TIMESTAMP         = YES | ||||||
| 
 | 
 | ||||||
| # 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  | # 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  | # documentation will contain sections that can be hidden and shown after the  | ||||||
| # page has loaded. For this to work a browser that supports  | # page has loaded. | ||||||
| # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox  |  | ||||||
| # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |  | ||||||
| 
 | 
 | ||||||
| HTML_DYNAMIC_SECTIONS  = NO | 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. | ||||||
|  | 
 | ||||||
|  | HTML_INDEX_NUM_ENTRIES = 100 | ||||||
|  | 
 | ||||||
| # If the GENERATE_DOCSET tag is set to YES, additional index files  | # 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  | # will be generated that can be used as input for Apple's Xcode 3  | ||||||
| # integrated development environment, introduced with OSX 10.5 (Leopard).  | # integrated development environment, introduced with OSX 10.5 (Leopard).  | ||||||
|  | @ -1095,19 +1148,14 @@ GENERATE_ECLIPSEHELP   = NO | ||||||
| 
 | 
 | ||||||
| ECLIPSE_DOC_ID         = org.doxygen.Project | ECLIPSE_DOC_ID         = org.doxygen.Project | ||||||
| 
 | 
 | ||||||
| # The DISABLE_INDEX tag can be used to turn on/off the condensed index at  | # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)  | ||||||
| # top of each HTML page. The value NO (the default) enables the index and  | # at top of each HTML page. The value NO (the default) enables the index and  | ||||||
| # the value YES disables it. | # the value YES disables it. Since the tabs have the same information as the  | ||||||
|  | # navigation tree you can set this option to NO if you already set  | ||||||
|  | # GENERATE_TREEVIEW to YES. | ||||||
| 
 | 
 | ||||||
| DISABLE_INDEX          = NO | DISABLE_INDEX          = NO | ||||||
| 
 | 
 | ||||||
| # 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   = 4 |  | ||||||
| 
 |  | ||||||
| # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index  | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index  | ||||||
| # structure should be generated to display hierarchical information.  | # structure should be generated to display hierarchical information.  | ||||||
| # If the tag value is set to YES, a side panel will be generated  | # If the tag value is set to YES, a side panel will be generated  | ||||||
|  | @ -1115,13 +1163,17 @@ ENUM_VALUES_PER_LINE   = 4 | ||||||
| # is generated for HTML Help). For this to work a browser that supports  | # 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).  | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).  | ||||||
| # Windows users are probably better off using the HTML help feature.  | # Windows users are probably better off using the HTML help feature.  | ||||||
|  | # Since the tree basically has the same information as the tab index you  | ||||||
|  | # could consider to set DISABLE_INDEX to NO when enabling this option. | ||||||
| 
 | 
 | ||||||
| GENERATE_TREEVIEW      = NO | GENERATE_TREEVIEW      = NO | ||||||
| 
 | 
 | ||||||
| # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,  | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values  | ||||||
| # and Class Hierarchy pages using a tree view instead of an ordered list. | # (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. | ||||||
| 
 | 
 | ||||||
| USE_INLINE_TREES       = NO | ENUM_VALUES_PER_LINE   = 4 | ||||||
| 
 | 
 | ||||||
| # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be  | # 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  | # used to set the initial width (in pixels) of the frame in which the tree  | ||||||
|  | @ -1154,7 +1206,7 @@ FORMULA_TRANSPARENT    = YES | ||||||
| # (see http://www.mathjax.org) which uses client side Javascript for the  | # (see http://www.mathjax.org) which uses client side Javascript for the  | ||||||
| # rendering instead of using prerendered bitmaps. Use this if you do not  | # 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  | # have LaTeX installed or if you want to formulas look prettier in the HTML  | ||||||
| # output. When enabled you also need to install MathJax separately and  | # output. When enabled you may also need to install MathJax separately and  | ||||||
| # configure the path to it using the MATHJAX_RELPATH option. | # configure the path to it using the MATHJAX_RELPATH option. | ||||||
| 
 | 
 | ||||||
| USE_MATHJAX            = NO | USE_MATHJAX            = NO | ||||||
|  | @ -1163,13 +1215,18 @@ USE_MATHJAX            = NO | ||||||
| # HTML output directory using the MATHJAX_RELPATH option. The destination  | # HTML output directory using the MATHJAX_RELPATH option. The destination  | ||||||
| # directory should contain the MathJax.js script. For instance, if the mathjax  | # 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  | # 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_RELPATH should be ../mathjax. The default value points to  | ||||||
| # mathjax.org site, so you can quickly see the result without installing  | # the MathJax Content Delivery Network so you can quickly see the result without  | ||||||
| # MathJax, but it is strongly recommended to install a local copy of MathJax  | # installing MathJax.  However, it is strongly recommended to install a local  | ||||||
| # before deployment. | # copy of MathJax from http://www.mathjax.org before deployment. | ||||||
| 
 | 
 | ||||||
| MATHJAX_RELPATH        = http://www.mathjax.org/mathjax | MATHJAX_RELPATH        = http://www.mathjax.org/mathjax | ||||||
| 
 | 
 | ||||||
|  | # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension  | ||||||
|  | # names that should be enabled during MathJax rendering. | ||||||
|  | 
 | ||||||
|  | MATHJAX_EXTENSIONS     =  | ||||||
|  | 
 | ||||||
| # When the SEARCHENGINE tag is enabled doxygen will generate a search box  | # When the SEARCHENGINE tag is enabled doxygen will generate a search box  | ||||||
| # for the HTML output. The underlying search engine uses javascript  | # for the HTML output. The underlying search engine uses javascript  | ||||||
| # and DHTML and should work on any modern browser. Note that when using  | # and DHTML and should work on any modern browser. Note that when using  | ||||||
|  | @ -1283,6 +1340,12 @@ LATEX_HIDE_INDICES     = NO | ||||||
| 
 | 
 | ||||||
| LATEX_SOURCE_CODE      = NO | LATEX_SOURCE_CODE      = NO | ||||||
| 
 | 
 | ||||||
|  | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the  | ||||||
|  | # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See  | ||||||
|  | # http://en.wikipedia.org/wiki/BibTeX for more info. | ||||||
|  | 
 | ||||||
|  | LATEX_BIB_STYLE        = plain | ||||||
|  | 
 | ||||||
| #--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||||
| # configuration options related to the RTF output | # configuration options related to the RTF output | ||||||
| #--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||||
|  | @ -1448,13 +1511,13 @@ ENABLE_PREPROCESSING   = YES | ||||||
| # compilation will be performed. Macro expansion can be done in a controlled  | # compilation will be performed. Macro expansion can be done in a controlled  | ||||||
| # way by setting EXPAND_ONLY_PREDEF to YES. | # way by setting EXPAND_ONLY_PREDEF to YES. | ||||||
| 
 | 
 | ||||||
| MACRO_EXPANSION        = NO | MACRO_EXPANSION        = YES | ||||||
| 
 | 
 | ||||||
| # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES  | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES  | ||||||
| # then the macro expansion is limited to the macros specified with the  | # then the macro expansion is limited to the macros specified with the  | ||||||
| # PREDEFINED and EXPAND_AS_DEFINED tags. | # PREDEFINED and EXPAND_AS_DEFINED tags. | ||||||
| 
 | 
 | ||||||
| EXPAND_ONLY_PREDEF     = NO | EXPAND_ONLY_PREDEF     = YES | ||||||
| 
 | 
 | ||||||
| # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  | ||||||
| # pointed to by INCLUDE_PATH will be searched when a #include is found. | # pointed to by INCLUDE_PATH will be searched when a #include is found. | ||||||
|  | @ -1465,14 +1528,15 @@ SEARCH_INCLUDES        = YES | ||||||
| # contain include files that are not input files but should be processed by  | # contain include files that are not input files but should be processed by  | ||||||
| # the preprocessor. | # the preprocessor. | ||||||
| 
 | 
 | ||||||
| INCLUDE_PATH           =  | INCLUDE_PATH           = ../src | ||||||
| 
 | 
 | ||||||
| # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard  | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard  | ||||||
| # patterns (like *.h and *.hpp) to filter out the header-files in the  | # patterns (like *.h and *.hpp) to filter out the header-files in the  | ||||||
| # directories. If left blank, the patterns specified with FILE_PATTERNS will  | # directories. If left blank, the patterns specified with FILE_PATTERNS will  | ||||||
| # be used. | # be used. | ||||||
| 
 | 
 | ||||||
| INCLUDE_FILE_PATTERNS  =  | INCLUDE_FILE_PATTERNS  = *.h \ | ||||||
|  |                          *.hpp | ||||||
| 
 | 
 | ||||||
| # The PREDEFINED tag can be used to specify one or more macro names that  | # The PREDEFINED tag can be used to specify one or more macro names that  | ||||||
| # are defined before the preprocessor is started (similar to the -D option of  | # are defined before the preprocessor is started (similar to the -D option of  | ||||||
|  | @ -1482,7 +1546,10 @@ INCLUDE_FILE_PATTERNS  = | ||||||
| # undefined via #undef or recursively expanded use the := operator  | # undefined via #undef or recursively expanded use the := operator  | ||||||
| # instead of the = operator. | # instead of the = operator. | ||||||
| 
 | 
 | ||||||
| PREDEFINED             =  | PREDEFINED             = MIDI_USE_CALLBACKS=1 \ | ||||||
|  |                          MIDI_BUILD_INPUT=1 \ | ||||||
|  |                          MIDI_BUILD_OUTPUT=1 \ | ||||||
|  |                          MIDI_BUILD_THRU=1 | ||||||
| 
 | 
 | ||||||
| # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  | # 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.  | # this tag can be used to specify a list of macro names that should be expanded.  | ||||||
|  | @ -1497,26 +1564,22 @@ EXPAND_AS_DEFINED      = | ||||||
| # that are alone on a line, have an all uppercase name, and do not end with a  | # that are alone on a line, have an all uppercase name, and do not end with a  | ||||||
| # semicolon, because these will confuse the parser if not removed. | # semicolon, because these will confuse the parser if not removed. | ||||||
| 
 | 
 | ||||||
| SKIP_FUNCTION_MACROS   = YES | SKIP_FUNCTION_MACROS   = NO | ||||||
| 
 | 
 | ||||||
| #--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||||
| # Configuration::additions related to external references | # Configuration::additions related to external references | ||||||
| #--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||||
| 
 | 
 | ||||||
| # The TAGFILES option can be used to specify one or more tagfiles.  | # The TAGFILES option can be used to specify one or more tagfiles. For each  | ||||||
| # Optionally an initial location of the external documentation  | # tag file the location of the external documentation should be added. The  | ||||||
| # can be added for each tagfile. The format of a tag file without  | # format of a tag file without this location is as follows:  | ||||||
| # this location is as follows:  |  | ||||||
| #   TAGFILES = file1 file2 ...  | #   TAGFILES = file1 file2 ...  | ||||||
| # Adding location for the tag files is done as follows:  | # Adding location for the tag files is done as follows:  | ||||||
| #   TAGFILES = file1=loc1 "file2 = loc2" ...  | #   TAGFILES = file1=loc1 "file2 = loc2" ...  | ||||||
| # where "loc1" and "loc2" can be relative or absolute paths or  | # where "loc1" and "loc2" can be relative or absolute paths  | ||||||
| # URLs. If a location is present for each tag, the installdox tool  | # or URLs. Note that each tag file must have a unique name (where the name does  | ||||||
| # does not have to be run to correct the links.  | # NOT include the path). If a tag file is not located in the directory in which  | ||||||
| # Note that each tag file must have a unique name  | # doxygen is run, you must also specify the path to the tagfile here. | ||||||
| # (where the name does NOT include the path)  |  | ||||||
| # If a tag file is not located in the directory in which doxygen  |  | ||||||
| # is run, you must also specify the path to the tagfile here. |  | ||||||
| 
 | 
 | ||||||
| TAGFILES               =  | TAGFILES               =  | ||||||
| 
 | 
 | ||||||
|  | @ -1584,13 +1647,12 @@ HAVE_DOT               = NO | ||||||
| 
 | 
 | ||||||
| DOT_NUM_THREADS        = 0 | DOT_NUM_THREADS        = 0 | ||||||
| 
 | 
 | ||||||
| # By default doxygen will write a font called Helvetica to the output  | # By default doxygen will use the Helvetica font for all dot files that  | ||||||
| # directory and reference it in all dot files that doxygen generates.  | # doxygen generates. When you want a differently looking font you can specify  | ||||||
| # When you want a differently looking font you can specify the font name  | # the font name using DOT_FONTNAME. You need to make sure dot is able to find  | ||||||
| # using DOT_FONTNAME. You need to make sure dot is able to find the font,  | # the font, which can be done by putting it in a standard location or by setting  | ||||||
| # which can be done by putting it in a standard location or by setting the  | # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the  | ||||||
| # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory  | # directory containing the font. | ||||||
| # containing the font. |  | ||||||
| 
 | 
 | ||||||
| DOT_FONTNAME           = FreeSans | DOT_FONTNAME           = FreeSans | ||||||
| 
 | 
 | ||||||
|  | @ -1599,17 +1661,16 @@ DOT_FONTNAME           = FreeSans | ||||||
| 
 | 
 | ||||||
| DOT_FONTSIZE           = 10 | DOT_FONTSIZE           = 10 | ||||||
| 
 | 
 | ||||||
| # By default doxygen will tell dot to use the output directory to look for the  | # By default doxygen will tell dot to use the Helvetica font.  | ||||||
| # FreeSans.ttf font (which doxygen will put there itself). If you specify a  | # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to  | ||||||
| # different font using DOT_FONTNAME you can set the path where dot  | # set the path where dot can find it. | ||||||
| # can find it using this tag. |  | ||||||
| 
 | 
 | ||||||
| DOT_FONTPATH           =  | DOT_FONTPATH           =  | ||||||
| 
 | 
 | ||||||
| # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  | ||||||
| # will generate a graph for each documented class showing the direct and  | # will generate a graph for each documented class showing the direct and  | ||||||
| # indirect inheritance relations. Setting this tag to YES will force the  | # indirect inheritance relations. Setting this tag to YES will force the  | ||||||
| # the CLASS_DIAGRAMS tag to NO. | # CLASS_DIAGRAMS tag to NO. | ||||||
| 
 | 
 | ||||||
| CLASS_GRAPH            = YES | CLASS_GRAPH            = YES | ||||||
| 
 | 
 | ||||||
|  | @ -1631,6 +1692,15 @@ GROUP_GRAPHS           = YES | ||||||
| 
 | 
 | ||||||
| UML_LOOK               = NO | UML_LOOK               = NO | ||||||
| 
 | 
 | ||||||
|  | # If the UML_LOOK tag is enabled, the fields and methods are shown inside  | ||||||
|  | # the class node. If there are many fields or methods and many nodes the  | ||||||
|  | # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS  | ||||||
|  | # threshold limits the number of items for each type to make the size more  | ||||||
|  | # managable. Set this to 0 for no limit. Note that the threshold may be  | ||||||
|  | # exceeded by 50% before the limit is enforced. | ||||||
|  | 
 | ||||||
|  | UML_LIMIT_NUM_FIELDS   = 10 | ||||||
|  | 
 | ||||||
| # If set to YES, the inheritance and collaboration graphs will show the  | # If set to YES, the inheritance and collaboration graphs will show the  | ||||||
| # relations between templates and their instances. | # relations between templates and their instances. | ||||||
| 
 | 
 | ||||||
|  | @ -1671,7 +1741,7 @@ CALLER_GRAPH           = NO | ||||||
| 
 | 
 | ||||||
| GRAPHICAL_HIERARCHY    = YES | GRAPHICAL_HIERARCHY    = YES | ||||||
| 
 | 
 | ||||||
| # 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  | # then doxygen will show the dependencies a directory has on other directories  | ||||||
| # in a graphical way. The dependency relations are determined by the #include  | # in a graphical way. The dependency relations are determined by the #include  | ||||||
| # relations between the files in the directories. | # relations between the files in the directories. | ||||||
|  | @ -1680,10 +1750,21 @@ DIRECTORY_GRAPH        = YES | ||||||
| 
 | 
 | ||||||
| # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images  | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images  | ||||||
| # generated by dot. Possible values are svg, png, jpg, or gif.  | # generated by dot. Possible values are svg, png, jpg, or gif.  | ||||||
| # If left blank png will be used. | # If left blank png will be used. If you choose svg you need to set  | ||||||
|  | # HTML_FILE_EXTENSION to xhtml in order to make the SVG files  | ||||||
|  | # visible in IE 9+ (other browsers do not have this requirement). | ||||||
| 
 | 
 | ||||||
| DOT_IMAGE_FORMAT       = png | DOT_IMAGE_FORMAT       = png | ||||||
| 
 | 
 | ||||||
|  | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to  | ||||||
|  | # enable generation of interactive SVG images that allow zooming and panning.  | ||||||
|  | # Note that this requires a modern browser other than Internet Explorer.  | ||||||
|  | # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you  | ||||||
|  | # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files  | ||||||
|  | # visible. Older versions of IE do not have SVG support. | ||||||
|  | 
 | ||||||
|  | INTERACTIVE_SVG        = NO | ||||||
|  | 
 | ||||||
| # The tag DOT_PATH can be used to specify the path where the dot tool can be  | # The tag DOT_PATH can be used to specify the path where the dot tool can be  | ||||||
| # found. If left blank, it is assumed the dot tool can be found in the path. | # found. If left blank, it is assumed the dot tool can be found in the path. | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -1,23 +1,8 @@ | ||||||
| /*!
 | /*!
 | ||||||
|  \mainpage Arduino MIDI Library |  \mainpage Arduino MIDI Library | ||||||
|   |   | ||||||
|  \tableofcontents |  See the documentation of the main class, MidiInterface, or browse the modules | ||||||
|   |  using the toolbar above. | ||||||
|   |  | ||||||
|  \page howtodoc How to use this documentation |  | ||||||
| 
 |  | ||||||
|   You can browse the classes  |  | ||||||
|   |  | ||||||
|  \page howtolib How to use the library |  | ||||||
|   |  | ||||||
|  \section howtolib_section_callbacks Using callbacks |  | ||||||
|   |  | ||||||
|  Callbacks can simplify the reception of input messages. |  | ||||||
|   |  | ||||||
|   |  | ||||||
|   |  | ||||||
|  \page  |  | ||||||
|   |  | ||||||
|  */ |  */ | ||||||
| 
 | 
 | ||||||
| // -----------------------------------------------------------------------------
 | // -----------------------------------------------------------------------------
 | ||||||
|  | @ -40,3 +25,26 @@ | ||||||
|  \n |  \n | ||||||
|  */ |  */ | ||||||
| 
 | 
 | ||||||
|  | /*!
 | ||||||
|  |  \example MIDI_Callbacks.ino  | ||||||
|  |  This example shows how to use callbacks for easier MIDI input handling. \n | ||||||
|  |  */ | ||||||
|  | 
 | ||||||
|  | /*!
 | ||||||
|  |  \example MIDI_Bench.ino | ||||||
|  |  \example MIDI_DualMerger.ino | ||||||
|  |  \example MIDI_Input.ino | ||||||
|  |  */ | ||||||
|  | 
 | ||||||
|  | // -----------------------------------------------------------------------------
 | ||||||
|  | 
 | ||||||
|  | /*! \defgroup output   MIDI Output
 | ||||||
|  |  */ | ||||||
|  | /*! \defgroup input    MIDI Input
 | ||||||
|  |  */ | ||||||
|  | /*! \defgroup callbacks Callbacks 
 | ||||||
|  |  \ingroup input    | ||||||
|  |  */ | ||||||
|  | /*! \defgroup thru     MIDI Thru
 | ||||||
|  |  */ | ||||||
|  | 
 | ||||||
|  |  | ||||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
		Loading…
	
		Reference in New Issue
	
	 Francois Best
						Francois Best