diff options
Diffstat (limited to 'peripheral/libupm/doxy')
28 files changed, 0 insertions, 9071 deletions
diff --git a/peripheral/libupm/doxy/Doxyfile.in b/peripheral/libupm/doxy/Doxyfile.in deleted file mode 100644 index 83db5af..0000000 --- a/peripheral/libupm/doxy/Doxyfile.in +++ /dev/null @@ -1,2370 +0,0 @@ -# Doxyfile 1.8.6 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = upm - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = @upm_VERSION_STRING@ - -# 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 = "Sensor/Actuator repository for libmraa (v@MRAA_VERSION@)" - -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = NO - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -DETAILS_AT_TOP = YES - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = library="@ingroup " \ - sensor="@li **ID:** " \ - comname="@li **Name:** " \ - altname="@li **Other Names:** " \ - altid="@li **Other Chips:** " \ - type="@li **Category:** " \ - man="@li **Manufacturer:** " \ - web="@li **Link:** " \ - con="@li **Connection:** " \ - kit="@li **Kit:** " \ - -# 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 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 of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. -# -# Note For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled 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. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# 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 set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -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). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef 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, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag 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 -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# 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 appears 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. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will -# be included in the documentation. -# The default value is: 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. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -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. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = YES - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = NO - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = NO - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -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 will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if <section_label> ... \endif and \cond <section_label> -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = 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 value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# 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 -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = @CMAKE_CURRENT_SOURCE_DIR@/doxy/DoxygenLayout.xml - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This 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. Do not use file names with spaces, bibtex cannot handle them. See -# also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. -# Note: If this tag is empty the current directory is searched. - -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/upm.h \ - @CMAKE_CURRENT_SOURCE_DIR@/src \ - @CMAKE_CURRENT_SOURCE_DIR@/docs \ - @CMAKE_CURRENT_SOURCE_DIR@/doxy/README.cpp.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. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf \ - *.as \ - *.js - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# 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 -# 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 = @PROJECT_SOURCE_DIR@/src/doxy2swig.py - -# 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 -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = aci_* - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples/c++ \ - @CMAKE_CURRENT_SOURCE_DIR@/docs/ \ - @CMAKE_CURRENT_SOURCE_DIR@/src/max31855/ - -# 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 and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = *.cxx - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/docs/images/ - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# <filter> <input-file> -# -# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = @CMAKE_CURRENT_SOURCE_DIR@/doxy/README.cpp.md - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- -# defined cascading style sheet that is included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet file to the output directory. For an example -# see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_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. -# This tag requires that the tag GENERATE_HTML is set to YES. - -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, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = 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. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -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. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -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 (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that 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). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 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. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# 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. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the 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 output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the 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 -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use <access key> + S -# (what the <access key> is depends on the OS and browser, but it is typically -# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down -# key> to jump into the search results window, the results can be navigated -# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel -# the search. The filter options can be selected when the cursor is inside the -# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> -# to select a filter and <Enter> or <escape> to activate or cancel the filter -# option. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a web server instead of a web client using Javascript. There -# are two flavours of web server based searching depending on the -# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for -# searching and an index file used by the script. When EXTERNAL_SEARCH is -# enabled the indexing and searching needs to be provided by external tools. See -# the section "External Indexing and Searching" for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SERVER_BASED_SEARCH = NO - -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP -# script for searching. Instead the search results are written to an XML file -# which needs to be processed by an external indexer. Doxygen will invoke an -# external search engine pointed to by the SEARCHENGINE_URL option to obtain the -# search results. -# -# Doxygen ships with an example indexer ( doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). -# -# See the section "External Indexing and Searching" for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH = NO - -# The SEARCHENGINE_URL should point to a search engine hosted by a web server -# which will return the search results when EXTERNAL_SEARCH is enabled. -# -# Doxygen ships with an example indexer ( doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and -# Searching" for details. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHENGINE_URL = - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed -# search data is written to a file for indexing by an external tool. With the -# SEARCHDATA_FILE tag the name of this file can be specified. -# The default file is: searchdata.xml. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHDATA_FILE = searchdata.xml - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the -# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is -# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple -# projects and redirect the results back to the right project. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH_ID = - -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen -# projects other than the one defined by this configuration file, but that are -# all added to the same external search index. Each project needs to have a -# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of -# to a relative location where the documentation can be found. The format is: -# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTRA_SEARCH_MAPPINGS = - -#--------------------------------------------------------------------------- -# Configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. -# The default value is: YES. - -GENERATE_LATEX = YES - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: latex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. -# -# Note that when enabling USE_PDFLATEX this option is only used for generating -# bitmaps for formulas in the HTML output, but not in the Makefile that is -# written to the output directory. -# The default file is: latex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate -# index for LaTeX. -# The default file is: makeindex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX -# documents. This may be useful for small projects and may help to save some -# trees in general. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used by the -# printer. -# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x -# 14 inches) and executive (7.25 x 10.5 inches). -# The default value is: a4. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -PAPER_TYPE = a4 - -# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names -# that should be included in the LaTeX output. To get the times font for -# instance you can specify -# EXTRA_PACKAGES=times -# If left blank no extra packages will be included. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the -# generated LaTeX document. The header should contain everything until the first -# chapter. If it is left blank doxygen will generate a standard header. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. -# -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will -# replace them by respectively the title of the page, the current date and time, -# only the current date, the version number of doxygen, the project name (see -# PROJECT_NAME), or the project number (see PROJECT_NUMBER). -# This tag requires that the tag GENERATE_LATEX is set to YES. - -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. -# -# Note: Only use a user-defined footer if you know what you are doing! -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_FOOTER = - -# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the LATEX_OUTPUT output -# directory. Note that the files will be copied as-is; there are no commands or -# markers available. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_EXTRA_FILES = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is -# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will -# contain links (just like the HTML output) instead of page references. This -# makes the output suitable for online browsing using a PDF viewer. -# The default value is: YES. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -PDF_HYPERLINKS = YES - -# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES to get a -# higher quality PDF documentation. -# The default value is: YES. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_BATCHMODE = NO - -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the -# index chapters (such as File Index, Compound Index, etc.) in the output. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_HIDE_INDICES = NO - -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -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. See -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_BIB_STYLE = plain - -#--------------------------------------------------------------------------- -# Configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The -# RTF output is optimized for Word 97 and may not look too pretty with other RTF -# readers/editors. -# The default value is: NO. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: rtf. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF -# documents. This may be useful for small projects and may help to save some -# trees in general. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will -# contain hyperlink fields. The RTF file will contain links (just like the HTML -# output) instead of page references. This makes the output suitable for online -# browsing using Word or some other Word compatible readers that support those -# fields. -# -# Note: WordPad (write) and others do not support links. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's config -# file, i.e. a series of assignments. You only have to provide replacements, -# missing definitions are set to their default value. -# -# See also section "Doxygen usage" for information on how to generate the -# default style sheet that doxygen normally uses. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's config file. A template extensions file can be generated -# using doxygen -e rtf extensionFile. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for -# classes and files. -# The default value is: NO. - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. A directory man3 will be created inside the directory specified by -# MAN_OUTPUT. -# The default directory is: man. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to the generated -# man pages. In case the manual section does not start with a number, the number -# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is -# optional. -# The default value is: .3. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it -# will generate one additional man file for each entity documented in the real -# man page(s). These additional files only source the real man page, but without -# them the man command would be unable to find the correct page. -# The default value is: NO. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that -# captures the structure of the code including all documentation. -# The default value is: NO. - -GENERATE_XML = YES - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: xml. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify a XML DTD, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program -# listings (including syntax highlighting and cross-referencing information) to -# the XML output. Note that enabling this will significantly increase the size -# of the XML output. -# The default value is: YES. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the DOCBOOK output -#--------------------------------------------------------------------------- - -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files -# that can be used to generate PDF. -# The default value is: NO. - -GENERATE_DOCBOOK = NO - -# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in -# front of it. -# The default directory is: docbook. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_OUTPUT = docbook - -#--------------------------------------------------------------------------- -# Configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen -# Definitions (see http://autogen.sf.net) file that captures the structure of -# the code including all documentation. Note that this feature is still -# experimental and incomplete at the moment. -# The default value is: NO. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module -# file that captures the structure of the code including all documentation. -# -# Note that this feature is still experimental and incomplete at the moment. -# The default value is: NO. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary -# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI -# output from the Perl module output. -# The default value is: NO. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely -# formatted so it can be parsed by a human reader. This is useful if you want to -# understand what is going on. On the other hand, if this tag is set to NO the -# size of the Perl module output will be much smaller and Perl will parse it -# just the same. -# The default value is: YES. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file are -# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful -# so different doxyrules.make files included by the same Makefile don't -# overwrite each other's variables. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all -# C-preprocessor directives found in the sources and include files. -# The default value is: YES. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names -# in the source code. If set to NO only conditional compilation will be -# performed. Macro expansion can be done in a controlled way by setting -# EXPAND_ONLY_PREDEF to YES. -# The default value is: NO. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -MACRO_EXPANSION = NO - -# 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 PREDEFINED and -# EXPAND_AS_DEFINED tags. -# The default value is: NO. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES the includes files in the -# INCLUDE_PATH will be searched if a #include is found. -# The default value is: YES. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by the -# preprocessor. -# This tag requires that the tag SEARCH_INCLUDES is set to YES. - -INCLUDE_PATH = - -# 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 -# directories. If left blank, the patterns specified with FILE_PATTERNS will be -# used. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -INCLUDE_FILE_PATTERNS = - -# 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 e.g. -# gcc). The argument of the tag is a list of macros of the form: name or -# name=definition (no spaces). If the definition and the "=" are omitted, "=1" -# is assumed. To prevent a macro definition from being undefined via #undef or -# recursively expanded use the := operator instead of the = operator. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -PREDEFINED = - -# 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. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will -# remove all refrences to function-like macros that are alone on a line, have an -# all uppercase name, and do not end with a semicolon. Such function macros are -# typically used for boiler-plate code, and will confuse the parser if not -# removed. -# The default value is: YES. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES tag can be used to specify one or more tag files. For each tag -# file the location of the external documentation should be added. The format of -# a tag file without this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where loc1 and loc2 can be relative or absolute paths or URLs. See the -# section "Linking to external documentation" for more information about the use -# of tag files. -# Note: Each tag file must have an unique name (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 = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a -# tag file that is based on the input files it reads. See section "Linking to -# external documentation" for more information about the usage of tag files. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the -# class index. If set to NO only the inherited external classes will be listed. -# The default value is: NO. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in -# the modules index. If set to NO, only the current project's groups will be -# listed. -# The default value is: YES. - -EXTERNAL_GROUPS = YES - -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in -# the related pages index. If set to NO, only the current project's pages will -# be listed. -# The default value is: YES. - -EXTERNAL_PAGES = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = NO - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide inheritance -# and usage relations if the target is undocumented or is not a class. -# The default value is: YES. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent -# Bell Labs. The other options in this section have no effect if this option is -# set to NO -# The default value is: NO. - -HAVE_DOT = YES - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed -# to run in parallel. When set to 0 doxygen will base this on the number of -# processors available in the system. You can set it explicitly to a value -# larger than 0 to get control over the balance between CPU load and processing -# speed. -# Minimum value: 0, maximum value: 32, default value: 0. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_NUM_THREADS = 0 - -# When you want a differently looking font n the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTPATH = - -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a -# graph for each documented class showing the direct and indirect implementation -# dependencies (inheritance, containment, and class references variables) of the -# class with other documented classes. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -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 manageable. Set this to 0 -# for no limit. Note that the threshold may be exceeded by 50% before the limit -# is enforced. So when you set the threshold to 10, up to 15 fields may appear, -# but if the number exceeds 15, the total amount of fields shown is limited to -# 10. -# Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -UML_LIMIT_NUM_FIELDS = 10 - -# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and -# collaboration graphs will show the relations between templates and their -# instances. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -TEMPLATE_RELATIONS = NO - -# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to -# YES then doxygen will generate a graph for each documented file showing the -# direct and indirect include dependencies of the file with other documented -# files. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -INCLUDE_GRAPH = YES - -# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are -# set to YES then doxygen will generate a graph for each documented file showing -# the direct and indirect include dependencies of the file with other documented -# files. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -INCLUDED_BY_GRAPH = NO - -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call -# dependency graph for every global function or class method. -# -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -CALL_GRAPH = YES - -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller -# dependency graph for every global function or class method. -# -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -CALLER_GRAPH = YES - -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical -# hierarchy of all classes instead of a textual one. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH tag is 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. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. -# Note: 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). -# Possible values are: png, jpg, gif and svg. -# The default value is: png. -# This tag requires that the tag HAVE_DOT is set to YES. - -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. -# Note: 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. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -INTERACTIVE_SVG = NO - -# The DOT_PATH tag 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. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the \dotfile -# command). -# This tag requires that the tag HAVE_DOT is set to YES. - -DOTFILE_DIRS = - -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the \mscfile -# command). - -MSCFILE_DIRS = - -# The DIAFILE_DIRS tag can be used to specify one or more directories that -# contain dia files that are included in the documentation (see the \diafile -# command). - -DIAFILE_DIRS = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes -# that will be shown in the graph. If the number of nodes in a graph becomes -# larger than this value, doxygen will truncate the graph, which is visualized -# by representing a node as a red box. Note that doxygen if the number of direct -# children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that -# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. -# Minimum value: 0, maximum value: 10000, default value: 50. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs -# generated by dot. A depth value of 3 means that only nodes reachable from the -# root by following a path via at most 3 edges will be shown. Nodes that lay -# further from the root node will be omitted. Note that setting this option to 1 -# or 2 may greatly reduce the computation time needed for large code bases. Also -# note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. -# Minimum value: 0, maximum value: 1000, default value: 0. -# This tag requires that the tag HAVE_DOT is set to YES. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) support -# this, this feature is disabled by default. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page -# explaining the meaning of the various boxes and arrows in the dot generated -# graphs. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot -# files that are used to generate the various graphs. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_CLEANUP = YES diff --git a/peripheral/libupm/doxy/Doxyfile.java.in b/peripheral/libupm/doxy/Doxyfile.java.in deleted file mode 100644 index bc873d1..0000000 --- a/peripheral/libupm/doxy/Doxyfile.java.in +++ /dev/null @@ -1,2332 +0,0 @@ -# Doxyfile 1.8.6 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = upm - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = @upm_VERSION_STRING@ - -# 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 = "Sensor/Actuator repository for libmraa (v@MRAA_VERSION@)" - -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = NO - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -DETAILS_AT_TOP = YES - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = library="@ingroup " \ - sensor="@li **ID:** " \ - comname="@li **Name:** " \ - altname="@li **Other Names:** " \ - altid="@li **Other Chips:** " \ - type="@li **Category:** " \ - man="@li **Manufacturer:** " \ - web="@li **Link:** " \ - con="@li **Connection:** " \ - kit="@li **Kit:** " \ - -# 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 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 of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = YES - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. -# -# Note For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled 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. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# 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 set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -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). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef 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, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag 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 -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# 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 appears 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. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will -# be included in the documentation. -# The default value is: 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. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -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. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = YES - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = NO - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -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 will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if <section_label> ... \endif and \cond <section_label> -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = 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 value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# 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 -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = @CMAKE_CURRENT_SOURCE_DIR@/doxy/DoxygenLayout.xml - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This 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. Do not use file names with spaces, bibtex cannot handle them. See -# also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. -# Note: If this tag is empty the current directory is searched. - -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src/upm.h \ - @CMAKE_BINARY_DIR@/src \ - @CMAKE_CURRENT_SOURCE_DIR@/docs \ - @CMAKE_CURRENT_SOURCE_DIR@/doxy/README.java.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. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = *.java \ - *.md - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# 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 -# 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 = @PROJECT_SOURCE_DIR@/src/doxy2swig.py - -# 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 -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = */SWIGTYPE_* */javaupm_* - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = aci_* - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples/java/ \ - @CMAKE_CURRENT_SOURCE_DIR@/docs/ \ - @CMAKE_CURRENT_SOURCE_DIR@/src/max31855/ - -# 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 and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = *.cxx \ - *.java \ - *.md - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/docs/images/ - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# <filter> <input-file> -# -# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = @CMAKE_CURRENT_SOURCE_DIR@/doxy/README.java.md - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- -# defined cascading style sheet that is included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet file to the output directory. For an example -# see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_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. -# This tag requires that the tag GENERATE_HTML is set to YES. - -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, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 20 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 150 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = 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. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -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. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -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 (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that 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). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 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. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# 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. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the 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 output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the 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 -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use <access key> + S -# (what the <access key> is depends on the OS and browser, but it is typically -# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down -# key> to jump into the search results window, the results can be navigated -# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel -# the search. The filter options can be selected when the cursor is inside the -# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> -# to select a filter and <Enter> or <escape> to activate or cancel the filter -# option. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a web server instead of a web client using Javascript. There -# are two flavours of web server based searching depending on the -# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for -# searching and an index file used by the script. When EXTERNAL_SEARCH is -# enabled the indexing and searching needs to be provided by external tools. See -# the section "External Indexing and Searching" for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SERVER_BASED_SEARCH = NO - -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP -# script for searching. Instead the search results are written to an XML file -# which needs to be processed by an external indexer. Doxygen will invoke an -# external search engine pointed to by the SEARCHENGINE_URL option to obtain the -# search results. -# -# Doxygen ships with an example indexer ( doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). -# -# See the section "External Indexing and Searching" for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH = NO - -# The SEARCHENGINE_URL should point to a search engine hosted by a web server -# which will return the search results when EXTERNAL_SEARCH is enabled. -# -# Doxygen ships with an example indexer ( doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and -# Searching" for details. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHENGINE_URL = - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed -# search data is written to a file for indexing by an external tool. With the -# SEARCHDATA_FILE tag the name of this file can be specified. -# The default file is: searchdata.xml. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHDATA_FILE = searchdata.xml - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the -# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is -# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple -# projects and redirect the results back to the right project. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH_ID = - -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen -# projects other than the one defined by this configuration file, but that are -# all added to the same external search index. Each project needs to have a -# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of -# to a relative location where the documentation can be found. The format is: -# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTRA_SEARCH_MAPPINGS = - -#--------------------------------------------------------------------------- -# Configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. -# The default value is: YES. - -GENERATE_LATEX = NO - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: latex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. -# -# Note that when enabling USE_PDFLATEX this option is only used for generating -# bitmaps for formulas in the HTML output, but not in the Makefile that is -# written to the output directory. -# The default file is: latex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate -# index for LaTeX. -# The default file is: makeindex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX -# documents. This may be useful for small projects and may help to save some -# trees in general. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used by the -# printer. -# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x -# 14 inches) and executive (7.25 x 10.5 inches). -# The default value is: a4. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -PAPER_TYPE = a4 - -# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names -# that should be included in the LaTeX output. To get the times font for -# instance you can specify -# EXTRA_PACKAGES=times -# If left blank no extra packages will be included. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the -# generated LaTeX document. The header should contain everything until the first -# chapter. If it is left blank doxygen will generate a standard header. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. -# -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will -# replace them by respectively the title of the page, the current date and time, -# only the current date, the version number of doxygen, the project name (see -# PROJECT_NAME), or the project number (see PROJECT_NUMBER). -# This tag requires that the tag GENERATE_LATEX is set to YES. - -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. -# -# Note: Only use a user-defined footer if you know what you are doing! -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_FOOTER = - -# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the LATEX_OUTPUT output -# directory. Note that the files will be copied as-is; there are no commands or -# markers available. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_EXTRA_FILES = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is -# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will -# contain links (just like the HTML output) instead of page references. This -# makes the output suitable for online browsing using a PDF viewer. -# The default value is: YES. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -PDF_HYPERLINKS = YES - -# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES to get a -# higher quality PDF documentation. -# The default value is: YES. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_BATCHMODE = NO - -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the -# index chapters (such as File Index, Compound Index, etc.) in the output. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_HIDE_INDICES = NO - -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -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. See -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_BIB_STYLE = plain - -#--------------------------------------------------------------------------- -# Configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The -# RTF output is optimized for Word 97 and may not look too pretty with other RTF -# readers/editors. -# The default value is: NO. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: rtf. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF -# documents. This may be useful for small projects and may help to save some -# trees in general. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will -# contain hyperlink fields. The RTF file will contain links (just like the HTML -# output) instead of page references. This makes the output suitable for online -# browsing using Word or some other Word compatible readers that support those -# fields. -# -# Note: WordPad (write) and others do not support links. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's config -# file, i.e. a series of assignments. You only have to provide replacements, -# missing definitions are set to their default value. -# -# See also section "Doxygen usage" for information on how to generate the -# default style sheet that doxygen normally uses. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's config file. A template extensions file can be generated -# using doxygen -e rtf extensionFile. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for -# classes and files. -# The default value is: NO. - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. A directory man3 will be created inside the directory specified by -# MAN_OUTPUT. -# The default directory is: man. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to the generated -# man pages. In case the manual section does not start with a number, the number -# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is -# optional. -# The default value is: .3. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it -# will generate one additional man file for each entity documented in the real -# man page(s). These additional files only source the real man page, but without -# them the man command would be unable to find the correct page. -# The default value is: NO. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that -# captures the structure of the code including all documentation. -# The default value is: NO. - -GENERATE_XML = YES - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: xml. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify a XML DTD, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program -# listings (including syntax highlighting and cross-referencing information) to -# the XML output. Note that enabling this will significantly increase the size -# of the XML output. -# The default value is: YES. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the DOCBOOK output -#--------------------------------------------------------------------------- - -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files -# that can be used to generate PDF. -# The default value is: NO. - -GENERATE_DOCBOOK = NO - -# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in -# front of it. -# The default directory is: docbook. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_OUTPUT = docbook - -#--------------------------------------------------------------------------- -# Configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen -# Definitions (see http://autogen.sf.net) file that captures the structure of -# the code including all documentation. Note that this feature is still -# experimental and incomplete at the moment. -# The default value is: NO. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module -# file that captures the structure of the code including all documentation. -# -# Note that this feature is still experimental and incomplete at the moment. -# The default value is: NO. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary -# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI -# output from the Perl module output. -# The default value is: NO. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely -# formatted so it can be parsed by a human reader. This is useful if you want to -# understand what is going on. On the other hand, if this tag is set to NO the -# size of the Perl module output will be much smaller and Perl will parse it -# just the same. -# The default value is: YES. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file are -# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful -# so different doxyrules.make files included by the same Makefile don't -# overwrite each other's variables. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all -# C-preprocessor directives found in the sources and include files. -# The default value is: YES. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names -# in the source code. If set to NO only conditional compilation will be -# performed. Macro expansion can be done in a controlled way by setting -# EXPAND_ONLY_PREDEF to YES. -# The default value is: NO. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -MACRO_EXPANSION = NO - -# 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 PREDEFINED and -# EXPAND_AS_DEFINED tags. -# The default value is: NO. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES the includes files in the -# INCLUDE_PATH will be searched if a #include is found. -# The default value is: YES. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by the -# preprocessor. -# This tag requires that the tag SEARCH_INCLUDES is set to YES. - -INCLUDE_PATH = - -# 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 -# directories. If left blank, the patterns specified with FILE_PATTERNS will be -# used. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -INCLUDE_FILE_PATTERNS = - -# 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 e.g. -# gcc). The argument of the tag is a list of macros of the form: name or -# name=definition (no spaces). If the definition and the "=" are omitted, "=1" -# is assumed. To prevent a macro definition from being undefined via #undef or -# recursively expanded use the := operator instead of the = operator. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -PREDEFINED = - -# 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. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will -# remove all refrences to function-like macros that are alone on a line, have an -# all uppercase name, and do not end with a semicolon. Such function macros are -# typically used for boiler-plate code, and will confuse the parser if not -# removed. -# The default value is: YES. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES tag can be used to specify one or more tag files. For each tag -# file the location of the external documentation should be added. The format of -# a tag file without this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where loc1 and loc2 can be relative or absolute paths or URLs. See the -# section "Linking to external documentation" for more information about the use -# of tag files. -# Note: Each tag file must have an unique name (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 = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a -# tag file that is based on the input files it reads. See section "Linking to -# external documentation" for more information about the usage of tag files. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the -# class index. If set to NO only the inherited external classes will be listed. -# The default value is: NO. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in -# the modules index. If set to NO, only the current project's groups will be -# listed. -# The default value is: YES. - -EXTERNAL_GROUPS = YES - -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in -# the related pages index. If set to NO, only the current project's pages will -# be listed. -# The default value is: YES. - -EXTERNAL_PAGES = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = NO - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide inheritance -# and usage relations if the target is undocumented or is not a class. -# The default value is: YES. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent -# Bell Labs. The other options in this section have no effect if this option is -# set to NO -# The default value is: NO. - -HAVE_DOT = YES - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed -# to run in parallel. When set to 0 doxygen will base this on the number of -# processors available in the system. You can set it explicitly to a value -# larger than 0 to get control over the balance between CPU load and processing -# speed. -# Minimum value: 0, maximum value: 32, default value: 0. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_NUM_THREADS = 0 - -# When you want a differently looking font n the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTPATH = - -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a -# graph for each documented class showing the direct and indirect implementation -# dependencies (inheritance, containment, and class references variables) of the -# class with other documented classes. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -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 manageable. Set this to 0 -# for no limit. Note that the threshold may be exceeded by 50% before the limit -# is enforced. So when you set the threshold to 10, up to 15 fields may appear, -# but if the number exceeds 15, the total amount of fields shown is limited to -# 10. -# Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -UML_LIMIT_NUM_FIELDS = 10 - -# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and -# collaboration graphs will show the relations between templates and their -# instances. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -TEMPLATE_RELATIONS = NO - -# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to -# YES then doxygen will generate a graph for each documented file showing the -# direct and indirect include dependencies of the file with other documented -# files. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -INCLUDE_GRAPH = YES - -# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are -# set to YES then doxygen will generate a graph for each documented file showing -# the direct and indirect include dependencies of the file with other documented -# files. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -INCLUDED_BY_GRAPH = NO - -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call -# dependency graph for every global function or class method. -# -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -CALL_GRAPH = YES - -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller -# dependency graph for every global function or class method. -# -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -CALLER_GRAPH = YES - -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical -# hierarchy of all classes instead of a textual one. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH tag is 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. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. -# Note: 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). -# Possible values are: png, jpg, gif and svg. -# The default value is: png. -# This tag requires that the tag HAVE_DOT is set to YES. - -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. -# Note: 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. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -INTERACTIVE_SVG = NO - -# The DOT_PATH tag 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. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the \dotfile -# command). -# This tag requires that the tag HAVE_DOT is set to YES. - -DOTFILE_DIRS = - -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the \mscfile -# command). - -MSCFILE_DIRS = - -# The DIAFILE_DIRS tag can be used to specify one or more directories that -# contain dia files that are included in the documentation (see the \diafile -# command). - -DIAFILE_DIRS = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes -# that will be shown in the graph. If the number of nodes in a graph becomes -# larger than this value, doxygen will truncate the graph, which is visualized -# by representing a node as a red box. Note that doxygen if the number of direct -# children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that -# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. -# Minimum value: 0, maximum value: 10000, default value: 50. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs -# generated by dot. A depth value of 3 means that only nodes reachable from the -# root by following a path via at most 3 edges will be shown. Nodes that lay -# further from the root node will be omitted. Note that setting this option to 1 -# or 2 may greatly reduce the computation time needed for large code bases. Also -# note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. -# Minimum value: 0, maximum value: 1000, default value: 0. -# This tag requires that the tag HAVE_DOT is set to YES. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) support -# this, this feature is disabled by default. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page -# explaining the meaning of the various boxes and arrows in the dot generated -# graphs. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot -# files that are used to generate the various graphs. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_CLEANUP = YES diff --git a/peripheral/libupm/doxy/DoxygenLayout.xml b/peripheral/libupm/doxy/DoxygenLayout.xml deleted file mode 100644 index aae647b..0000000 --- a/peripheral/libupm/doxy/DoxygenLayout.xml +++ /dev/null @@ -1,198 +0,0 @@ -<doxygenlayout version="1.0"> - <!-- Generated by doxygen 1.8.7 --> - <!-- Navigation index tabs for HTML output --> - <navindex> - <tab type="mainpage" visible="yes" title=""/> - <tab type="pages" visible="yes" title="" intro=""/> - <tab type="modules" visible="yes" title="UPM Libraries" intro="Here is a - list of UPM libraries that can be used. Note that each of the classes - listed in these libraries are completely separate so you will need to link - against all those that you have used in your program. Use the hierarchical - tree to filter between different types of sensors."/> <tab - type="namespaces" visible="yes" title=""> - <tab type="namespacelist" visible="yes" title="" intro=""/> - <tab type="namespacemembers" visible="yes" title="" intro=""/> - </tab> - <tab type="classes" visible="yes" title=""> - <tab type="classlist" visible="yes" title="" intro=""/> - <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> - <tab type="hierarchy" visible="yes" title="" intro=""/> - <tab type="classmembers" visible="yes" title="" intro=""/> - </tab> - <tab type="files" visible="yes" title=""> - <tab type="filelist" visible="yes" title="" intro=""/> - <tab type="globals" visible="yes" title="" intro=""/> - </tab> - <tab type="examples" visible="yes" title="" intro=""/> - </navindex> - - <!-- Layout definition for a class page --> - <class> - <briefdescription visible="yes"/> - <detaileddescription title=""/> - <includes visible="$SHOW_INCLUDE_FILES"/> - <memberdecl> - <nestedclasses visible="yes" title=""/> - <publictypes title=""/> - <services title=""/> - <interfaces title=""/> - <publicslots title=""/> - <signals title=""/> - <publicmethods title=""/> - <publicstaticmethods title=""/> - <publicattributes title=""/> - <publicstaticattributes title=""/> - <protectedtypes title=""/> - <protectedslots title=""/> - <protectedmethods title=""/> - <protectedstaticmethods title=""/> - <protectedattributes title=""/> - <protectedstaticattributes title=""/> - <packagetypes title=""/> - <packagemethods title=""/> - <packagestaticmethods title=""/> - <packageattributes title=""/> - <packagestaticattributes title=""/> - <properties title=""/> - <events title=""/> - <privatetypes title=""/> - <privateslots title=""/> - <privatemethods title=""/> - <privatestaticmethods title=""/> - <privateattributes title=""/> - <privatestaticattributes title=""/> - <friends title=""/> - <related title="" subtitle=""/> - <membergroups visible="yes"/> - </memberdecl> - <memberdef> - <inlineclasses title=""/> - <typedefs title=""/> - <enums title=""/> - <services title=""/> - <interfaces title=""/> - <constructors title=""/> - <functions title=""/> - <related title=""/> - <variables title=""/> - <properties title=""/> - <events title=""/> - </memberdef> - <allmemberslink visible="yes"/> - <inheritancegraph visible="$CLASS_GRAPH"/> - <collaborationgraph visible="$COLLABORATION_GRAPH"/> - <usedfiles visible="$SHOW_USED_FILES"/> - <authorsection visible="yes"/> - </class> - - <!-- Layout definition for a namespace page --> - <namespace> - <briefdescription visible="yes"/> - <memberdecl> - <nestednamespaces visible="yes" title=""/> - <constantgroups visible="yes" title=""/> - <classes visible="yes" title=""/> - <typedefs title=""/> - <enums title=""/> - <functions title=""/> - <variables title=""/> - <membergroups visible="yes"/> - </memberdecl> - <detaileddescription title=""/> - <memberdef> - <inlineclasses title=""/> - <typedefs title=""/> - <enums title=""/> - <functions title=""/> - <variables title=""/> - </memberdef> - <authorsection visible="yes"/> - </namespace> - - <!-- Layout definition for a file page --> - <file> - <briefdescription visible="no"/> - <includegraph visible="$INCLUDE_GRAPH"/> - <includes visible="$SHOW_INCLUDE_FILES"/> - <detaileddescription title="API Description"/> - <sourcelink visible="yes"/> - <memberdecl> - <classes visible="yes" title=""/> - <namespaces visible="yes" title=""/> - <functions title=""/> - <constantgroups visible="yes" title=""/> - <defines title=""/> - <typedefs title=""/> - <enums title=""/> - <variables title=""/> - <membergroups visible="yes"/> - </memberdecl> - <memberdef> - <inlineclasses title=""/> - <functions title=""/> - <defines title=""/> - <typedefs title=""/> - <enums title=""/> - <variables title=""/> - </memberdef> - <includedbygraph visible="$INCLUDED_BY_GRAPH"/> - <authorsection/> - </file> - - <!-- Layout definition for a group page --> - <group> - <briefdescription visible="yes"/> - <memberdecl> - <nestedgroups visible="yes" title="Libraries"/> - <dirs visible="yes" title=""/> - <files visible="yes" title=""/> - <namespaces visible="yes" title=""/> - <classes visible="yes" title=""/> - <defines title=""/> - <typedefs title=""/> - <enums title=""/> - <enumvalues title=""/> - <functions title=""/> - <variables title=""/> - <signals title=""/> - <publicslots title=""/> - <protectedslots title=""/> - <privateslots title=""/> - <events title=""/> - <properties title=""/> - <friends title=""/> - <membergroups visible="yes"/> - </memberdecl> - <detaileddescription title=""/> - <memberdef> - <pagedocs/> - <inlineclasses title=""/> - <defines title=""/> - <typedefs title=""/> - <enums title=""/> - <enumvalues title=""/> - <functions title=""/> - <variables title=""/> - <signals title=""/> - <publicslots title=""/> - <protectedslots title=""/> - <privateslots title=""/> - <events title=""/> - <properties title=""/> - <friends title=""/> - </memberdef> - <groupgraph visible="$GROUP_GRAPHS"/> - <authorsection visible="yes"/> - </group> - - <!-- Layout definition for a directory page --> - <directory> - <briefdescription visible="yes"/> - <directorygraph visible="yes"/> - <memberdecl> - <dirs visible="yes"/> - <files visible="yes"/> - </memberdecl> - <detaileddescription title=""/> - </directory> -</doxygenlayout> diff --git a/peripheral/libupm/doxy/README.cpp.md b/peripheral/libupm/doxy/README.cpp.md deleted file mode 100644 index 7bbb9f3..0000000 --- a/peripheral/libupm/doxy/README.cpp.md +++ /dev/null @@ -1,82 +0,0 @@ -UPM (Useful Packages & Modules) Sensor/Actuator repository for MRAA -============== - -UPM is a high level repository for sensors that use MRAA. Each sensor links -to MRAA and are not meant to be interlinked although some groups of sensors -may be. Each sensor contains a header which allows to interface with it. -Typically a sensor is represented as a class and instantiated. - -The constructor is expected to initialise the sensor and parameters may be used -to provide identification/pin location on the board. - -Typically an update() function will be called in order to get new data from the -sensor in order to reduce load when doing multiple reads to sensor data. - -### Example - -A sensor/actuator is expected to work as such (here is the servo ES08A API): -@snippet es08a.cxx Interesting - -However implementation and API design is completely up to the developer, some -enumerable sensors for example may provide much clever instantiation. Displays -may also create more complex structures in order to interface with them. - -Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples/c%2B%2B). - -Multi-sensor samples for the starter and specialized kits can be found in the -[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository. - -### Supported Sensors - -Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation. - -You can also refer to the [Intel IoT Developer Zone](https://software.intel.com/iot/sensors). - -### IDE Compatibility - -If you would like to create Eclipse IDE projects using the UPM C++ samples, -please follow the instructions provided on the Intel Developer Zone IDE page. - -@htmlonly -<a href="https://software.intel.com/iot/software/ide"><img src="docs/icons/eclipse.png"/></a> -@endhtmlonly - -### Building UPM - -See @ref building here. - -### Making your own UPM module - -@ref porting link has more information on making new UPM modules. - -There is also an example available for @ref max31855 sensor. - -### Naming conventions and rules for new UPM contributions - -Before you begin development, take a look at our @ref naming conventions. - -Also, please read the guidelines for @ref contributions to UPM. - -Don't forget to check the @ref documentation section. - -Make sure you add yourself as an author on every new code file submitted. -If you are providing a fix with significant changes, feel free to add yourself -as a contributor. Signing-off your commits is mandatory. - -API Documentation -============== - -@htmlonly - -<a href="http://iotdk.intel.com/docs/master/upm"><img src="docs/icons/c++.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/java"><img src="docs/icons/java.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="docs/icons/python.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="docs/icons/node.png"/></a> - -@endhtmlonly - -### Changelog -Version @ref changelog here. - -### Known Limitations -List of @ref knownlimitations here. diff --git a/peripheral/libupm/doxy/README.java.md b/peripheral/libupm/doxy/README.java.md deleted file mode 100644 index f6f59e3..0000000 --- a/peripheral/libupm/doxy/README.java.md +++ /dev/null @@ -1,81 +0,0 @@ -UPM (Useful Packages & Modules) Sensor/Actuator repository for MRAA - -UPM is a high level repository for sensors that use MRAA. Each sensor links -to MRAA and are not meant to be interlinked although some groups of sensors -may be. Each sensor contains a header which allows to interface with it. -Typically a sensor is represented as a class and instantiated. - -The constructor is expected to initialise the sensor and parameters may be used -to provide identification/pin location on the board. - -Typically an update() function will be called in order to get new data from the -sensor in order to reduce load when doing multiple reads to sensor data. - -### Example - -A sensor/actuator is expected to work as such (here is the servo ES08A API): -@snippet ES08ASample.java Interesting - -However implementation and API design is completely up to the developer, some -enumerable sensors for example may provide much clever instantiation. Displays -may also create more complex structures in order to interface with them. - -Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples/java). - -Multi-sensor samples for the starter and specialized kits can be found in the -[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository. - -### Supported Sensors - -Supported [sensor list](http://iotdk.intel.com/docs/master/upm/java/modules.html) from API documentation. - -You can also refer to the [Intel® IoT Developer Zone](https://software.intel.com/iot/sensors). - -### IDE Compatibility - -If you would like to create Eclipse IDE projects using the UPM Java samples, -please follow the instructions provided on the Intel Developer Zone IDE page. - -@htmlonly -<a href="https://software.intel.com/iot/software/ide"><img src="../docs/icons/eclipse.png"/></a> -@endhtmlonly - -### Building UPM - -See @ref building here. - -### Making your own UPM module - -@ref porting link has more information on making new UPM modules. - -There is also an example available for @ref max31855 sensor. - -### Naming conventions and rules for new UPM contributions - -Before you begin development, take a look at our @ref naming conventions. - -Also, please read the guidelines for @ref contributions to UPM. - -Don't forget to check the @ref documentation section. - -Make sure you add yourself as an author on every new code file submitted. -If you are providing a fix with significant changes, feel free to add yourself -as a contributor. Signing-off your commits is mandatory. - -API Documentation -============== - -@htmlonly - -<a href="http://iotdk.intel.com/docs/master/upm"><img src="../docs/icons/c++.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/java"><img src="../docs/icons/java.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="../docs/icons/python.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="../docs/icons/node.png"/></a> - -@endhtmlonly - -### Changelog -Version @ref changelog here. - -### Known Limitations -List of @ref knownlimitations here. diff --git a/peripheral/libupm/doxy/conf.py.in b/peripheral/libupm/doxy/conf.py.in deleted file mode 100644 index fac8930..0000000 --- a/peripheral/libupm/doxy/conf.py.in +++ /dev/null @@ -1,352 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# . documentation build configuration file, created by -# sphinx-quickstart on Thu May 1 18:34:23 2014. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, "@CMAKE_CURRENT_BINARY_DIR@/pyupm/") -sys.path.insert(0, "@MRAA_LIBDIR@@LIB_SUFFIX@") - -# -- General configuration ------------------------------------------------ - -# Custom flags and filters if needed -# autodoc_default_flags = ['members', 'private-members', 'special-members', 'undoc-members', 'show-inheritance'] - -# def autodoc_skip_member(app, what, name, obj, skip, options): - # exclusions = ('__weakref__', # special-members - # '__doc__', '__module__', '__dict__', # undoc-members - # 'swig_import_helper' - # ) - # exclude = name in exclusions - # return skip or exclude - -# def setup(app): - # app.connect('autodoc-skip-member', autodoc_skip_member) - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.todo', - 'sphinx.ext.viewcode', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'upm' -copyright = '2015, Intel Corporation' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '@upm_VERSION_STRING@' -# The full version, including alpha/beta/rc tags. -release = '@VERSION@' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build', '**/.git', '**/CMakeFiles/**', '**/CMakeLists.txt'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' -#html_theme = '@SPHINX_THEME@' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = ['@SPHINX_THEME_DIR@'] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'upmdoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'sphinx.tex', '. Documentation', - 'Author', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'sphinx', '. Documentation', - ['Author'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'sphinx', '. Documentation', - 'Author', 'sphinx', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - - -# -- Options for Epub output ---------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = '.' -epub_author = 'UPM' -epub_publisher = 'UPM' -epub_copyright = '2015, Intel Corporation' - -# The basename for the epub file. It defaults to the project name. -#epub_basename = '.' - -# The HTML theme for the epub output. Since the default themes are not optimized -# for small screen space, using the same theme for HTML and epub output is -# usually not wise. This defaults to 'epub', a theme designed to save visual -# space. -#epub_theme = 'epub' - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () - -# A sequence of (type, uri, title) tuples for the guide element of content.opf. -#epub_guide = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True - -# Choose between 'default' and 'includehidden'. -#epub_tocscope = 'default' - -# Fix unsupported image types using the PIL. -#epub_fix_images = False - -# Scale large images. -#epub_max_image_width = 0 - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#epub_show_urls = 'inline' - -# If false, no index is generated. -#epub_use_index = True diff --git a/peripheral/libupm/doxy/index.rst b/peripheral/libupm/doxy/index.rst deleted file mode 100644 index cd91bae..0000000 --- a/peripheral/libupm/doxy/index.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. UPM Python documentation master file, created by Sisinty Sasmita Patra - UPM Team on Thu May 14 15:58:46 2015. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -**Welcome to UPM Python Documentation!** -========================================= - -.. include:: ../../README.md - :start-after: ============== - :end-before: ### Example - -``Building UPM`` -################ - -For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_. - -``Examples`` -############ - -Multi-sensor samples for the starter and specialized kits can be found in the `iot-devkit-samples <https://github.com/intel-iot-devkit/iot-devkit-samples>`_ -repository. - -Individual sensor usage examples for Python are available `here <https://github.com/intel-iot-devkit/upm/tree/master/examples/python>`_. - -``IDE Compatibility`` -################ - -While there is no official IDE provided with our Python libraries, we do recommend the web-based IDE Wyliodrin. It can be used with multiple programming -languages, including Python. More information can be found on the Intel Developer Zone IDE page. - -.. image:: ../docs/icons/wyliodrin.png - :target: https://software.intel.com/iot/software/ide - -``Making your own UPM Module`` -############################## - -This `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md>`_ has more information on making a new UPM module. - -There is also an example available for max31855 `sensor <https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md>`_. - -``Naming Conventions and Rules for New UPM Contributions`` -########################################################## - -Before you begin development, please take a look at our naming `conventions <https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md>`_. - -Also, please read the guidelines for contributions to `UPM <https://github.com/intel-iot-devkit/upm/blob/master/docs/contributions.md>`_. - -Don't forget to check the documentation `section <https://github.com/intel-iot-devkit/upm/blob/master/docs/documentation.md>`_. - -.. note:: - - * Make sure you add yourself as an author on every new code file submitted. - * If you are providing a fix with significant changes, feel free to add yourself as a contributor. - * Signing-off your commits is mandatory. - -``List of Available Sensors Drivers`` -###################################### - -Click on the library prefix below to expand the full list of sensors: - -.. toctree:: - :maxdepth: 1 - - modules - -``Other API Documentation`` -########################### - -.. image:: ../docs/icons/c++.png - :target: http://iotdk.intel.com/docs/master/upm -.. image:: ../docs/icons/java.png - :target: http://iotdk.intel.com/docs/master/upm/java -.. image:: ../docs/icons/python.png - :target: http://iotdk.intel.com/docs/master/upm/python -.. image:: ../docs/icons/node.png - :target: http://iotdk.intel.com/docs/master/upm/node - -``Version Changelog`` -##################### - -For our Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_. - -``Known Limitations`` -################################### - -For the List of Known Limitations, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md>`_. - -``Indices and tables`` -###################### - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/peripheral/libupm/doxy/node/docgen.js b/peripheral/libupm/doxy/node/docgen.js deleted file mode 100644 index 305cec3..0000000 --- a/peripheral/libupm/doxy/node/docgen.js +++ /dev/null @@ -1,59 +0,0 @@ -/* - * Author: Heidi Pan <heidi.pan@intel.com> - * Copyright (c) 2015 Intel Corporation. - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be - * included in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -// dependencies -var xml2js = require('./xml2js') - , fs = require('fs') - , Promise = require('bluebird') - , opts = require('commander') - , _ = require('lodash') - , mkdirp = require('mkdirp'); - - -// parse command line arguments -_.extend(opts, { addOptions: function(module) { return module.addOptions(opts); } }); -opts - .option('-m, --module [module]', 'module name for which to build documentation', 'mraa') - .option('-f, --formats [formats]', 'format for js comments', 'yuidoc,ternjs') - .option('-o, --outdir [directory]', 'top directory to build documentation', __dirname + '/jsdoc') - .addOptions(xml2js) - .parse(process.argv); - - -// use promise-style programming rather than spaghetti callbacks -Promise.promisifyAll(fs); -Promise.promisifyAll(mkdirp); - - -// main -xml2js.parse().then(function(specjs) { - var formats = opts.formats.split(','); - Promise.all(_.map(formats, function(format) { - var generateDocs = require(__dirname + '/generators/' + format + '/generator'); - var dir = opts.outdir + '/' + format + '/' + specjs.MODULE; - return mkdirp.mkdirpAsync(dir).then(function() { - return fs.writeFileAsync(dir + '/doc.js', generateDocs(specjs)); - }); - })); -}); diff --git a/peripheral/libupm/doxy/node/generators/jsdoc/conf.json b/peripheral/libupm/doxy/node/generators/jsdoc/conf.json deleted file mode 100644 index a2f37cc..0000000 --- a/peripheral/libupm/doxy/node/generators/jsdoc/conf.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "templates": { - "default": { - "outputSourceFiles": false - } - } -}
\ No newline at end of file diff --git a/peripheral/libupm/doxy/node/generators/jsdoc/generator.js b/peripheral/libupm/doxy/node/generators/jsdoc/generator.js deleted file mode 100644 index 6dd3d7d..0000000 --- a/peripheral/libupm/doxy/node/generators/jsdoc/generator.js +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Author: Heidi Pan <heidi.pan@intel.com> - * Copyright (c) 2015 Intel Corporation. - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be - * included in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -// dependencies -var _ = require('lodash'); - - -// generate JSDoc-style documentation -function generateDocs(specjs) { - var docs = GENERATE_MODULE(specjs.MODULE); - docs = _.reduce(specjs.METHODS, function(memo, methodSpec, methodName) { - return memo += GENERATE_METHOD(methodName, methodSpec); - }, docs); - docs = _.reduce(specjs.ENUMS, function(memo, enumSpec, enumName) { - return memo += GENERATE_ENUM(enumName, enumSpec); - }, docs); - docs = _.reduce(specjs.CLASSES, function(memo, classSpec, parentClass) { - return _.reduce(classSpec.methods, function(memo, methodSpec, methodName) { - return memo += GENERATE_METHOD(methodName, methodSpec, parentClass); - }, memo); - }, docs); - return docs; -} - - -// comment wrapper around entire spec -function GENERATE_DOC(text) { - return '/**\n' + text + ' */\n'; -} - - -// generate module spec -function GENERATE_MODULE(module) { - return GENERATE_DOC('@module ' + module + '\n'); -} - - -// generate method spec with parent module/class -function GENERATE_METHOD(name, spec, parent) { - name = name.replace(/!+$/, ''); - return GENERATE_DOC(spec.description + '\n' - + '@method ' + name + '\n' - + '@instance\n' - + (parent ? ('@memberof ' + parent + '\n') : '') - + _.reduce(spec.params, function(memo, paramSpec, paramName) { - return '@param {' + paramSpec.type + '} ' + paramName + ' ' + paramSpec.description + '\n'; - }, '') - + ( !_.isEmpty(spec.return) ? ('@return {' + spec.return.type + '} ' + spec.return.description + '\n') : '')); -} - - -// generate enum spec -function GENERATE_ENUM(name, spec) { - return GENERATE_DOC(spec.description + '\n\n' - + '@var ' + name + '\n' - + '@type Enum(' + spec.type + ')\n' - + '@instance\n'); -} - - -// TODO -// generate link spec -function GENERATE_LINK(text) { - return '{@link ' + text + '}'; -} - - -module.exports = generateDocs; diff --git a/peripheral/libupm/doxy/node/generators/ternjs/generator.js b/peripheral/libupm/doxy/node/generators/ternjs/generator.js deleted file mode 100644 index 2378fe1..0000000 --- a/peripheral/libupm/doxy/node/generators/ternjs/generator.js +++ /dev/null @@ -1,132 +0,0 @@ -/* - * Author: Heidi Pan <heidi.pan@intel.com> - * Copyright (c) 2015 Intel Corporation. - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be - * included in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -// dependencies -var _ = require('lodash'); - - -// generate json for ternjs input -function generateDocs(specjs) { - GENERATE_TYPE = (function(enums) { - return function(type) { - return (_.contains(enums, type) ? ('Enum ' + type) : type); - } - })(_.keys(specjs.ENUMS_BY_GROUP)); - var docs = { '!name': specjs.MODULE + 'library' }; - _.extend(docs, GENERATE_MODULE(specjs.MODULE)); - _.each(specjs.ENUMS, function(enumSpec, enumName) { - _.extend(docs[specjs.MODULE], GENERATE_ENUM(enumName, enumSpec)); - }); - _.each(specjs.METHODS, function(methodSpec, methodName) { - _.extend(docs[specjs.MODULE], GENERATE_METHOD(methodName, methodSpec)); - }); - - if (_.isEmpty(specjs.CLASSGROUPS)) { - _.extend(docs[specjs.MODULE], GENERATE_CLASSES(specjs.CLASSES)); - } else { - var grouped = _.flatten(_.pluck(_.values(specjs.CLASSGROUPS), 'classes')); - var ungrouped = _.difference(_.keys(specjs.CLASSES), grouped); - _.extend(docs[specjs.MODULE], GENERATE_CLASSES(_.pick(specjs.CLASSES, ungrouped))); - _.each(specjs.CLASSGROUPS, function(groupSpec, groupName) { - _.extend(docs, GENERATE_MODULE(groupName)); - _.extend(docs[groupName], GENERATE_CLASSES(_.pick(specjs.CLASSES, groupSpec.classes), groupName)); - }); - } - return JSON.stringify(docs, null, 2); -} - - -// generate module spec -function GENERATE_MODULE(module) { - var docs = {}; - docs[module] = {}; - return docs; -} - - -// generate the spec for the given list of classes -function GENERATE_CLASSES(classes) { - var docs = {}; - _.each(classes, function(classSpec, parentClass) { - var constructor = classSpec.methods[parentClass]; - _.extend(docs, GENERATE_METHOD(parentClass, constructor ? constructor : { params: {}, return: {}, description: '' } )); - if (_.has(docs, parentClass)) { - _.each(classSpec.enums, function(enumSpec, enumName) { - _.extend(docs[parentClass], GENERATE_ENUM(enumName, enumSpec)); - }); - docs[parentClass].prototype = {}; - _.each(_.omit(classSpec.methods, parentClass), function(methodSpec, methodName) { - _.extend(docs[parentClass].prototype, GENERATE_METHOD(methodName, methodSpec)); - }); - _.each(classSpec.variables, function(variableSpec, variableName) { - _.extend(docs[parentClass].prototype, GENERATE_VARIABLE(variableName, variableSpec)); - }); - } - }); - return docs; -} - - -// generate method spec -function GENERATE_METHOD(name, spec) { - var doc = {}; - doc[name] = { - '!type': 'fn(' + GENERATE_PARAMS(spec.params) + ')' + GENERATE_RETURN(spec.return), - '!doc': spec.description - } - return doc; -} - - -// generate parameter signatures for method -function GENERATE_PARAMS(spec) { - return _.map(spec, function(paramSpec, paramName) { - return paramName + ': ' + paramSpec.type; - }).join(', '); -} - - -// generate return signature for method -function GENERATE_RETURN(spec) { - return (_.isEmpty(spec) ? '' : (' -> ' + spec.type)); -} - - -// generate enum spec -function GENERATE_ENUM(name, spec) { - var doc = {}; - doc[name] = 'Enum ' + spec.type ; - return doc; -} - - -// generate variable spec -function GENERATE_VARIABLE(name, spec) { - var doc = {}; - doc[name]= spec.type ; - return doc; -} - - -module.exports = generateDocs; diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/conf.json b/peripheral/libupm/doxy/node/generators/yuidoc/conf.json deleted file mode 100644 index 002d0ab..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/conf.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "name": "UPM", - "description": "The UPM API: High Level Sensor Library for Intel IoT Devices Using MRAA", - "logo": "http://upload.wikimedia.org/wikipedia/commons/8/8c/Transparent.png", - "options": { - "outdir": "./html/node" - } -}
\ No newline at end of file diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/generator.js b/peripheral/libupm/doxy/node/generators/yuidoc/generator.js deleted file mode 100644 index fb5fe2a..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/generator.js +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Author: Heidi Pan <heidi.pan@intel.com> - * Copyright (c) 2015 Intel Corporation. - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be - * included in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -// dependencies -var _ = require('lodash'); - - -// generate YuiDocs-style documentation -function generateDocs(specjs) { - var docs = GENERATE_MODULE(specjs.MODULE, ''); - GENERATE_TYPE = (function(enums) { - return function(type) { - return (_.contains(enums, type) ? ('Enum ' + type) : type); - } - })(_.keys(specjs.ENUMS_BY_GROUP)); - docs = _.reduce(specjs.METHODS, function(memo, methodSpec, methodName) { - return memo += GENERATE_METHOD(methodName, methodSpec); - }, docs); - docs = _.reduce(specjs.ENUMS, function(memo, enumSpec, enumName) { - return memo += GENERATE_ENUM(enumName, enumSpec); - }, docs); - if (_.isEmpty(specjs.CLASSGROUPS)) { - docs += GENERATE_CLASSES(specjs.CLASSES); - } else { - docs += GENERATE_MODULE('common', ''); - var grouped = _.flatten(_.pluck(_.values(specjs.CLASSGROUPS), 'classes')); - var ungrouped = _.difference(_.keys(specjs.CLASSES), grouped); - docs += GENERATE_CLASSES(_.pick(specjs.CLASSES, ungrouped), 'common'); - _.each(specjs.CLASSGROUPS, function(groupSpec, groupName) { - docs += GENERATE_CLASSES(_.pick(specjs.CLASSES, groupSpec.classes), groupName); - }); - // TODO: figure out why yuidoc won't associate the class with the right module if module definitions are interspersed - _.each(specjs.CLASSGROUPS, function(groupSpec, groupName) { - docs += GENERATE_MODULE(groupName, groupSpec.description); - }); - } - return docs; -} - - -// comment wrapper around entire spec -function GENERATE_DOC(text) { - return '/**\n' + text + ' */\n'; -} - - -// generate module spec -function GENERATE_MODULE(name, description) { - return GENERATE_DOC(description + '\n' - + '@module ' + name + '\n'); -} - - -// generate spec for the given list of classes -function GENERATE_CLASSES(classes, parent) { - return _.reduce(classes, function(memo, classSpec, className) { - return memo - + GENERATE_CLASS(className, classSpec.description, parent, classSpec.parent) - + _.reduce(classSpec.methods, function(memo, methodSpec, methodName) { - return memo += GENERATE_METHOD(methodName, methodSpec, className); - }, '') - + _.reduce(classSpec.variables, function(memo, variableSpec, variableName) { - return memo += GENERATE_VAR(variableName, variableSpec, className); - }, '') - + _.reduce(classSpec.enums, function(memo, enumSpec, enumName) { - return memo += GENERATE_ENUM(enumName, enumSpec, className); - }, ''); - }, ''); -} - - -// generate class spec -function GENERATE_CLASS(name, description, namespace, parent) { - return GENERATE_DOC(description + '\n' - + '@class ' + name + '\n' - + (namespace ? ('@module ' + namespace + '\n') : '') - /* - TODO: leave out until figure out what swig does with inheritance - + (parent ? ('@extends ' + parent + '\n') : '') - */ - ); -} - - -// generate method spec with parent module/class -function GENERATE_METHOD(name, spec, parent) { - name = name.replace(/!+$/, ''); - return GENERATE_DOC(spec.description + '\n' - + '@method ' + name + '\n' - + (parent ? ('@for ' + parent + '\n') : '@for common\n') - + _.reduce(spec.params, function(memo, paramSpec, paramName) { - return memo + '@param {' + GENERATE_TYPE(paramSpec.type) + '} ' + paramName + ' ' + paramSpec.description + '\n'; - }, '') - + ( !_.isEmpty(spec.return) ? ('@return {' + GENERATE_TYPE(spec.return.type) + '} ' + spec.return.description + '\n') : '')); -} - - -// generate enum spec -function GENERATE_ENUM(name, spec, parent) { - return GENERATE_DOC(spec.description + '\n' - + '@property ' + name + '\n' - + '@type Enum ' + spec.type + '\n' - + '@for ' + (parent ? parent : 'common') + '\n'); -} - - -// generate variable specs -function GENERATE_VAR(name, spec, parent) { - return GENERATE_DOC(spec.description + '\n' - + '@property ' + name + '\n' - + '@type ' + spec.type + '\n' - + '@for ' + parent + '\n'); -} - - -// TODO -// generate link spec -function GENERATE_LINK(text) { - return '{{#crossLink "' + text + '"}}{{/crossLink}}'; -} - - -module.exports = generateDocs;
\ No newline at end of file diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/helper.js b/peripheral/libupm/doxy/node/generators/yuidoc/helper.js deleted file mode 100644 index cdedaaf..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/helper.js +++ /dev/null @@ -1,194 +0,0 @@ -/* - * Author: Heidi Pan <heidi.pan@intel.com> - * Copyright (c) 2015 Intel Corporation. - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be - * included in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - - -// extract the field from the class description text -function getField(classDescription, field) { - var pattern = new RegExp('\\+ __' + field + ':__ [A-Za-z0-9]*'); - var label = new RegExp('\\+ __' + field + ':__'); - if (classDescription) { - var matched = classDescription.match(pattern); - if (matched) { - return (matched[0].replace(label, '')).trim(); - } - } - return 'other'; -} - - -// generate html to group modules by the given field (e.g. category/connection type) of its children classes -function listByGroup(modules, classes, field, projectRoot) { - - var moduleClasses = {}; - var modulesByGroup = {}; - var i, j; - for (i = 0; i < modules.length; i++) { - moduleClasses[modules[i].name] = []; - } - for (i = 0; i < classes.length; i++) { - moduleClasses[classes[i].module].push(i); - } - for (var module in moduleClasses) { - var classIndices = moduleClasses[module]; - var groups = []; - for (i = 0; i < classIndices.length; i++) { - groups.push(getField(classes[classIndices[i]].description, field)); - } - if (groups.length != 0) { - var group = groups[0]; - var sanitychecked = true; - for (i = 1; i < groups.length; i++) { - if (groups[i] != group) { - sanitychecked = false; - break; - } - } - if (!sanitychecked) { - // TODO - } - if (group in modulesByGroup) { - modulesByGroup[group].push(module); - } else { - modulesByGroup[group] = [module]; - } - } - } - var groups = Object.keys(modulesByGroup).sort(); - var html = ''; - var pfx = projectRoot + 'modules/'; - for (i = 0; i < groups.length; i++) { - var group = groups[i]; - html += '<div class="upmGroup"><div class="right-arrow"></div>' + group + '</div><span class="upmModules" style="display:none">'; - var moduleNames = modulesByGroup[group]; - for (j = 0; j < moduleNames.length; j++) { - var moduleName = moduleNames[j]; - html += '<a href="' + pfx + moduleName + '.html">' + moduleName + '</a>'; - } - html += '</span>'; - } - return html; -} - - -// click handler to change direction of arrow and toggle visibility of grouped modules -var onClickHandler = "Y.on('domready', function() { \ - Y.on('click', function(e) { \ - var classes = this.next('.upmModules').toggleView(); \ - if (classes.getStyle('display') == 'none') { \ - this.one('> div').removeClass('down-arrow').addClass('right-arrow'); \ - } else { \ - this.one('> div').removeClass('right-arrow').addClass('down-arrow'); \ - } \ - }, '.upmGroup'); \ -});"; - - -// css to generate triangle icons -var insertStyles = "Y.one(document.head).append('<style> \ - div.right-arrow { \ - width: 0; \ - height: 0; \ - border-bottom: 5px solid transparent; \ - border-top: 5px solid transparent; \ - border-left: 5px solid #356de4; \ - font-size: 0; \ - margin-right: 5px; \ - vertical-align: 5px; \ - float: left; \ - } \ - div.down-arrow { \ - width: 0; \ - height: 0; \ - border-left: 5px solid transparent; \ - border-right: 5px solid transparent; \ - border-top: 5px solid #356de4; \ - font-size: 0; \ - margin-right: 5px; \ - float: left; \ - } \ - div.upmGroup { \ - font-weight: bold; \ - } \ -</style>');"; - - -var scripts = "YUI().use('node', 'event', function (Y) {" - + onClickHandler -// + insertStyles - + "});"; - - -module.exports = { - - listByCategory: function() { - return listByGroup(this.modules, this.classes, 'Category', this.projectRoot); - }, - - listByManufacturer: function() { - return listByGroup(this.modules, this.classes, 'Manufacturer', this.projectRoot); - }, - - listByConnection: function() { - return listByGroup(this.modules, this.classes, 'Connection', this.projectRoot); - }, - - javascripts: function(options) { - return '<script type="text/javascript">' + scripts + '</script>'; - }, - - // generate custom cross links - // assume lowercase script will be run, so generate class links with lower case - customCrossLinks: function() { - var selector = 'script[type="class-metadata"]' - var html = "<script type='text/javascript'> \ - var find = function(ar, elem) { \ - for (var i = 0; i < ar.length; i++) { \ - if (ar[i] == elem) { \ - return true; \ - } \ - } \ - return false; \ - }; \ - YUI().use('node', 'event', function (Y) { \ - Y.on('domready', function() { \ - var classes = Y.all('" + selector + "').getHTML(); \ - for (var i = 0; i < classes.length; i++) { \ - classes[i] = classes[i].toLowerCase(); \ - } \ - Y.all('span.type').each(function(node) { \ - var t = node.getHTML(); \ - if (find(classes, t.toLowerCase())) { \ - node.setHTML('<a href=' + t.toLowerCase() + '.html>' + t + '</a>'); \ - } \ - }); \ - }); \ - }); \ - </script>"; - for (var i = 0; i < this.classes.length; i++) { - html += "<script type='class-metadata'>" + this.classes[i].name + "</script>"; - } - return html; - } - -};
\ No newline at end of file diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/LICENSE b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/LICENSE deleted file mode 100644 index 841cfb7..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/LICENSE +++ /dev/null @@ -1,27 +0,0 @@ -Original Work Copyright 2011 Yahoo! Inc. -All rights reserved. - -Modified Work Copyright (c) 2015 Intel Corporation. -Author: Heidi Pan <heidi.pan@intel.com> - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: -* Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. -* 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. -* Neither the name of the Yahoo! Inc. nor the - names of its contributors may be used to endorse or promote products - derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 YAHOO! INC. 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/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/assets/css/main.css b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/assets/css/main.css deleted file mode 100644 index 911f751..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/assets/css/main.css +++ /dev/null @@ -1,814 +0,0 @@ -/* -Font sizes for all selectors other than the body are given in percentages, -with 100% equal to 13px. To calculate a font size percentage, multiply the -desired size in pixels by 7.6923076923. - -Here's a quick lookup table: - -10px - 76.923% -11px - 84.615% -12px - 92.308% -13px - 100% -14px - 107.692% -15px - 115.385% -16px - 123.077% -17px - 130.769% -18px - 138.462% -19px - 146.154% -20px - 153.846% -*/ - -html { - background: #fff; - color: #333; - overflow-y: scroll; -} - -body { - /*font: 13px/1.4 'Lucida Grande', 'Lucida Sans Unicode', 'DejaVu Sans', 'Bitstream Vera Sans', 'Helvetica', 'Arial', sans-serif;*/ - font: 13px/1.4 'Helvetica', 'Arial', sans-serif; - margin: 0; - padding: 0; -} - -/* -- Links ----------------------------------------------------------------- */ -a { - color: #356de4; - text-decoration: none; -} - -.hidden { - display: none; -} - -a:hover { text-decoration: underline; } - -/* "Jump to Table of Contents" link is shown to assistive tools, but hidden from - sight until it's focused. */ -.jump { - position: absolute; - padding: 3px 6px; - left: -99999px; - top: 0; -} - -.jump:focus { left: 40%; } - -/* -- Paragraphs ------------------------------------------------------------ */ -p { margin: 1.3em 0; } -dd p, td p { margin-bottom: 0; } -dd p:first-child, td p:first-child { margin-top: 0; } - -/* -- Headings -------------------------------------------------------------- */ -h1, h2, h3, h4, h5, h6 { - color: #D98527;/*was #f80*/ - font-family: 'Trebuchet MS', sans-serif; - font-weight: bold; - line-height: 1.1; - margin: 1.1em 0 0.5em; -} - -h1 { - font-size: 184.6%; - color: #30418C; - margin: 0.75em 0 0.5em; -} - -h2 { - font-size: 153.846%; - color: #E48A2B; -} - -h3 { font-size: 138.462%; } - -h4 { - border-bottom: 1px solid #DBDFEA; - color: #E48A2B; - font-size: 115.385%; - font-weight: normal; - padding-bottom: 2px; -} - -h5, h6 { font-size: 107.692%; } - -/* -- Code and examples ----------------------------------------------------- */ -code, kbd, pre, samp { - font-family: Menlo, Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Courier New', Courier, monospace; - font-size: 92.308%; - line-height: 1.35; -} - -p code, p kbd, p samp, li code { - background: #FCFBFA; - border: 1px solid #EFEEED; - padding: 0 3px; -} - -a code, a kbd, a samp, -pre code, pre kbd, pre samp, -table code, table kbd, table samp, -.intro code, .intro kbd, .intro samp, -.toc code, .toc kbd, .toc samp { - background: none; - border: none; - padding: 0; -} - -pre.code, pre.terminal, pre.cmd { - overflow-x: auto; - *overflow-x: scroll; - padding: 0.3em 0.6em; -} - -pre.code { - background: #FCFBFA; - border: 1px solid #EFEEED; - border-left-width: 5px; -} - -pre.terminal, pre.cmd { - background: #F0EFFC; - border: 1px solid #D0CBFB; - border-left: 5px solid #D0CBFB; -} - -/* Don't reduce the font size of <code>/<kbd>/<samp> elements inside <pre> - blocks. */ -pre code, pre kbd, pre samp { font-size: 100%; } - -/* Used to denote text that shouldn't be selectable, such as line numbers or - shell prompts. Guess which browser this doesn't work in. */ -.noselect { - -moz-user-select: -moz-none; - -khtml-user-select: none; - -webkit-user-select: none; - -o-user-select: none; - user-select: none; -} - -/* -- Lists ----------------------------------------------------------------- */ -dd { margin: 0.2em 0 0.7em 1em; } -dl { margin: 1em 0; } -dt { font-weight: bold; } - -/* -- Tables ---------------------------------------------------------------- */ -caption, th { text-align: left; } - -table { - border-collapse: collapse; - width: 100%; -} - -td, th { - border: 1px solid #fff; - padding: 5px 12px; - vertical-align: top; -} - -td { background: #E6E9F5; } -td dl { margin: 0; } -td dl dl { margin: 1em 0; } -td pre:first-child { margin-top: 0; } - -th { - background: #D2D7E6;/*#97A0BF*/ - border-bottom: none; - border-top: none; - color: #000;/*#FFF1D5*/ - font-family: 'Trebuchet MS', sans-serif; - font-weight: bold; - line-height: 1.3; - white-space: nowrap; -} - - -/* -- Layout and Content ---------------------------------------------------- */ -#doc { - margin: auto; - min-width: 1024px; -} - -.content { padding: 0 20px 0 25px; } - -.sidebar { - padding: 0 15px 0 10px; -} -#bd { - padding: 7px 0 130px; - position: relative; - width: 99%; -} - -/* -- Table of Contents ----------------------------------------------------- */ - -/* The #toc id refers to the single global table of contents, while the .toc - class refers to generic TOC lists that could be used throughout the page. */ - -.toc code, .toc kbd, .toc samp { font-size: 100%; } -.toc li { font-weight: bold; } -.toc li li { font-weight: normal; } - -/* -- Intro and Example Boxes ----------------------------------------------- */ -/* -.intro, .example { margin-bottom: 2em; } -.example { - -moz-border-radius: 4px; - -webkit-border-radius: 4px; - border-radius: 4px; - -moz-box-shadow: 0 0 5px #bfbfbf; - -webkit-box-shadow: 0 0 5px #bfbfbf; - box-shadow: 0 0 5px #bfbfbf; - padding: 1em; -} -.intro { - background: none repeat scroll 0 0 #F0F1F8; border: 1px solid #D4D8EB; padding: 0 1em; -} -*/ - -/* -- Other Styles ---------------------------------------------------------- */ - -/* These are probably YUI-specific, and should be moved out of Selleck's default - theme. */ - -.button { - border: 1px solid #dadada; - -moz-border-radius: 3px; - -webkit-border-radius: 3px; - border-radius: 3px; - color: #444; - display: inline-block; - font-family: Helvetica, Arial, sans-serif; - font-size: 92.308%; - font-weight: bold; - padding: 4px 13px 3px; - -moz-text-shadow: 1px 1px 0 #fff; - -webkit-text-shadow: 1px 1px 0 #fff; - text-shadow: 1px 1px 0 #fff; - white-space: nowrap; - - background: #EFEFEF; /* old browsers */ - background: -moz-linear-gradient(top, #f5f5f5 0%, #efefef 50%, #e5e5e5 51%, #dfdfdf 100%); /* firefox */ - background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#f5f5f5), color-stop(50%,#efefef), color-stop(51%,#e5e5e5), color-stop(100%,#dfdfdf)); /* webkit */ - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f5f5f5', endColorstr='#dfdfdf',GradientType=0 ); /* ie */ -} - -.button:hover { - border-color: #466899; - color: #fff; - text-decoration: none; - -moz-text-shadow: 1px 1px 0 #222; - -webkit-text-shadow: 1px 1px 0 #222; - text-shadow: 1px 1px 0 #222; - - background: #6396D8; /* old browsers */ - background: -moz-linear-gradient(top, #6396D8 0%, #5A83BC 50%, #547AB7 51%, #466899 100%); /* firefox */ - background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#6396D8), color-stop(50%,#5A83BC), color-stop(51%,#547AB7), color-stop(100%,#466899)); /* webkit */ - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#6396D8', endColorstr='#466899',GradientType=0 ); /* ie */ -} - -.newwindow { text-align: center; } - -.header .version em { - display: block; - text-align: right; -} - - -#classdocs .item { - border-bottom: 1px solid #466899; - margin: 1em 0; - padding: 1.5em; -} - -#classdocs .item .params p, - #classdocs .item .returns p,{ - display: inline; -} - -#classdocs .item em code, #classdocs .item em.comment { - color: green; -} - -#classdocs .item em.comment a { - color: green; - text-decoration: underline; -} - -#classdocs .foundat { - font-size: 11px; - font-style: normal; -} - -.attrs .emits { - margin-left: 2em; - padding: .5em; - border-left: 1px dashed #ccc; -} - -abbr { - border-bottom: 1px dashed #ccc; - font-size: 80%; - cursor: help; -} - -.prettyprint li.L0, -.prettyprint li.L1, -.prettyprint li.L2, -.prettyprint li.L3, -.prettyprint li.L5, -.prettyprint li.L6, -.prettyprint li.L7, -.prettyprint li.L8 { - list-style: decimal; -} - -ul li p { - margin-top: 0; -} - -.method .name { - font-size: 110%; -} - -.apidocs .methods .extends .method, -.apidocs .properties .extends .property, -.apidocs .attrs .extends .attr, -.apidocs .events .extends .event { - font-weight: bold; -} - -.apidocs .methods .extends .inherited, -.apidocs .properties .extends .inherited, -.apidocs .attrs .extends .inherited, -.apidocs .events .extends .inherited { - font-weight: normal; -} - -#hd { - background: whiteSmoke; - background: -moz-linear-gradient(top,#DCDBD9 0,#F6F5F3 100%); - background: -webkit-gradient(linear,left top,left bottom,color-stop(0%,#DCDBD9),color-stop(100%,#F6F5F3)); - filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#dcdbd9',endColorstr='#F6F5F3',GradientType=0); - border-bottom: 1px solid #DFDFDF; - padding: 0 15px 1px 20px; - margin-bottom: 15px; -} - -#hd img { - margin-right: 10px; - vertical-align: middle; - -} - - -img { - max-height: 300px; -} - - -/* -- API Docs CSS ---------------------------------------------------------- */ - -/* -This file is organized so that more generic styles are nearer the top, and more -specific styles are nearer the bottom of the file. This allows us to take full -advantage of the cascade to avoid redundant style rules. Please respect this -convention when making changes. -*/ - -/* -- Generic TabView styles ------------------------------------------------ */ - -/* -These styles apply to all API doc tabviews. To change styles only for a -specific tabview, see the other sections below. -*/ - -.yui3-js-enabled .apidocs .tabview { - visibility: hidden; /* Hide until the TabView finishes rendering. */ - _visibility: visible; -} - -.apidocs .tabview.yui3-tabview-content { visibility: visible; } -.apidocs .tabview .yui3-tabview-panel { background: #fff; } - -/* -- Generic Content Styles ------------------------------------------------ */ - -/* Headings */ -h2, h3, h4, h5, h6 { - border: none; - color: #30418C; - font-weight: bold; - text-decoration: none; -} - -.link-docs { - float: right; - font-size: 15px; - margin: 4px 4px 6px; - padding: 6px 30px 5px; -} - -.apidocs { zoom: 1; } - -/* Generic box styles. */ -.apidocs .box { - border: 1px solid; - border-radius: 3px; - margin: 1em 0; - padding: 0 1em; -} - -/* A flag is a compact, capsule-like indicator of some kind. It's used to - indicate private and protected items, item return types, etc. in an - attractive and unobtrusive way. */ -.apidocs .flag { - background: #bababa; - border-radius: 3px; - color: #fff; - font-size: 11px; - margin: 0 0.5em; - padding: 2px 4px 1px; -} - -/* Class/module metadata such as "Uses", "Extends", "Defined in", etc. */ -.apidocs .meta { - background: #f9f9f9; - border-color: #efefef; - color: #555; - font-size: 11px; - padding: 3px 6px; -} - -.apidocs .meta p { margin: 0; } - -/* Deprecation warning. */ -.apidocs .box.deprecated, -.apidocs .flag.deprecated { - background: #fdac9f; - border: 1px solid #fd7775; -} - -.apidocs .box.deprecated p { margin: 0.5em 0; } -.apidocs .flag.deprecated { color: #333; } - -/* Module/Class intro description. */ -.apidocs .intro { - background: #f0f1f8; - border-color: #d4d8eb; -} - -/* Loading spinners. */ -#bd.loading .apidocs, -#api-list.loading .yui3-tabview-panel { - background: #fff url(../img/spinner.gif) no-repeat center 70px; - min-height: 150px; -} - -#bd.loading .apidocs .content, -#api-list.loading .yui3-tabview-panel .apis { - display: none; -} - -.apidocs .no-visible-items { color: #666; } - -/* Generic inline list. */ -.apidocs ul.inline { - display: inline; - list-style: none; - margin: 0; - padding: 0; -} - -.apidocs ul.inline li { display: inline; } - -/* Comma-separated list. */ -.apidocs ul.commas li:after { content: ','; } -.apidocs ul.commas li:last-child:after { content: ''; } - -/* Keyboard shortcuts. */ -kbd .cmd { font-family: Monaco, Helvetica; } - -/* -- Generic Access Level styles ------------------------------------------- */ -.apidocs .item.protected, -.apidocs .item.private, -.apidocs .index-item.protected, -.apidocs .index-item.deprecated, -.apidocs .index-item.private { - display: none; -} - -.show-deprecated .item.deprecated, -.show-deprecated .index-item.deprecated, -.show-protected .item.protected, -.show-protected .index-item.protected, -.show-private .item.private, -.show-private .index-item.private { - display: block; -} - -.hide-inherited .item.inherited, -.hide-inherited .index-item.inherited { - display: none; -} - -/* -- Generic Item Index styles --------------------------------------------- */ -.apidocs .index { margin: 1.5em 0 3em; } - -.apidocs .index h3 { - border-bottom: 1px solid #efefef; - color: #333; - font-size: 13px; - margin: 2em 0 0.6em; - padding-bottom: 2px; -} - -.apidocs .index .no-visible-items { margin-top: 2em; } - -.apidocs .index-list { - border-color: #efefef; - font-size: 12px; - list-style: none; - margin: 0; - padding: 0; - -moz-column-count: 4; - -moz-column-gap: 10px; - -moz-column-width: 170px; - -ms-column-count: 4; - -ms-column-gap: 10px; - -ms-column-width: 170px; - -o-column-count: 4; - -o-column-gap: 10px; - -o-column-width: 170px; - -webkit-column-count: 4; - -webkit-column-gap: 10px; - -webkit-column-width: 170px; - column-count: 4; - column-gap: 10px; - column-width: 170px; -} - -.apidocs .no-columns .index-list { - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - -webkit-column-count: 1; - column-count: 1; -} - -.apidocs .index-item { white-space: nowrap; } - -.apidocs .index-item .flag { - background: none; - border: none; - color: #afafaf; - display: inline; - margin: 0 0 0 0.2em; - padding: 0; -} - -/* -- Generic API item styles ----------------------------------------------- */ -.apidocs .args { - display: inline; - margin: 0 0.5em; -} - -.apidocs .flag.chainable { background: #46ca3b; } -.apidocs .flag.protected { background: #9b86fc; } -.apidocs .flag.private { background: #fd6b1b; } -.apidocs .flag.async { background: #356de4; } -.apidocs .flag.required { background: #e60923; } - -.apidocs .item { - border-bottom: 1px solid #efefef; - margin: 1.5em 0 2em; - padding-bottom: 2em; -} - -.apidocs .item h4, -.apidocs .item h5, -.apidocs .item h6 { - color: #333; - font-family: inherit; - font-size: 100%; -} - -.apidocs .item .description p, -.apidocs .item pre.code { - margin: 1em 0 0; -} - -.apidocs .item .meta { - background: none; - border: none; - padding: 0; -} - -.apidocs .item .name { - display: inline; - font-size: 14px; -} - -.apidocs .item .type, -.apidocs .item .type a, -.apidocs .returns-inline { - color: #555; -} - -.apidocs .item .type, -.apidocs .returns-inline { - font-size: 11px; - margin: 0 0 0 0; -} - -.apidocs .item .type a { border-bottom: 1px dotted #afafaf; } -.apidocs .item .type a:hover { border: none; } - -/* -- Item Parameter List --------------------------------------------------- */ -.apidocs .params-list { - list-style: square; - margin: 1em 0 0 2em; - padding: 0; -} - -.apidocs .param { margin-bottom: 1em; } - -.apidocs .param .type, -.apidocs .param .type a { - color: #666; -} - -.apidocs .param .type { - margin: 0 0 0 0.5em; - *margin-left: 0.5em; -} - -.apidocs .param-name { font-weight: bold; } - -/* -- Item "Emits" block ---------------------------------------------------- */ -.apidocs .item .emits { - background: #f9f9f9; - border-color: #eaeaea; -} - -/* -- Item "Returns" block -------------------------------------------------- */ -.apidocs .item .returns .type, -.apidocs .item .returns .type a { - font-size: 100%; - margin: 0; -} - -/* -- Class Constructor block ----------------------------------------------- */ -.apidocs .constructor .item { - border: none; - padding-bottom: 0; -} - -/* -- File Source View ------------------------------------------------------ */ -.apidocs .file pre.code, -#doc .apidocs .file pre.prettyprint { - background: inherit; - border: none; - overflow: visible; - padding: 0; -} - -.apidocs .L0, -.apidocs .L1, -.apidocs .L2, -.apidocs .L3, -.apidocs .L4, -.apidocs .L5, -.apidocs .L6, -.apidocs .L7, -.apidocs .L8, -.apidocs .L9 { - background: inherit; -} - -/* -- Submodule List -------------------------------------------------------- */ -.apidocs .module-submodule-description { - font-size: 12px; - margin: 0.3em 0 1em; -} - -.apidocs .module-submodule-description p:first-child { margin-top: 0; } - -/* -- Sidebar TabView ------------------------------------------------------- */ -#api-tabview { margin-top: 0.6em; } - -#api-tabview-filter, -#api-tabview-panel { - border: 1px solid #dfdfdf; -} - -#api-tabview-filter { - border-bottom: none; - border-top: none; - padding: 0.6em 10px 0 10px; -} - -#api-tabview-panel { border-top: none; } -#api-filter { width: 97%; } - -/* -- Content TabView ------------------------------------------------------- */ -#classdocs .yui3-tabview-panel { border: none; } - -/* -- Source File Contents -------------------------------------------------- */ -.prettyprint li.L0, -.prettyprint li.L1, -.prettyprint li.L2, -.prettyprint li.L3, -.prettyprint li.L5, -.prettyprint li.L6, -.prettyprint li.L7, -.prettyprint li.L8 { - list-style: decimal; -} - -/* -- API options ----------------------------------------------------------- */ -#api-options { - font-size: 11px; - margin-top: 2.2em; - position: absolute; - right: 1.5em; -} - -/*#api-options label { margin-right: 0.6em; }*/ - -/* -- API list -------------------------------------------------------------- */ -#api-list { - margin-top: 1.5em; - *zoom: 1; -} - -.apis { - font-size: 12px; - line-height: 1.4; - list-style: none; - margin: 0; - padding: 0.5em 0 0.5em 0.4em; -} - -.apis a { - border: 1px solid transparent; - display: block; - margin: 0 0 0 -4px; - padding: 1px 4px 0; - text-decoration: none; - _border: none; - _display: inline; -} - -.apis a:hover, -.apis a:focus { - background: #E8EDFC; - background: -moz-linear-gradient(top, #e8edfc 0%, #becef7 100%); - background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#E8EDFC), color-stop(100%,#BECEF7)); - border-color: #AAC0FA; - border-radius: 3px; - color: #333; - outline: none; -} - -.api-list-item a:hover, -.api-list-item a:focus { - font-weight: bold; - text-shadow: 1px 1px 1px #fff; -} - -.apis .message { color: #888; } -.apis .result a { padding: 3px 5px 2px; } - -.apis .result .type { - right: 4px; - top: 7px; -} - -.api-list-item .yui3-highlight { - font-weight: bold; -} - -div.right-arrow { - width: 0; - height: 0; - border-bottom: 5px solid transparent; - border-top: 5px solid transparent; - border-left: 5px solid #356de4; - font-size: 0; - margin-right: 5px; - float: left; - } - -div.down-arrow { - width: 0; - height: 0; - border-left: 5px solid transparent; - border-right: 5px solid transparent; - border-top: 5px solid #356de4; - font-size: 0; - margin-right: 5px; - float: left; -} - -div.upmGroup { - font-weight: bold; -} diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/layouts/main.handlebars b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/layouts/main.handlebars deleted file mode 100644 index 82aa193..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/layouts/main.handlebars +++ /dev/null @@ -1,53 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<head> - <meta charset="utf-8"> - <title>{{htmlTitle}}</title> - <link rel="stylesheet" href="{{yuiGridsUrl}}"> - <link rel="stylesheet" href="{{projectAssets}}/vendor/prettify/prettify-min.css"> - <link rel="stylesheet" href="{{projectAssets}}/css/main.css" id="site_styles"> - <link rel="icon" href="{{projectAssets}}/favicon.ico"> - <script src="{{yuiSeedUrl}}"></script> -</head> -<body class="yui3-skin-sam"> - -<div id="doc"> - <div id="hd" class="yui3-g header"> - <div class="yui3-u-3-4"> - <h1>UPM</h1> - <p> - The UPM API is a high level sensor library for IoT devices using MRAA. See examples <a href="https://github.com/intel-iot-devkit/upm/tree/master/examples/javascript">here</a>. - Back to <a href="http://iotdk.intel.com/docs/master/upm/node/"> index </a> page. - <br><em>SparkFun sensor images provided under <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>CC BY-NC-SA-3.0</a>.</em> - </p> - </div> - </div> - <div id="bd" class="yui3-g"> - - <div class="yui3-u-1-4"> - <div id="docs-sidebar" class="sidebar apidocs"> - {{>sidebar}} - </div> - </div> - <div class="yui3-u-3-4"> - {{>options}} - <div class="apidocs"> - <div id="docs-main"> - <div class="content"> - {{>layout_content}} - </div> - </div> - </div> - </div> - </div> -</div> -<script src="{{projectAssets}}/vendor/prettify/prettify-min.js"></script> -<script>prettyPrint();</script> -<script src="{{projectAssets}}/js/yui-prettify.js"></script> -<script src="{{projectAssets}}/../api.js"></script> -<script src="{{projectAssets}}/js/api-filter.js"></script> -<script src="{{projectAssets}}/js/api-list.js"></script> -<script src="{{projectAssets}}/js/api-search.js"></script> -<script src="{{projectAssets}}/js/apidocs.js"></script> -</body> -</html> diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/classes.handlebars b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/classes.handlebars deleted file mode 100644 index 01bad1a..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/classes.handlebars +++ /dev/null @@ -1,205 +0,0 @@ -<h1>{{name}} Class</h1> -<div class="box meta"> - {{#if uses}} - <div class="uses"> - Uses - <ul class="inline commas"> - {{#uses}} - <li><a href="{{.}}.html">{{.}}</a></li> - {{/uses}} - </ul> - </div> - {{/if}} - - {{#if extends}} - <div class="extends"> - Extends {{#crossLink extends}}{{/crossLink}} - </div> - {{/if}} - - {{#if foundAt}} - <div class="foundat"> - Defined in: <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a> - </div> - {{/if}} - - {{#if module}} - {{#if submodule}} - Module: {{#crossLinkModule submodule}}{{/crossLinkModule}}<br> - Parent Module: {{#crossLinkModule module}}{{/crossLinkModule}} - {{else}} - Module: {{#crossLinkModule module}}{{/crossLinkModule}} - {{/if}} - {{/if}} - - {{#if since}} - <p>Available since {{since}}</p> - {{/if}} -</div> - -{{#if deprecated}} - <div class="box deprecated"> - <p> - {{#if deprecationMessage}} - <strong>Deprecated:</strong> {{deprecationMessage}} - {{else}} - This class is deprecated. - {{/if}} - </p> - </div> -{{/if}} - -<div class="box intro"> - {{{classDescription}}} -</div> - -{{#is_constructor}} - <div class="constructor"> - <h2>Constructor</h2> -{{>method}} - </div> -{{/is_constructor}} - -<div id="classdocs" class="tabview"> - <ul class="api-class-tabs"> - <li class="api-class-tab index"><a href="#index">Index</a></li> - - {{#if methods}} - <li class="api-class-tab methods"><a href="#methods">Methods</a></li> - {{/if}} - {{#if properties}} - <li class="api-class-tab properties"><a href="#properties">Properties</a></li> - {{/if}} - {{#if attrs}} - <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li> - {{/if}} - {{#if events}} - <li class="api-class-tab events"><a href="#events">Events</a></li> - {{/if}} - </ul> - - <div> - <div id="index" class="api-class-tabpanel index"> - <h2 class="off-left">Item Index</h2> - - {{#if methods}} - <div class="index-section methods"> - <h3>Methods</h3> - - <ul class="index-list methods{{#if extends}} extends{{/if}}"> - {{#methods}} - <li class="index-item method{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}"> - <a href="#method_{{name}}">{{name}}</a> - - {{#if static}} - <span class="flag static">static</span> - {{/if}} - {{#if deprecated}} - <span class="flag deprecated">deprecated</span> - {{/if}} - </li> - {{/methods}} - </ul> - </div> - {{/if}} - - {{#if properties}} - <div class="index-section properties"> - <h3>Properties</h3> - - <ul class="index-list properties{{#if extends}} extends{{/if}}"> - {{#properties}} - <li class="index-item property{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}"> - <a href="#property_{{name}}">{{name}}</a> - - {{#if static}} - <span class="flag static">static</span> - {{/if}} - {{#if deprecated}} - <span class="flag deprecated">deprecated</span> - {{/if}} - </li> - {{/properties}} - </ul> - </div> - {{/if}} - - {{#if attrs}} - <div class="index-section attrs"> - <h3>Attributes</h3> - - <ul class="index-list attrs{{#if extends}} extends{{/if}}"> - {{#attrs}} - <li class="index-item attr{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}"> - <a href="#attr_{{name}}">{{name}}</a> - </li> - {{/attrs}} - </ul> - </div> - {{/if}} - - {{#if events}} - <div class="index-section events"> - <h3>Events</h3> - - <ul class="index-list events{{#if extends}} extends{{/if}}"> - {{#events}} - <li class="index-item event{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}"> - <a href="#event_{{name}}">{{name}}</a> - - {{#if static}} - <span class="flag static">static</span> - {{/if}} - {{#if deprecated}} - <span class="flag deprecated">deprecated</span> - {{/if}} - </li> - {{/events}} - </ul> - </div> - {{/if}} - </div> - - {{#if methods}} - <div id="methods" class="api-class-tabpanel"> - <h2 class="off-left">Methods</h2> - - {{#methods}} -{{>method}} - {{/methods}} - </div> - {{/if}} - - {{#if properties}} - <div id="properties" class="api-class-tabpanel"> - <h2 class="off-left">Properties</h2> - - {{#properties}} - {{>props}} - {{/properties}} - </div> - {{/if}} - - {{#if attrs}} - <div id="attrs" class="api-class-tabpanel"> - <h2 class="off-left">Attributes</h2> - - {{#attrs}} - {{>attrs}} - {{/attrs}} - </div> - {{/if}} - - {{#if events}} - <div id="events" class="api-class-tabpanel"> - <h2 class="off-left">Events</h2> - - {{#events}} - {{>events}} - {{/events}} - </div> - {{/if}} - </div> -</div> - -{{{customCrossLinks}}} diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars deleted file mode 100644 index 9b893b5..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars +++ /dev/null @@ -1,180 +0,0 @@ -<div class="apidocs"> - <div class="content" id="docs-main"> - <h1><strong>Welcome to UPM Node.JS Documentation!</strong><a class="headerlink" - href="#welcome-to-upm-python-documentation"></a></h1> - - - <p>Browse to a module or class using the sidebar to view its API - documentation.</p> - - <p>UPM is a high level repository for sensors that use MRAA. Each - sensor links to MRAA and are not meant to be interlinked although - some groups of sensors may be. Each sensor contains a header which - allows to interface with it. Typically a sensor is represented as a - class and instantiated.</p> - - <p>The constructor is expected to initialise the sensor and parameters - may be used to provide identification/pin location on the board.</p> - - <p>Typically an update() function will be called in order to get new - data from the sensor in order to reduce load when doing multiple reads - to sensor data.</p> - <div class="section" id="examples"> - <h3><code class="docutils literal"><span class="pre">Examples</span></code><a class="headerlink" - href="#examples" - title="Permalink to this headline">*</a></h3> - - - <p>Multi-sensor samples for the starter and specialized kits can be - found in the - <a class="reference external" - href="https://github.com/intel-iot-devkit/iot-devkit-samples">iot-devkit-samples</a> - repository.</p> - - <p>Individual sensor usage examples for node.js are available - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/tree/master/examples/javascript">here</a>.</p> - - </div> - <div class="section" id="ide"> - <h3><tt class="docutils literal"><span class="pre">IDE Compatibility</span> - <span class="pre">UPM</span></tt><a class="headerlink" - href="#ide" - title="Permalink to this headline">*</a></h3> - - - <p>Intel® XDK IoT Edition is the recommended IDE for Node.js development. - Visit the Intel® Developer Zone IDE page for more information on how to get - started.<br> - <a href="https://software.intel.com/iot/software/ide"><img src="../docs/icons/xdk.png"/></a> - </p> - </div> - <div class="section" id="building-upm"> - <h3><tt class="docutils literal"><span class="pre">Building</span> - <span class="pre">UPM</span></tt><a class="headerlink" - href="#building-upm" - title="Permalink to this headline">*</a></h3> - - - <p>For building UPM, please follow this - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md">link</a>.</p> - - </div> - <div class="section" id="making-your-own-upm-module"> - <h3><tt class="docutils literal"><span class="pre">Making</span> - <span class="pre">your</span> <span class="pre">own</span> - <span class="pre">UPM</span> <span class="pre">Module</span></tt><a class="headerlink" - href="#making-your-own-upm-module" - title="Permalink to this headline">*</a></h3> - - - <p>This - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md">link</a> - has more information on making a new UPM module.</p> - - <p>There is also an example available for max31855 - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md">sensor</a>.</p> - - </div> - <div class="section" - id="naming-conventions-and-rules-for-new-upm-contributions"> - <h3><tt class="docutils literal"><span class="pre">Naming</span> - <span class="pre">Conventions</span> <span class="pre">and</span> - <span class="pre">Rules</span> <span class="pre">for</span> - <span class="pre">New</span> <span class="pre">UPM</span> - <span class="pre">Contributions</span></tt><a class="headerlink" - href="#naming-conventions-and-rules-for-new-upm-contributions" - title="Permalink to this headline">*</a></h3> - - - <p>Before you begin development, please take a look at our naming - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md">conventions</a>.</p> - - - <p>Also, please read the guidelines for contributions to - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/blob/master/docs/contributions.md">UPM</a>.</p> - - - <p>Don’t forget to check the documentation - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/blob/master/docs/documentation.md">section</a>.</p> - - <div class="admonition note"> - - <p class="first admonition-title">Note</p> - <ul class="last simple"> - <li>Make sure you add yourself as an author on every new code - file submitted.</li> - <li>If you are providing a fix with significant changes, feel - free to add yourself as a contributor.</li> - <li>Signing-off your commits is mandatory.</li> - </ul> - </div> - </div> - <div class="section" id="api-documentation"> - <h1><strong>Other API Documentation</strong><a class="headerlink" - href="#api-documentation" - title="Permalink to this headline"></a></h1> - - - <p><a href="http://iotdk.intel.com/docs/master/upm"><img src="../docs/icons/c++.png" /></a> - <a href="http://iotdk.intel.com/docs/master/upm/java"><img src="../docs/icons/java.png" /></a> - <a href="http://iotdk.intel.com/docs/master/upm/python"><img src="../docs/icons/python.png" /></a> - <a href="http://iotdk.intel.com/docs/master/upm/node"><img src="../docs/icons/node.png" /></a> - </p> - </div> - <div class="section" id="version-changelog"> - <h3><tt class="docutils literal"><span class="pre">Version</span> - <span class="pre">Changelog</span></tt><a class="headerlink" - href="#version-changelog" - title="Permalink to this headline">*</a></h3> - - - <p>For our Version Changelog, please see - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md">here</a>.</p> - - </div> - <div class="section" id="known-limitations"> - <h3><tt class="docutils literal"><span class="pre">Known</span> - <span class="pre">Limitations</span></tt><a class="headerlink" - href="#known-limitations" - title="Permalink to this headline">*</a></h3> - - - <p>For the List of Known Limitations, please see - <a class="reference external" - href="https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md">here</a>.</p> - - </div> - <div class="section" id="keyboard-shortcuts"> - <h3><tt class="docutils literal"><span class="pre">Keyboard</span> - <span class="pre">Shortcuts</span></tt><a class="headerlink" - href="#keyboard-shortcuts" - title="Permalink to this headline">*</a></h3> - - <ul> - <li> - - <p>Press <kbd>s</kbd> to focus the API search box.</p> </li> - <li> - - <p>Use <kbd>Up</kbd> and <kbd>Down</kbd> to select classes, - modules, and search results.</p> </li> - <li class="mac-only"> - - <p>With the API search box or sidebar focused, use <kbd><span class="cmd">⌘</span>-Left</kbd> - or <kbd><span class="cmd">⌘</span>-Right</kbd> to switch - sidebar tabs.</p> </li> - <li class="pc-only"> - - <p>With the API search box or sidebar focused, use <kbd>Ctrl+Left</kbd> - and <kbd>Ctrl+Right</kbd> to switch sidebar tabs.</p> </li> - </ul> - </div> - </div> diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/method.handlebars b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/method.handlebars deleted file mode 100644 index 664d79b..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/method.handlebars +++ /dev/null @@ -1,212 +0,0 @@ -<div id="method_{{name}}" class="method item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}"> - <h3 class="name"><code>{{name}}</code></h3> - - {{#if params}} - <div class="args"> - <span class="paren">(</span><ul class="args-list inline commas"> - {{#params}} - <li class="arg"> - {{#if optional}} - <code class="optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code> - {{else}} - <code>{{name}}</code> - {{/if}} - </li> - {{/params}} - </ul><span class="paren">)</span> - </div> - {{else}} - <span class="paren">()</span> - {{/if}} - - {{#if return}} - <span class="returns-inline"> - <span class="type">{{#crossLink returnType}}{{/crossLink}}</span> - </span> - {{/if}} - - {{#if deprecated}} - <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span> - {{/if}} - - {{#if access}} - <span class="flag {{access}}">{{access}}</span> - {{/if}} - - {{#if final}} - <span class="flag final">final</span> - {{/if}} - - {{#if static}} - <span class="flag static">static</span> - {{/if}} - - {{#if chainable}} - <span class="flag chainable">chainable</span> - {{/if}} - - {{#if async}} - <span class="flag async">async</span> - {{/if}} - - <div class="meta"> - {{#if overwritten_from}} - <p>Inherited from - <a href="{{crossLinkRaw overwritten_from/class}}#method_{{overwritten_from/name}}"> - {{overwritten_from/class}} - </a> - {{#if foundAt}} - but overwritten in - {{/if}} - {{else}} - {{#if extended_from}} - <p>Inherited from - <a href="{{crossLinkRaw extended_from}}#method_{{name}}">{{extended_from}}</a>: - {{else}} - {{#providedBy}} - <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p> - {{/providedBy}} - <p> - {{#if foundAt}} - Defined in - {{/if}} - {{/if}} - {{/if}} - {{#if foundAt}} - <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a> - {{/if}} - </p> - - - {{#if deprecationMessage}} - <p>Deprecated: {{deprecationMessage}}</p> - {{/if}} - - {{#if since}} - <p>Available since {{since}}</p> - {{/if}} - </div> - - <div class="description"> - {{{methodDescription}}} - </div> - - {{#if params}} - <div class="params"> - <h4>Parameters:</h4> - - <ul class="params-list"> - {{#params}} - <li class="param"> - {{#if optional}} - <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - <span class="flag optional" title="This parameter is optional.">optional</span> - {{else}} - <code class="param-name">{{name}}</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - {{/if}} - - {{#if multiple}} - <span class="flag multiple" title="This argument may occur one or more times.">multiple</span> - {{/if}} - - <div class="param-description"> - {{{description}}} - </div> - - {{#if props}} - <ul class="params-list"> - {{#props}} - <li class="param"> - {{#if optional}} - <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - <span class="flag optional" title="This parameter is optional.">optional</span> - {{else}} - <code class="param-name">{{name}}</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - {{/if}} - - <div class="param-description"> - {{{description}}} - </div> - - {{#if props}} - <ul class="params-list"> - {{#props}} - <li class="param"> - {{#if optional}} - <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - <span class="flag optional" title="This parameter is optional.">optional</span> - {{else}} - <code class="param-name">{{name}}</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - {{/if}} - - <div class="param-description"> - {{{description}}} - </div> - </li> - {{/props}} - </ul> - {{/if}} - </li> - {{/props}} - </ul> - {{/if}} - </li> - {{/params}} - </ul> - </div> - {{/if}} - - {{#return}} - <div class="returns"> - <h4>Returns:</h4> - - <div class="returns-description"> - {{#if description}} - {{#if type}} - <span class="type">{{#crossLink type}}{{/crossLink}}</span>: - {{/if}} - {{{description}}} - {{else}} - {{#if type}} - <span class="type">{{#crossLink type}}{{/crossLink}}</span>: - {{/if}} - {{/if}} - </div> - </div> - {{/return}} - - {{#throws}} - <div class="throws"> - <h4>Throws:</h4> - - <div class="throws-description"> - {{#if description}} - {{#if type}} - <span class="type">{{#crossLink type}}{{/crossLink}}</span>: - {{/if}} - {{{description}}} - {{else}} - {{#if type}} - <span class="type">{{#crossLink type}}{{/crossLink}}</span>: - {{/if}} - {{/if}} - </div> - </div> - {{/throws}} - - {{#example}} - <div class="example"> - <h4>Example:</h4> - - <div class="example-content"> - {{{.}}} - </div> - </div> - {{/example}} -</div> diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/module.handlebars b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/module.handlebars deleted file mode 100644 index 190007f..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/module.handlebars +++ /dev/null @@ -1,92 +0,0 @@ -<h1>{{name}} Module</h1> -<div class="box clearfix meta"> - {{#extra}} - {{#selleck}} - <a class="button link-docs" href="/yui/docs/{{name}}">User Guide & Examples</a> - {{/selleck}} - {{/extra}} - - {{#if requires}} - <div class="uses"> - Requires - <ul class="inline commas"> - {{#requires}} - <li>{{#crossLinkModule .}}{{/crossLinkModule}}</li> - {{/requires}} - </ul> - </div> - {{/if}} - - {{#if foundAt}} - <div class="foundat"> - Defined in: <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a> - </div> - {{/if}} - - {{#if since}} - <p>Available since {{since}}</p> - {{/if}} -</div> - -{{#if deprecated}} - <div class="box deprecated"> - <p> - {{#if deprecationMessage}} - <strong>Deprecated:</strong> {{deprecationMessage}} - {{else}} - This module is deprecated. - {{/if}} - </p> - </div> -{{/if}} - -<div class="box intro"> - {{{moduleDescription}}} -</div> - -{{#example}} - <div class="example"> - <h4>Example:</h4> - <div class="example-content"> - {{{.}}} - </div> - </div> -{{/example}} - -<div class="yui3-g"> - <div class="yui3-u-1-2"> - {{#if moduleClasses}} - <p>This module provides the following classes:</p> - - <ul class="module-classes"> - {{#moduleClasses}} - <li class="module-class"> - <a href="{{../projectRoot}}classes/{{name}}.html"> - {{displayName}} - </a> - </li> - {{/moduleClasses}} - </ul> - {{/if}} - </div> - - <div class="yui3-u-1-2"> - {{#if subModules}} - <p>This module is a rollup of the following modules:</p> - - <ul class="module-submodules"> - {{#subModules}} - <li class="module-submodule"> - <a href="{{../projectRoot}}modules/{{name}}.html"> - {{displayName}} - </a> - - <div class="module-submodule-description"> - {{{description}}} - </div> - </li> - {{/subModules}} - </ul> - {{/if}} - </div> -</div> diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/options.handlebars b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/options.handlebars deleted file mode 100644 index 2d8333a..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/options.handlebars +++ /dev/null @@ -1,22 +0,0 @@ -<div id="api-options" hidden> - Show: - <label for="api-show-inherited"> - <input type="checkbox" id="api-show-inherited" checked> - Inherited - </label> - - <label for="api-show-protected"> - <input type="checkbox" id="api-show-protected"> - Protected - </label> - - <label for="api-show-private"> - <input type="checkbox" id="api-show-private"> - Private - </label> - <label for="api-show-deprecated"> - <input type="checkbox" id="api-show-deprecated"> - Deprecated - </label> - </div> - diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/props.handlebars b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/props.handlebars deleted file mode 100644 index 696e720..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/props.handlebars +++ /dev/null @@ -1,119 +0,0 @@ -<div id="property_{{name}}" class="property item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}"> - <h3 class="name"><code>{{name}}</code></h3> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - - {{#if deprecated}} - <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span> - {{/if}} - - {{#if access}} - <span class="flag {{access}}">{{access}}</span> - {{/if}} - - {{#if final}} - <span class="flag final">final</span> - {{/if}} - - {{#if static}} - <span class="flag static">static</span> - {{/if}} - - <div class="meta"> - {{#if overwritten_from}} - <p>Inherited from - <a href="{{crossLinkRaw overwritten_from/class}}#property_{{overwritten_from/name}}"> - {{overwritten_from/class}} - </a> - {{#if foundAt}} - but overwritten in - {{/if}} - {{else}} - {{#if extended_from}} - <p>Inherited from - <a href="{{crossLinkRaw extended_from}}#property_{{name}}">{{extended_from}}</a>: - {{else}} - {{#providedBy}} - <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p> - {{/providedBy}} - <p> - {{#if foundAt}} - Defined in - {{/if}} - {{/if}} - {{/if}} - {{#if foundAt}} - <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a> - {{/if}} - </p> - - {{#if deprecationMessage}} - <p>Deprecated: {{deprecationMessage}}</p> - {{/if}} - - {{#if since}} - <p>Available since {{since}}</p> - {{/if}} - </div> - - <div class="description"> - {{{propertyDescription}}} - </div> - - {{#if default}} - <p><strong>Default:</strong> {{default}}</p> - {{/if}} - - {{#example}} - <div class="example"> - <h4>Example:</h4> - - <div class="example-content"> - {{{.}}} - </div> - </div> - {{/example}} - - {{#if subprops}} - <h4>Sub-properties:</h4> - - <ul class="params-list"> - {{#subprops}} - <li class="param"> - {{#if optional}} - <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - <span class="flag optional" title="This property is optional.">optional</span> - {{else}} - <code class="param-name">{{name}}</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - {{/if}} - - <div class="param-description"> - {{{description}}} - </div> - - {{#if subprops}} - <ul class="params-list"> - {{#subprops}} - <li class="param"> - {{#if optional}} - <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - <span class="flag optional" title="This property is optional.">optional</span> - {{else}} - <code class="param-name">{{name}}</code> - <span class="type">{{#crossLink type}}{{/crossLink}}</span> - {{/if}} - - <div class="param-description"> - {{{description}}} - </div> - </li> - {{/subprops}} - </ul> - {{/if}} - </li> - {{/subprops}} - </ul> - {{/if}} -</div> diff --git a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/sidebar.handlebars b/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/sidebar.handlebars deleted file mode 100644 index fcffc3c..0000000 --- a/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/sidebar.handlebars +++ /dev/null @@ -1,27 +0,0 @@ -<div id="api-list"> - <h2 class="off-left">APIs</h2> - <div id="api-tabview" class="tabview"> - <ul class="tabs"> - <li><a href="#api-categories">By Category</a></li> - <li><a href="#api-connections">By Connection Type</a></li> - </ul> - - <div id="api-tabview-filter"> - <input type="search" id="api-filter" placeholder="Type to filter APIs" hidden> - </div> - - <div id="api-tabview-panel"> - <ul id="api-categories" class="apis modules"> - {{{listByCategory}}} - </ul> - - <ul id="api-connections" class="apis modules"> - {{{listByConnection}}} - </ul> - - </div> - </div> - - {{{javascripts}}} - -</div>
\ No newline at end of file diff --git a/peripheral/libupm/doxy/node/grammars/xml.peg b/peripheral/libupm/doxy/node/grammars/xml.peg deleted file mode 100644 index bca96d5..0000000 --- a/peripheral/libupm/doxy/node/grammars/xml.peg +++ /dev/null @@ -1,45 +0,0 @@ -document - = _ ignore* _ "<doxygen " _ attr:attr* _ ">" body:elements _ "</doxygen>" _ { return body; } - - -elements - = element* - -element - = _ "<" startTag:id _ attr:attr* _ ">" _ children:elements _ "</" endTag:id ">" _ { - if (startTag != endTag) { - throw new Error("Expected </" + startTag + "> but </" + endTag + "> found."); - } - return {name: startTag, attr: attr, children: children } - } - / "<" tag:id _ attr:attr* _ "/>" _ { - return {name: tag, attr: attr } - } - / _ text:text _ { return text } - -ignore - = "<?xml" _ attr* _ "?>" { return } - -attr - = name:id _ "=" _ value:string { return { name:name, value:value } } - -string - = '"' '"' _ { return ""; } - / "'" "'" _ { return ""; } - / '"' text:quoted '"' _ { return text; } - / "'" text:quoted "'" _ { return text; } - -quoted - = chars:[^<>'" \t\n\r]+ { return chars.join(""); } - -text - = chars:[^<> \t\n\r]+ { return chars.join(""); } - -id - = chars:[^<>/'"=? \t\n\r]+ { return chars.join(""); } - -_ "whitespace" - = whitespace* - -whitespace - = [ \t\n\r] diff --git a/peripheral/libupm/doxy/node/tolower.js b/peripheral/libupm/doxy/node/tolower.js deleted file mode 100644 index c9c2421..0000000 --- a/peripheral/libupm/doxy/node/tolower.js +++ /dev/null @@ -1,125 +0,0 @@ -/* - * Author: Dina M Suehiro <dina.m.suehiro@intel.com> - * Copyright (c) 2015 Intel Corporation. - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be - * included in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -// dependencies -var opts = require('commander'), // for command line args - fs = require('fs'), // for file system access - path = require('path'); // for file path parsing - -// parse command line arguments -opts - .option('-i, --inputdir [directory]', 'product documents directory', __dirname + '/docs/yuidoc/upm') - .parse(process.argv); - -// Set to true for console output -var debug = true; - -// Global arrays tracking the files that have been renamed -var originalFiles = []; -var renamedFiles = []; - -// Filter to get html files from different directories -var rootFiles = getHtmlFilenames(opts.inputdir); -var classesFiles = getHtmlFilenames(opts.inputdir + "/classes"); -var modulesFiles = getHtmlFilenames(opts.inputdir + "/modules"); - -// Rename files in the classes directory to have lower-cased file names. -renameFiles(classesFiles); - -classesFiles = getHtmlFilenames(opts.inputdir + "/classes"); - -// Go through the html files and update links to reflect the file names that we changed. -renameLinks(rootFiles); -renameLinks(classesFiles); -renameLinks(modulesFiles); - -// Helper function that returns paths to the html files in the specified directory -function getHtmlFilenames (directory) -{ - return fs.readdirSync(directory).map(function (file) { - return path.join(directory, file); - }).filter(function (file) { - return fs.statSync(file).isFile(); - }).filter(function (file) { - return path.extname(file).toLowerCase() == ".html"; - }); -} - -// Goes through the files and renames them to be lower-cased and tracks them the -// renamed files in the originalFiles[] and renamedFiles[] arrays. -function renameFiles(files) -{ - files.forEach(function (file) - { - var originalName = path.basename(file); - var newFileName = originalName.toLowerCase(); - var directory = path.dirname(file); - if (originalName != newFileName) - { - fs.renameSync(file, directory + "/" + newFileName); //, function(err) - - if (debug) - console.log('Renamed: %s --> %s', originalName, newFileName); - - originalFiles.push(originalName); - renamedFiles.push(newFileName); - } - }); -} - -// Helper function goes through the specified files and does a file/replace of the -// originalFiles to the renamedFiles so that the .html links match what has been renamed. -function renameLinks (files) -{ - if (originalFiles.length <= 0) - { - if (debug) - console.log("No links to rename."); - return; - } - - files.forEach(function (file) - { - // Read the file - data = fs.readFileSync(file, 'ascii'); - - // Find/replace the file names that were renamed - for (var i = 0; i < originalFiles.length; i++) - { - var findString = '/' + originalFiles[i] + '\"'; - var replaceString = '/' + renamedFiles[i] + '\"'; - - data = data.replace(findString, replaceString); - } - - // Write back - fs.writeFile(file, data, 'ascii', function (err) { - if (err) - throw err; - }); - - if (debug) - console.log('Renamed links in: %s', file); - }); -} diff --git a/peripheral/libupm/doxy/node/xml2js.js b/peripheral/libupm/doxy/node/xml2js.js deleted file mode 100644 index 95af761..0000000 --- a/peripheral/libupm/doxy/node/xml2js.js +++ /dev/null @@ -1,935 +0,0 @@ -/* - * Author: Heidi Pan <heidi.pan@intel.com> - * Copyright (c) 2015 Intel Corporation. - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be - * included in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -// dependencies -var peg = require('pegjs') - , fs = require('fs') - , path = require('path') - , Promise = require('bluebird') - , _ = require('lodash') - , util = require('util'); - - -// use promise-style programming rather than spaghetti callbacks -Promise.promisifyAll(fs); - - -var xml2js = { - - // js-format specs - // MODULE: <module name> - // ENUMS: { - // <enum name>: { - // type: <enum type>, - // description: <enum description> - // }, ... - // } - // ENUMS_BY_GROUP: { - // <enum type>: { - // description: <enum group description> - // members: [ <enum name>, ... ] - // }, ... - // } - // METHODS: { - // <method name>: { - // description: <method description>, - // params: { - // <param name>: { - // type: <param type>, - // description: <param description > - // }, ... - // }, - // return: { - // type: <return type>, - // description: <return description> - // } - // }, ... - // } - // CLASSES: { - // <class name>: { - // description: <class description>, - // parent: <parent class name>, - // group: <group name>, - // methods: { ... }, - // variables: { - // <variable name>: { - // type: <variable type>, - // description: <variable description> - // } - // }, - // enums: { ... }, - // enums_by_group: { ... } - // }, ... - // } - // CLASSGROUPS: { - // <group name>: { - // description: <group description>, - // classes: [ <class name>, ... ], - // enums: { ... }, - // enums_by_group: { ... } - // }, ... - // } - MODULE: '', - ENUMS: {}, - ENUMS_BY_GROUP: {}, - METHODS: {}, - CLASSES: {}, - CLASSGROUPS: {}, - - - // baseline c -> js type mapping - TYPEMAPS: { - '^(const)?\\s*(unsigned|signed)?\\s*(int|short|long|float|double|size_t|u?int\\d{1,2}_t)?$': 'Number', - '^bool$': 'Boolean', - '^(const)?\\s*(unsigned|signed)?\\s*(char|char\\s*\\*|std::string)$': 'String', // TODO: verify that swig does this mapping - '^void\\s*\\(\\s*\\*\\s*\\)\\s*\\(\\s*void\\s*\\*\\)\\s*$': 'Function' - }, - - - // custom c -> js type mapping for pointers - // ARRAY_TYPEMAPS: { - // <pointer data type>: { - // arrayType: <swig generated array type that will replace pointers of data type>, - // classes: [ <class that contains arrayType>, ... ] - // }, ... - // } - // POINTER_TYPEMAPS: { - // <class that contains pointerType>: { - // <c pointer data type>: <js swig generated pointer type that will replace pointers of data type>, ... - // }, ... - // } - ARRAY_TYPEMAPS: {}, - POINTER_TYPEMAPS: {}, - - - // add command line options for this module - addOptions: function(opts) { - xml2js.opts = opts; - return opts - .option('-i, --inputdir [directory]', 'directory for xml files', __dirname + '/xml/mraa') - .option('-c, --custom [file]', 'json for customizations') - .option('-t, --typemaps [directory]', 'directory for custom pointer type maps') - .option('-g, --imagedir [directory]', 'directory to link to where the images will be kept', '') - .option('-s, --strict', 'leave out methods/variables if unknown type') - }, - - - // parse doxygen xml -> js-format specs - // TODO: figure out whether we need to document any protected methods/variables - parse: function() { - var XML_GRAMMAR_SPEC = 'grammars/xml.peg'; - var NAMESPACE_SPEC = xml2js.opts.inputdir + '/namespace' + xml2js.opts.module + '.xml'; - var CLASS_SPEC = function(c) { return xml2js.opts.inputdir + '/' + c + '.xml'; } - var TYPES_SPEC = xml2js.opts.inputdir + '/types_8h.xml'; - xml2js.MODULE = xml2js.opts.module; - return Promise.join(createXmlParser(XML_GRAMMAR_SPEC), - xml2js.opts.typemaps ? initCustomPointerTypemaps(xml2js.opts.typemaps) : Promise.resolve(), - fs.readFileAsync(NAMESPACE_SPEC, 'utf8'), - fs.existsSync(TYPES_SPEC) ? fs.readFileAsync(TYPES_SPEC, 'utf8') : Promise.resolve(null), - function(xmlparser, ignore, xml, xml_types) { - if (xml_types != null) { - _.extend(xml2js.ENUMS, getEnums(xmlparser.parse(xml_types)[0], false)); - _.extend(xml2js.ENUMS_BY_GROUP, getEnums(xmlparser.parse(xml_types)[0], true)); - } - var spec_c = xmlparser.parse(xml)[0]; - _.extend(xml2js.ENUMS, getEnums(spec_c, false)); - _.extend(xml2js.ENUMS_BY_GROUP, getEnums(spec_c, true)); - _.extend(xml2js.METHODS, getMethods(spec_c)); - _.each(getSubclassNames(spec_c), function(className) { xml2js.CLASSES[className] = {} }); - var parseClasses = _.map(getSubclasses(spec_c), function(c) { - return fs.readFileAsync(CLASS_SPEC(c), 'utf8').then(function(xml) { - try { - var spec_c = xmlparser.parse(xml)[0]; - var className = getName(spec_c); - _.extend(xml2js.CLASSES[className], { - description: getDescription(spec_c), - parent: getParent(spec_c, className), - enums: getEnums(spec_c, false, className), - enums_by_group: getEnums(spec_c, true, className), - variables: getVariables(spec_c, className), - methods: getMethods(spec_c, className) - }); - } catch(e) { - console.log(e.toString() + ': class ' + className + ' was not parsed correctly.'); - } - }); - }); - var parseGroups = fs.readdirAsync(xml2js.opts.inputdir).then(function(files) { - var groupxmlfiles = _.filter(files, function(fn) { - return ((path.extname(fn) == '.xml') && (path.basename(fn).search(/^group/) != -1)); - }); - return Promise.all(_.map(groupxmlfiles, function(fn) { - return fs.readFileAsync(xml2js.opts.inputdir + '/' + fn, 'utf8').then(function(xml) { - var spec_c = xmlparser.parse(xml)[0]; - if (_.isEmpty(getSubmodules(spec_c))) { - var group = getName(spec_c); - var classes = getSubclassNames(spec_c); - xml2js.CLASSGROUPS[group] = { - description: getDescription(spec_c), - classes: classes - }; - _.each(classes, function(c) { - if (_.has(xml2js.CLASSES, c)) { - xml2js.CLASSES[c].group = group; - } else { - console.log('Warning: Group ' + group + ' has unknown class ' + c); - } - }); - } - }); - })); - }); - return Promise.all(parseClasses.concat(parseGroups)); - }).then(function() { - if (!_.isEmpty(xml2js.CLASSGROUPS)) { - // try to categorize ungrouped classes, if any - var grouped = _.flatten(_.pluck(_.values(xml2js.CLASSGROUPS), 'classes')); - var ungrouped = _.difference(_.keys(xml2js.CLASSES), grouped); - _.each(ungrouped, function(c) { - _.each(findUsage(c), function(group) { - xml2js.CLASSGROUPS[group].classes.push(c); - }); - }); - grouped = _.flatten(_.pluck(_.values(xml2js.CLASSGROUPS), 'classes')); - ungrouped = _.difference(_.keys(xml2js.CLASSES), grouped); - // try to categorize ungrouped enums, if any - _.each(xml2js.ENUMS_BY_GROUP, function(enumGroupSpec, enumGroupName) { - _.each(findUsage(enumGroupName, true), function(c) { - xml2js.CLASSES[c].enums_by_group[enumGroupName] = enumGroupSpec; - _.each(enumGroupSpec.members, function(enumName) { - xml2js.CLASSES[c].enums[enumName] = xml2js.ENUMS[enumName]; - delete xml2js.ENUMS[enumName]; - }); - delete xml2js.ENUMS_BY_GROUP[enumGroupName]; - }); - }); - } - }).then(function() { - if (xml2js.opts.custom && fs.existsSync(xml2js.opts.custom)) { - return fs.readFileAsync(xml2js.opts.custom, 'utf8').then(function(custom) { - try { - customizeMethods(JSON.parse(custom)); - } catch(e) { - console.log('invalid custom.json, ignored. ' + e.toString()); - } - }); - } else { - console.log(xml2js.opts.custom ? ('Error: No such customization file exists: ' + xml2js.opts.custom) : 'No customizations given.'); - } - }).then(function() { - generateCustomPointerClasses(); - validateMethods(); - validateVars(); - return _.pick(xml2js, 'MODULE', 'ENUMS', 'ENUMS_BY_GROUP', 'METHODS', 'CLASSES', 'CLASSGROUPS'); - }); - } -}; - - -// create an xml parser -function createXmlParser(XML_GRAMMAR_SPEC) { - return fs.readFileAsync(XML_GRAMMAR_SPEC, 'utf8').then(function(xmlgrammar) { - return peg.buildParser(xmlgrammar); - }); -} - - -// configure c->js typemaps from custom swig directives -// TODO: many built in assumptions based on current upm file structures & .i customizations -function initCustomPointerTypemaps(typemapsdir) { - return fs.readdirAsync(typemapsdir).then(function(dirs) { - return Promise.all(_.map(dirs, function(dir) { - // get all js*.i directives from class-specific subdirectories, to be parsed below for %typemaps directives - return fs.readdirAsync(typemapsdir + '/' + dir).then(function(files) { - var directive = _.find(files, function(fn) { - return ((path.extname(fn) == '.i') && (path.basename(fn).search(/^js/) != -1)); - }); - var data = {}; - if (directive) { - data[dir] = typemapsdir + '/' + dir + '/' + directive; - } - return data; - }).catch(function(e) { - // get all .i directives from top level directory, and parse for %array_class directives - if (e.code == 'ENOTDIR') { - var fn = dir; - if (path.extname(fn) == '.i') { - return fs.readFileAsync(typemapsdir + '/' + fn, 'utf8').then(function(directives) { - var arraytypes = _.filter(directives.split(/\n/), function(line) { - return (line.search(/^%array_class/) != -1); - }); - _.each(arraytypes, function(arraytype) { - var parsed = arraytype.match(/%array_class\(([A-Za-z0-9_]+)[\s]*,[\s]*([A-Za-z0-9_]+)\)/); - if (parsed) { - var from = parsed[1]; - var to = parsed[2]; - xml2js.ARRAY_TYPEMAPS[from] = { arrayType: to, classes: [] }; - } else { - console.log('Incorrectly parsed array_class from ' + fn + ': ' + arraytype); - } - }); - }); - } - } else { - throw e; - } - }); - })); - }).then(function(__directivesFiles) { - // parse for %typemaps & %pointer_functions directives - var _directivesFiles = _.filter(__directivesFiles, function(data) { return !_.isEmpty(data); }); - var directivesFiles = _.object(_.map(_directivesFiles, _.keys), _.flatten(_.map(_directivesFiles, _.values))); - return Promise.all(_.map(directivesFiles, function(directivesFn, className) { - return fs.readFileAsync(directivesFn, 'utf8').then(function(directives) { - var typemaps = _.filter(directives.split(/\n/), function(line) { - return (line.search(/^%typemap/) != -1); - }); - _.each(typemaps, function(typemap) { - var parsed = typemap.match(/%typemap\((in|out)\)[\s]+([A-Za-z0-9_]+[\s]*[\*])/); - if (parsed) { - var dir = parsed[1]; // TODO: ignored for now - var type = normalizePointer(parsed[2]); - var datatype = getPointerDataType(type); - if (_.has(xml2js.ARRAY_TYPEMAPS, datatype)) { - xml2js.ARRAY_TYPEMAPS[datatype].classes.push(className); - } else { - console.log('Ignored typemap from ' + directivesFn + ': ' + typemap.replace('{', '') + ' (no %array_class directive found for ' + datatype + ')'); - } - } else { - console.log('Ignored typemap from ' + directivesFn + ': ' + typemap.replace('{', '') + ' (only considering in/out typemaps of pointer types)'); - } - }); - var ptrfns = _.filter(directives.split(/\n/), function(line) { - return (line.search(/^%pointer_functions/) != -1); - }); - _.each(ptrfns, function(ptrfn) { - var parsed = ptrfn.match(/%pointer_functions\(([A-Za-z0-9_]+)[\s]*,[\s]*([A-Za-z0-9_]+)\)/); - if (parsed) { - var from = parsed[1]; - var to = parsed[2]; - if (!_.has(xml2js.POINTER_TYPEMAPS, className)) { - xml2js.POINTER_TYPEMAPS[className] = {}; - } - xml2js.POINTER_TYPEMAPS[className][from] = to; - } - }); - }); - })); - }); -} - - -// generate class specs for custom pointer types -function generateCustomPointerClasses() { - var arrayTypes = _.pluck(_.values(xml2js.ARRAY_TYPEMAPS), 'arrayType'); - var pointerTypes = _.uniq(_.flatten(_.map(_.values(xml2js.POINTER_TYPEMAPS), _.values))); - _.each(arrayTypes, function(arrayType) { - var dataType = _.findKey(xml2js.ARRAY_TYPEMAPS, function(to) { return to.arrayType == arrayType; }); - xml2js.CLASSES[arrayType] = { - description: 'Array of type ' + dataType + '.', - enums: {}, - enums_by_group: {}, - variables: {}, - methods: {} - }; - xml2js.CLASSES[arrayType].methods[arrayType] = { - description: 'Instantiates the array.', - params: { - nelements: { - type: 'Number', - description: 'number of elements in the array' - } - }, - return: {} - }; - xml2js.CLASSES[arrayType].methods.getitem = { - description: 'Access a particular element in the array.', - params: { - index: { - type: 'Number', - description: 'index of array to read from' - }, - }, - return: { - type: getType(dataType), - description: 'the value of the element found at the given index of the array' - } - }; - xml2js.CLASSES[arrayType].methods.setitem = { - description: 'Modify a particular element in the array.', - params: { - index: { - type: 'Number', - description: 'index of array to write to' - }, - value: { - type: getType(dataType), - description: 'the value to set the element found at the given index of the array' - } - }, - return: {} - }; - }); - var pointerDataTypeMap = _.reduce(_.map(_.values(xml2js.POINTER_TYPEMAPS), _.invert), function(memo, typemap) { - return _.extend(memo, typemap); - }, {}); - _.each(pointerTypes, function(pointerType) { - var dataType = pointerDataTypeMap[pointerType]; - xml2js.CLASSES[pointerType] = { - description: 'Proxy object to data of type ' + dataType + '.', - enums: {}, - enums_by_group: {}, - variables: {}, - methods: {} - }; - xml2js.CLASSES[pointerType].methods[pointerType] = { - description: 'Instantiates the proxy object.', - params: {}, - return: {} - }; - xml2js.CLASSES[pointerType].methods.value = { - description: 'Get the value of the object.', - params: {}, - return: { - type: getType(dataType), - description: 'the value of the object' - } - }; - xml2js.CLASSES[pointerType].methods.assign = { - description: 'Set the value of the object.', - params: { - value: { - type: getType(dataType), - description: 'the value to set the object to' - } - }, - return: {} - }; - }); -} - - -// search for usage of a type -function findUsage(type, classOnly) { - var filterClasses = function(fn) { return _.without(_.map(xml2js.CLASSES, fn), undefined); }; - var usesType = function(classSpec, className) { - var methodsOfType = (_.find(classSpec.methods, function(methodSpec, methodName) { - return ((!_.isEmpty(methodSpec.return) && methodSpec.return.type == type) || - (_.contains(_.pluck(methodSpec.params, 'type'), type))); - }) != undefined); - var variablesOfType = _.contains(_.pluck(classSpec.variable, 'type'), type); - return ((methodsOfType || variablesOfType) ? className : undefined); - }; - var extendsType = function(classSpec, className) { - return ((classSpec.parent == type) ? className : undefined); - }; - var classes = _.union(filterClasses(usesType), filterClasses(extendsType)); - if (classOnly) { - return classes; - } else { - return _.without(_.uniq(_.pluck(_.pick(xml2js.CLASSES, classes), 'group')), undefined); - } -} - - -// override autogenerated methods with custom configuration -function customizeMethods(custom) { - _.each(custom, function(classMethods, className) { - _.extend(xml2js.CLASSES[className].methods, _.pick(classMethods, function(methodSpec, methodName) { - return isValidMethodSpec(methodSpec, className + '.' + methodName); - })); - }); -} - - -// make sure methods have valid types, otherwise warn (& don't include if strict) -function validateMethods() { - xml2js.METHODS = _.pick(xml2js.METHODS, function(methodSpec, methodName) { - return hasValidTypes(methodSpec, methodName); - }); - _.each(xml2js.CLASSES, function(classSpec, className) { - var valid = _.pick(classSpec.methods, function(methodSpec, methodName) { - return hasValidTypes(methodSpec, className + '.' + methodName, className); - }); - if (xml2js.opts.strict) { - xml2js.CLASSES[className].methods = valid; - } - }); -} - - -// make sure variables have valid types, otherwise warn (& don't include if strict) -function validateVars() { - _.each(xml2js.CLASSES, function(classSpec, className) { - var valid = _.pick(classSpec.variables, function(varSpec, varName) { - return ofValidType(varSpec, className + '.' + varName, className); - }); - if (xml2js.opts.strict) { - xml2js.CLASSES[className].variables = valid; - } - }); -} - - -// verify that the json spec is well formatted -function isValidMethodSpec(methodSpec, methodName) { - var valid = true; - var printIgnoredMethodOnce = _.once(function() { console.log(methodName + ' from ' + path.basename(xml2js.opts.custom) + ' is omitted from JS documentation.'); }); - function checkRule(rule, errMsg) { - if (!rule) { - printIgnoredMethodOnce(); - console.log(' ' + errMsg); - valid = false; - } - } - checkRule(_.has(methodSpec, 'description'), 'no description given'); - checkRule(_.has(methodSpec, 'params'), 'no params given (specify "params": {} for no params)'); - _.each(methodSpec.params, function(paramSpec, paramName) { - checkRule(_.has(paramSpec, 'type'), 'no type given for param ' + paramName); - checkRule(_.has(paramSpec, 'description'), 'no description given for param ' + paramName); - }); - checkRule(_.has(methodSpec, 'return'), 'no return given (specify "return": {} for no return value)'); - checkRule(_.has(methodSpec.return, 'type'), 'no type given for return value'); - checkRule(_.has(methodSpec.return, 'description'), 'no description given for return value'); - return valid; -} - - -// get enum specifications -function getEnums(spec_c, bygroup, parent) { - var spec_js = {}; - var enumGroups = _.find(getChildren(spec_c, 'sectiondef'), function(section) { - var kind = getAttr(section, 'kind'); - return ((kind == 'enum') || (kind == 'public-type')); - }); - if (enumGroups) { - _.each(enumGroups.children, function(enumGroup) { - var enumGroupName = getText(getChild(enumGroup, 'name'), 'name'); - var enumGroupDescription = getText(getChild(enumGroup, 'detaileddescription'), 'description'); - var enumGroupVals = getChildren(enumGroup, 'enumvalue'); - if (bygroup) { - spec_js[enumGroupName] = { - description: enumGroupDescription, - members: [] - }; - } - _.each(enumGroupVals, function(e) { - // TODO: get prefix as option - var enumName = getText(getChild(e, 'name'), 'name').replace(/^MRAA_/, ''); - var enumDescription = getText(getChild(e, 'detaileddescription'), 'description'); - if (!bygroup) { - spec_js[enumName] = { - type: enumGroupName, - description: enumDescription - }; - } else { - spec_js[enumGroupName].members.push(enumName); - } - }); - }); - } - return spec_js; -} - - -// get the name for the module/group/class -function getName(spec_c) { - return getText(getChild(spec_c, 'compoundname'), 'name').replace(xml2js.opts.module + '::', ''); -} - - -// get the description for the module/group/class -function getDescription(spec_c) { - return getText(getChild(spec_c, 'detaileddescription'), 'description'); -} - - -// get the classes (xml file names) for the given module -function getSubclasses(spec_c) { - return _.map(getChildren(spec_c, 'innerclass'), function(innerclass) { - return getAttr(innerclass, 'refid'); - }); -} - - -// get the classes (class names) for the given module -function getSubclassNames(spec_c) { - return _.map(getChildren(spec_c, 'innerclass'), function(innerclass) { - return getText(innerclass).replace(xml2js.opts.module + '::', ''); - }); -} - - -// get the submodules (xml file names) for the given module -function getSubmodules(spec_c) { - return _.map(getChildren(spec_c, 'innergroup'), function(innergroup) { - return getAttr(innergroup, 'refid'); - }); -} - - -// get parent class, if any -function getParent(spec_c, className) { - var parent = getChild(spec_c, 'basecompoundref'); - if (parent) { - parent = getText(parent); - if (!_.has(xml2js.CLASSES, parent)) { - console.log('WARNING: Class ' + className + ' has unknown parent class ' + parent); - } - } - return parent; -} - - -function hasParams(paramsSpec) { - return !(_.isEmpty(paramsSpec) || - ((_.size(paramsSpec) == 1) && getText(getChild(paramsSpec[0], 'type')) == 'void')); -} - - -// get method specifications for top-level module or a given class -// TODO: overloaded functions -// TODO: functions w/ invalid parameter(s)/return -function getMethods(spec_c, parent) { - var spec_js = {}; - var methods = _.find(getChildren(spec_c, 'sectiondef'), function(section) { - var kind = getAttr(section, 'kind'); - return ((kind == 'public-func') || (kind == 'func')); - }); - if (methods) { - _.each(methods.children, function(method) { - var methodName = getText(getChild(method, 'name'), 'name'); - if (methodName[0] != '~') { // filter out destructors - try { - var description = getChild(method, 'detaileddescription'); - var methodDescription = getText(description, 'description'); - var paramsSpec = getChildren(method, 'param'); - var params = {}; - if (hasParams(paramsSpec)) { - params = getParams(paramsSpec, getParamsDetails(description), methodName, parent); - } - var returnSpec = getChild(method, 'type'); - var retval = {}; - if (!_.isEmpty(returnSpec)) { - retval = getReturn(returnSpec, getReturnDetails(description), methodName, parent); - } - methodName = getUniqueMethodName(methodName, spec_js, parent); - spec_js[methodName] = { - description: methodDescription, - params: params, - return: retval - }; - } catch(e) { - console.log((parent ? (parent + '.') : '') + methodName + ' is omitted from JS documentation.'); - console.log(' ' + e.toString()); - } - } - }); - } - return spec_js; -} - - -// get a unique string to represent the name of an overloaded method -function getUniqueMethodName(methodName, module, parent) { - if (methodName in module) { - do { - methodName += '!'; - } while (methodName in module); - } - return methodName; -} - - -// get variable specifications for a class -function getVariables(spec_c, parent) { - var spec_js = {}; - var vars = _.find(getChildren(spec_c, 'sectiondef'), function(section) { - var kind = getAttr(section, 'kind'); - return (kind == 'public-attrib'); - }); - if (vars) { - _.each(_.filter(vars.children, function(variable) { - return (getAttr(variable, 'kind') == 'variable'); - }), function(variable) { - var varName = getText(getChild(variable, 'name'), 'name'); - var varType = getType(getText(getChild(variable, 'type')), parent); - var varDescription = getText(getChild(variable, 'detaileddescription')); - spec_js[varName] = { - type: varType, - description: varDescription - } - }); - } - return spec_js; -} - - -// get return value specs of a method -function getReturn(spec_c, details, method, parent) { - var retType = getType(getText(spec_c, 'type'), parent); - var retDescription = (details ? getText(details, 'description') : ''); - return ((retType == 'void') ? {} : { - type: retType, - description: retDescription - }); -} - - -// get paramater specs of a method -function getParams(spec_c, details, method, parent) { - var spec_js = {}; - _.each(spec_c, function(param) { - try { - var paramType = getType(getText(getChild(param, 'type'), 'type'), parent); - var paramName = getText(getChild(param, 'declname'), 'name'); - spec_js[paramName] = { type: paramType }; - } catch(e) { - if (paramType == '...') { - spec_js['arguments'] = { type: paramType }; - } else { - throw e; - } - } - }); - _.each(details, function(param) { - var getParamName = function(p) { return getText(getChild(getChild(p, 'parameternamelist'), 'parametername'), 'name'); } - var paramName = getParamName(param); - var paramDescription = getText(getChild(param, 'parameterdescription'), 'description'); - if (_.has(spec_js, paramName)) { - spec_js[paramName].description = paramDescription; - } else { - var msg = ' has documentation for an unknown parameter: ' + paramName + '. '; - var suggestions = _.difference(_.keys(spec_js), _.map(details, getParamName)); - var msgAddendum = (!_.isEmpty(suggestions) ? ('Did you mean ' + suggestions.join(', or ') + '?') : ''); - console.log('Warning: ' + (parent ? (parent + '.') : '') + method + msg + msgAddendum); - } - }); - return spec_js; -} - - -// get the equivalent javascript type from the given c type -function getType(type_c, parent) { - var type_js = type_c; - _.find(xml2js.TYPEMAPS, function(to, from) { - var pattern = new RegExp(from, 'i'); - if (type_c.search(pattern) == 0) { - type_js = to; - return true; - } - }); - if (isPointer(type_js)) { - var dataType = getPointerDataType(type_js); - var className = parent.toLowerCase(); - if (_.has(xml2js.ARRAY_TYPEMAPS, dataType) && _.contains(xml2js.ARRAY_TYPEMAPS[dataType].classes, className)) { - type_js = xml2js.ARRAY_TYPEMAPS[dataType].arrayType; - } else if (_.has(xml2js.POINTER_TYPEMAPS, className) && _.has(xml2js.POINTER_TYPEMAPS[className], dataType)) { - type_js = xml2js.POINTER_TYPEMAPS[className][dataType]; - } else if (_.has(xml2js.CLASSES, dataType)) { // TODO: verify that swig does this mapping - type_js = dataType; - } else { - type_js = dataType + ' *' - } - } - return type_js; -} - - -// verify that all types associated with the method are valid -function hasValidTypes(methodSpec, methodName, parent) { - var valid = true; - var msg = (xml2js.opts.strict ? ' is omitted from JS documentation.' : ' has invalid type(s).'); - var printIgnoredMethodOnce = _.once(function() { console.log(methodName + msg); }); - _.each(methodSpec.params, function(paramSpec, paramName) { - if (!isValidType(paramSpec.type, parent)) { - valid = false; - printIgnoredMethodOnce(); - console.log(' Error: parameter ' + paramName + ' has invalid type ' + typeToString(paramSpec.type)); - } - }); - if (!_.isEmpty(methodSpec.return) && !isValidType(methodSpec.return.type, parent)) { - valid = false; - printIgnoredMethodOnce(); - console.log(' Error: returns invalid type ' + typeToString(methodSpec.return.type)); - } - return valid; -} - - -// verify that type of variable is valid -function ofValidType(varSpec, varName, parent) { - if (isValidType(varSpec.type, parent)) { - return true; - } else { - var msgAddendum = (xml2js.opts.strict ? ' Omitted from JS documentation.' : ''); - console.log('Error: ' + varName + ' is of invalid type ' + typeToString(varSpec.type) + '.' + msgAddendum); - return false; - } -} - - -// verify whether the given type is valid JS -function isValidType(type, parent) { - return (_.contains(_.values(xml2js.TYPEMAPS), type) || - _.has(xml2js.CLASSES, type) || - _.has(xml2js.ENUMS_BY_GROUP, type) || - _.contains(['Buffer', 'Function', 'mraa_result_t'], type) || - _.has((parent ? xml2js.CLASSES[parent].enums_by_group : []), type) || - isValidPointerType(type, parent)); -} - - -function isValidPointerType(type, parent) { - var className = parent.toLowerCase(); - var arrayTypemap = _.find(xml2js.ARRAY_TYPEMAPS, function(to) { return to.arrayType == type; }); - var valid = ((arrayTypemap && _.contains(arrayTypemap.classes, className)) || - (_.has(xml2js.POINTER_TYPEMAPS, className) && (_.contains(_.values(xml2js.POINTER_TYPEMAPS[className]), type)))); - return valid; -} - - -// determines whether a type looks like a c pointer -function isPointer(type) { - return (type.search(/\w+\s*(\*|&)$/) != -1); -} - - -// remove extraneous whitespace from pointer types as canonical representation -function normalizePointer(ptr) { - return ptr.replace(/\s*$/, ''); -} - - -// get the data type of a pointer (e.g. int is the data type of int*) -function getPointerDataType(ptr) { - return ptr.replace(/\s*(\*|&)$/, ''); -} - - -// print more human friendly type for error messages -function typeToString(type) { - return type.replace('*', '*'); -} - - -// get the detailed description of a method's parameters -function getParamsDetails(spec_c) { - var paras = getChildren(spec_c, 'para'); - var details = _.find(_.map(paras, function(para) { - return getChild(para, 'parameterlist'); - }), function(obj) { return (obj != undefined); }); - return (details ? details.children : undefined); -} - - -// get the detailed description of a method's return value -function getReturnDetails(spec_c) { - var paras = getChildren(spec_c, 'para'); - return _.find(_.map(paras, function(para) { - return getChild(para, 'simplesect'); - }), function(obj) { return ((obj != undefined) && (getAttr(obj, 'kind') == 'return')); }); -} - - -// get (and flatten) the text of the given object -function getText(obj, why) { - // TODO: links ignored for now, patched for types for - var GENERATE_LINK = function(x) { return x + ' '; } - return _.reduce(obj.children, function(text, elem) { - if (_.isString(elem)) { - return text += elem.trim() + ' '; - } else if (_.isPlainObject(elem)) { - switch(elem.name) { - case 'para': - return text += getText(elem, why) + ' \n'; - case 'ref': - return text += GENERATE_LINK(getText(elem, why)); - case 'parameterlist': - case 'simplesect': - return text; // to be handled elsewhere - case 'programlisting': - case 'htmlonly': - return text; // ignored - // TODO: html doesn't seem to work for yuidoc, using markdown for now - case 'itemizedlist': - return text += '\n' + getText(elem, why) + ' \n \n'; - case 'listitem': - return text += '+ ' + getText(elem, why) + '\n'; - case 'bold': - return text += '__' + getText(elem, why).trim() + '__ '; - case 'ulink': - return text += '[' + getText(elem, why).trim() + '](' + getAttr(elem, 'url').trim() + ') '; - case 'image': - // TODO: copy images over; hard coded for now - var fn = getAttr(elem, 'name'); - return text += ' \n \n '; - case 'linebreak': - return text += ' \n'; - case 'ndash': - return text += '– '; - default: - // TODO: incomplete list of doxygen xsd implemented - console.warn('NYI Unknown Object Type: ' + elem.name); - return text; - //throw new Error('NYI Unknown Object Type: ' + elem.name); - } - } else { - throw new Error('NYI Unknown Type: ' + (typeof elem)); - } - }, '').trim(); -} - - -// get the value of attribute with the given name of the given object -function getAttr(obj, name) { - return _.find(obj.attr, function(item) { - return item.name == name; - }).value; -} - - -// get the child object with the given name of the given object -function getChild(obj, name) { - return _.find(obj.children, function(child) { - return child.name == name; - }); -} - - -// get all children objects with the given name of the given object -function getChildren(obj, name) { - return _.filter(obj.children, function(child) { - return child.name == name; - }); -} - - -// debug helper: print untruncated object -function printObj(obj) { - console.log(util.inspect(obj, false, null)); -} - - -module.exports = xml2js;
\ No newline at end of file diff --git a/peripheral/libupm/doxy/samples.mapping.txt b/peripheral/libupm/doxy/samples.mapping.txt deleted file mode 100644 index db7c4c7..0000000 --- a/peripheral/libupm/doxy/samples.mapping.txt +++ /dev/null @@ -1,73 +0,0 @@ -# Mapping C++ sample files to Java sample files -a110x-intr.cxx A110X_intrSample.java -a110x.cxx A110XSample.java -adc121c021.cxx ADC121C021Sample.java -adxl345.cxx Adxl345Sample.java -biss0001.cxx BISS0001Sample.java -bmpx8x.cxx BMPX8XSample.java -buzzer-sound.cxx Buzzer_soundSample.java -cjq4435.cxx CJQ4435Sample.java -ds1307.cxx DS1307Sample.java -enc03r.cxx ENC03RSample.java -es08a.cxx ES08ASample.java -grovebutton.cxx GroveButtonSample.java -groveehr.cxx GroveEHRSample.java -groveled.cxx GroveLEDSample.java -grovelinefinder.cxx GroveLineFinderSample.java -grovelight.cxx GroveLightSample.java -grovemoisture.cxx GroveMoistureSample.java -groverelay.cxx GroveRelaySample.java -groverotary.cxx GroveRotarySample.java -grovescam.cxx GROVESCAMSample.java -groveslide.cxx GroveSlideSample.java -grovespeaker.cxx GroveSpeakerSample.java -grovevdiv.cxx GroveVDivSample.java -grovewater.cxx GroveWaterSample.java -grovewfs.cxx GroveWFSSample.java -guvas12d.cxx GUVAS12DSample.java -h3lis331dl.cxx H3LIS331DLSample.java -hcsr04.cxx HCSR04Sample.java -hm11.cxx HM11Sample.java -hmc5883l.cxx Hmc5883lSample.java -htu21d.cxx HTU21DSample.java -itg3200.cxx Itg3200Sample.java -jhd1313m1-lcd.cxx Jhd1313m1_lcdSample.java -joystick12.cxx Joystick12Sample.java -lcm1602-i2c.cxx Lcm1602_i2cSample.java -ldt0028.cxx LDT0028Sample.java -lol.cxx LoLSample.java -lsm303.cxx LSM303Sample.java -m24lr64e.cxx M24LR64ESample.java -max44000.cxx MAX44000Sample.java -mic.cxx MicrophoneSample.java -mma7455.cxx MMA7455Sample.java -mma7660.cxx MMA7660Sample.java -mpl3115a2.cxx MPL3115A2Sample.java -mpr121.cxx MPR121Sample.java -mpu9150.cxx MPU9150Sample.java -mq2.cxx MQ2Sample.java -mq303a.cxx MQ303ASample.java -mq5.cxx MQ5Sample.java -my9221-ledbar.cxx MY9221_ledbarSample.java -nrf24l01-receiver.cxx NRF24L01_receiverSample.java -nrf24l01-transmitter.cxx NRF24L01_transmitterSample.java -nunchuck.cxx NUNCHUCKSample.java -otp538u.cxx OTP538USample.java -ppd42ns.cxx PPD42NSSample.java -pulsensor.cxx PulsensorSample.java -rfr359f.cxx RFR359FSample.java -rotaryencoder.cxx RotaryEncoderSample.java -rpr220-intr.cxx RPR220_intrSample.java -rpr220.cxx RPR220Sample.java -ssd1308-oled.cxx SSD1308_oledSample.java -ssd1327-oled.cxx SSD1327_oledSample.java -st7735.cxx ST7735Sample.java -stepmotor.cxx StepMotorSample.java -tm1637.cxx TM1637Sample.java -tp401.cxx TP401Sample.java -tsl2561.cxx TSL2561Sample.java -ttp223.cxx TTP223Sample.java -ublox6.cxx Ublox6Sample.java -uln200xa.cxx ULN200XASample.java -wt5001.cxx WT5001Sample.java -yg1006.cxx YG1006Sample.java |