This PR removes 3 old projects from `contrib` that are no more used nor interesting:
* `neo_doxygen`
* `refund`
* `wiringPi`
222 files and 25k LOC less :D
Pull-Request: #2764
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-NITC ?= nitc
-NITLS ?= nitls
-NITUNIT ?= nitunit
-NITDOC ?= nitdoc
-
-NEO4J_DIR=/var/lib/neo4j
-OLD_PWD=${PWD}
-
-.PHONY: all
-all: bin/neo_doxygen
-
-bin/neo_doxygen: $(shell $(NITLS) -M src/neo_doxygen.nit)
- mkdir -p bin/
- $(NITC) src/neo_doxygen.nit -o bin/neo_doxygen
-
-.PHONY: check
-check:
- $(NITUNIT) .
-
-# Reset the local graph.
-.PHONY: reset-neo
-reset-neo:
- sudo -u neo4j "${NEO4J_DIR}/bin/neo4j" stop \
- && sudo -u neo4j rm -rf "${NEO4J_DIR}/data/graph.db" \
- && sudo -u neo4j "${NEO4J_DIR}/bin/neo4j" start
-
-# Regenerate the XML documents in `tests`.
-.PHONY: tests
-tests:
- $(MAKE) -C tests
-
-# Run the tests.
-.PHONY: run-tests
-run-tests:
- cd ../../tests; \
- ./tests.sh ../contrib/neo_doxygen/src/tests/neo_doxygen_*.nit ; \
- cd "${OLD_PWD}"
-
-.PHONY: doc
-doc:
- $(NITDOC) . -o doc/
-
-.PHONY: clean
-clean:
- rm -rf bin/
- rm -rf doc/
+++ /dev/null
-# neo_doxygen
-
-This project provides a tool to convert a Doxygen XML output into a model in
-Neo4j that is readable by the `nx` tool.
-
-
-## Installation
-
-Ensure that you have a working version of `nitc` in `../../bin` then run `make`
-in the present directory. The executable will be then generated at
-`bin/neo_doxygen`.
-
-
-## Usage
-
-Here is the procedure to generate an HTML documentation of a project using the
-formatting of Nitdoc:
-
-1. First run Doxygen to generate an XML output of the documentation. In order to do
-this, you have to enable the `GENERATE_XML` option. Note that you can disable
-the `XML_PROGRAMLISTING` to speed up the process and save disk space.
-
- <strong>Important</strong>
-
- `neo_doxygen` do not read the `index.xml` file to know which file to load. As a
- result, it may read files let by previous runs of Doxygen. To avoid producing
- garbage, always clear the destination directory of the XML files before running
- Doxygen.
-
- Example: `rm -rf doxygen/xml && doxygen Doxyfile`
-
-2. Use `bin/neo_doxygen` to generate the Neo4j graph. For details, run
-`bin/neo_doxygen --help`.
-
- <strong>Important</strong>
-
- `neo_doxygen` do not remove what is already in the graph. So, you have to
- manualy clear the graph (or at least, the subgraph contaning all the nodes
- labelled with the specified project name) between each run.
-
- For an example of how to delete an entire Neo4j database, see
- `make reset-neo`.
-
- Example: `make reset-neo && neo_doxygen my_project doxygen/xml`
-
-3. Use the `nx` tool to generate the HTML documentation from the previously
-generated graph.
-
- Note: `nx` need to be configured before usage. For more details, refer to
- the documentation of `nx`.
-
- Example: `nx neo doc my_project`
-
-
-## Shell scripts
-
-The two shell scripts (`gen-one.sh` and `gen-all.sh`) are provided to automate
-the execution of `neo_doxygen` and `nx` for some typical cases and to give a
-starting for the development of similar scripts. In order for them to work,
-each project on which they operate **must** contain the following files:
-
- * The `.nx_config` configuration file for the `nx` tool, located at the root
- of the project.
-
- * The XML documents generated by Doxygen, located in the `doxygen/xml`
- directory.
-
-Also, they **must** be run with the current working directory set to the present
-directory. `gen-one.sh` handle only one project at a time while `gen-all.sh`
-works on a collection of projects grouped in a directory. For detail about how
-to invoke each script, see the comments in these scripts.
-
-
-## Brief descriptions
-
-To populate the first line of a description (used as brief description in
-Nitdoc), `neo_doxygen` uses the brief description provided by Doxygen. So, you
-may need to change settings like `JAVADOC_AUTOBRIEF`, `QT_AUTOBRIEF` and
-`MULTILINE_CPP_IS_BRIEF` in Doxygen to make `neo_doxygen` properly split the
-brief description from the detailed description. In absence of brief
-description, `neo_doxygen` will use the first block (usually, the first
-paragraph) of the detailed as brief description.
-
-
-## Python
-
-The built-in filter of Doxygen for Python is very basic. For example, it
-recognizes anything in the “docstrings” as verbatim detailed description. In
-order to enhance the processing of the Python scripts, the
-[doxypypy](https://github.com/Feneric/doxypypy) filter may be used.
+++ /dev/null
-#! /bin/bash
-
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# ./gen-all.sh <source_language> <directory>
-#
-# Document all projects in the specified directory.
-#
-# Projects are direct sub-directories of the specified directory.
-# Every project directory must contain a `.nx_config` file.
-# Also, every project must include the Doxygen XML output in its `doxygen/xml`
-# directory.
-
-for dir in "$2"/*; do
- if [ -d "$dir" ]; then
- if [ -f "$dir/.nx_config" ]; then
- # Note: gen-one.sh already prints errors.
- ./gen-one.sh "$1" "$dir" || exit
- fi
- fi
-done
+++ /dev/null
-#! /bin/bash
-
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# ./gen-one.sh <source_language> <directory>
-#
-# Document the project in the specified directory.
-#
-# The project name is the basename of the specified directory.
-# The project directory must contain a `.nx_config` file.
-# Also, the directory must include the Doxygen XML output in its `doxygen/xml`
-# subdirectory.
-
-NEO_DOXYGEN="${PWD}/bin/neo_doxygen"
-NX="${PWD}/../../bin/nx"
-dir=$2
-
-. sh-lib/errors.sh
-
-echo "$0: Documenting \"${dir##*/}\"..."
-pushd "$dir"
-try "$NEO_DOXYGEN" --src-lang "$1" --dest http://localhost:7474 -- "${dir##*/}" "$dir/doxygen/xml"
-try echo "$0: [done] neo_doxygen"
-try "$NX" neo doc "${dir##*/}"
-try echo "$0: [done] nx"
-popd
+++ /dev/null
-[package]
-name=neo_doxygen
-tags=devel,cli
-maintainer=Jean-Christophe Beaupré <jcbrinfo@users.noreply.github.com>
-license=Apache-2.0
-desc=neo_doxygen, a tool to convert a Doxygen XML output into a Neo4j model
-[upstream]
-browse=https://github.com/nitlang/nit/tree/master/contrib/neo_doxygen/
-git=https://github.com/nitlang/nit.git
-git.directory=contrib/neo_doxygen/
-homepage=http://nitlanguage.org
-issues=https://github.com/nitlang/nit/issues
+++ /dev/null
-Libraries used by shell scripts.
+++ /dev/null
-#! /bin/bash
-
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Error handling.
-
-# The program’s name.
-prog_name=$0
-
-# Run the specified command and exit in case of error.
-function try {
- "$@"
- local status=$?
- if [ $status -ne 0 ]; then
- >&2 echo "${prog_name}: Error: \`$1\` failed with exit status ${status}."
- trace
- exit "$status"
- fi
- return 0
-}
-
-# Print the stack trace.
-function trace {
- local frame=0
- >&2 caller $frame
- local has_next=$?
- while [ $has_next = 0 ]; do
- ((frame++));
- >&2 caller $frame
- has_next=$?
- done
- >&2 echo "---"
- return 0
-}
+++ /dev/null
-#! /bin/sh
-
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Functions related to the `sed` utility.
-
-# Replace `$1` by `$2` in the specified files (the rest of the arguments).
-#
-# Replacements are done in place.
-#
-# SETS: `local_1`
-# SETS: `local_2`
-replace() {
- local_1=`escape_to_bre "$1"`
- local_2=`escape_to_bre "$2"`
- shift 2
- sed -s -i -e s."${local_1}"."${local_2}".g -- "$@"
- unset local_1
- unset local_2
-}
-
-# Escape `$1` for inclusion in a POSIX BRE.
-escape_to_bre() {
- echo "$1" | sed -e 's/\*\|\.\|\^\|\$\|\[\|\\/\\\0/g'
-}
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# `compounddef` element reading.
-module doxml::compounddef
-
-import memberdef
-import doxyname
-import more_collections
-
-# Processes the content of a `compounddef` element.
-class CompoundDefListener
- super EntityDefListener
-
- # The defined compound.
- var compound: Compound is writable, noinit
-
- private var memberdef: MemberDefListener is noinit
- private var param_listener: TypeParamListener is noinit
-
- # Default attributes for members in the current section.
- private var member_defaults: MemberDefaults is noinit
-
- # For each section kind, default attributes for member in that section.
- private var section_kinds: DefaultMap[String, MemberDefaults] is noinit
-
-
- # Attributes of the current `<basecompoundref>` element.
-
- private var refid = ""
- private var prot = ""
- private var virt = ""
-
-
- init do
- super
- var defaults = new MemberDefaults("public", false, false)
-
- memberdef = new MemberDefListener(reader, self)
- param_listener = new TypeParamListener(reader, self)
-
- member_defaults = defaults
- section_kinds = new DefaultMap[String, MemberDefaults](defaults)
-
- # public
- section_kinds["public-type"] = defaults
- section_kinds["public-func"] = defaults
- section_kinds["public-attrib"] = defaults
- section_kinds["public-slot"] = defaults
- # public static
- defaults = new MemberDefaults("public", true, false)
- section_kinds["public-static-func"] = defaults
- section_kinds["public-static-attrib"] = defaults
- # Not scoped => public static
- section_kinds["signal"] = defaults
- section_kinds["dcop-func"] = defaults
- section_kinds["property"] = defaults
- section_kinds["event"] = defaults
- section_kinds["define"] = defaults
- section_kinds["typedef"] = defaults
- section_kinds["enum"] = defaults
- section_kinds["func"] = defaults
- section_kinds["var"] = defaults
-
- # protected
- defaults = new MemberDefaults("protected", false, false)
- section_kinds["protected-type"] = defaults
- section_kinds["protected-func"] = defaults
- section_kinds["protected-attrib"] = defaults
- section_kinds["protected-slot"] = defaults
- # protected static
- defaults = new MemberDefaults("protected", true, false)
- section_kinds["protected-static-func"] = defaults
- section_kinds["protected-static-attrib"] = defaults
-
- # package
- defaults = new MemberDefaults("package", false, false)
- section_kinds["package-type"] = defaults
- section_kinds["package-func"] = defaults
- section_kinds["package-attrib"] = defaults
- # package static
- defaults = new MemberDefaults("package", true, false)
- section_kinds["package-static-func"] = defaults
- section_kinds["package-static-attrib"] = defaults
-
- # private
- defaults = new MemberDefaults("private", false, false)
- section_kinds["private-type"] = defaults
- section_kinds["private-func"] = defaults
- section_kinds["private-attrib"] = defaults
- section_kinds["private-slot"] = defaults
- # private static
- defaults = new MemberDefaults("private", true, false)
- section_kinds["private-static-func"] = defaults
- section_kinds["private-static-attrib"] = defaults
-
- # Special sections.
- # TODO Do something these sections.
- defaults = new MemberDefaults("public", true, true)
- section_kinds["related"] = defaults
- section_kinds["user-defined"] = defaults
- # TODO Determine what `friend` and `prototype` mean.
- end
-
- redef fun entity: Entity do return compound
-
- redef fun start_dox_element(local_name: String, atts: Attributes) do
- if "compoundname" == local_name then
- text.listen_until(dox_uri, local_name)
- else if ["innerclass", "innernamespace", "basecompoundref"].has(local_name) then
- prot = get_optional(atts, "prot", "")
- text.listen_until(dox_uri, local_name)
- if "basecompoundref" == local_name then
- refid = get_optional(atts, "refid", "")
- virt = get_optional(atts, "virt", "")
- else
- refid = get_required(atts, "refid")
- end
- else if "memberdef" == local_name then
- read_member(atts)
- else if "sectiondef" == local_name then
- member_defaults = section_kinds[get_required(atts, "kind")]
- if member_defaults.is_special then
- super # TODO
- end
- else if "param" == local_name then
- param_listener.listen_until(dox_uri, local_name)
- else if "templateparamlist" != local_name then
- super
- end
- end
-
- redef fun end_dox_element(local_name: String) do
- if "compoundname" == local_name then
- compound.doxyname = text.to_s
- else if "innerclass" == local_name then
- compound.doxygen_declare_class(refid, text.to_s, prot)
- else if "innernamespace" == local_name then
- compound.declare_namespace(refid, text.to_s)
- else if "memberdef" == local_name then
- if not (memberdef.member isa UnknownMember) then
- compound.declare_member(memberdef.member)
- end
- else if "basecompoundref" == local_name then
- compound.declare_super(refid, text.to_s, prot, virt)
- else if "param" == local_name and compound isa ClassCompound then
- compound.as(ClassCompound).add_type_parameter(param_listener.parameter)
- else
- super
- end
- end
-
- private fun read_member(atts: Attributes) do
- var kind = get_required(atts, "kind")
-
- create_member(kind)
- memberdef.member.model_id = get_required(atts, "id")
- memberdef.member.visibility = get_optional(atts, "prot",
- member_defaults.visibility)
- end
-
- private fun create_member(kind: String) do
- if kind == "variable" then
- memberdef.member = new Attribute(compound.graph)
- else if kind == "function" then
- memberdef.member = new Method(compound.graph)
- else
- memberdef.member = new UnknownMember(compound.graph)
- noop.listen_until(dox_uri, "memberdef")
- return
- end
- memberdef.listen_until(dox_uri, "memberdef")
- end
-end
-
-# Default attributes for members in the current section.
-private class MemberDefaults
- var visibility: String
- var is_static: Bool
- var is_special: Bool
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Documentation reading.
-module doxml::doc_listener
-
-import listener
-import html
-
-# Processes documentation.
-class DocListener
- super TextListener
-
- # The read documentation.
- var doc = new Documentation is writable
-
- # Mapping between the type of a Doxygen element and the corresponding
- # factory.
- private var factories = new HashMap[String, HtmlElementFactory]
-
- private var element_stack = new Array[HTMLTag]
-
- # Does the next block have to be added to the detailed description?
- private var in_detailed_description = false
-
- redef fun listen_until(uri, local_name) do
- super
- if local_name == "briefdescription" then
- in_detailed_description = false
- else
- in_detailed_description = true
- end
- end
-
- redef fun start_dox_element(local_name, atts) do
- super
- var factory = factories.get_or_null(local_name)
- if factory == null then return
- element_stack.push(factory.create_element(local_name, atts))
- end
-
- redef fun end_dox_element(local_name) do
- super
- if not factories.has_key(local_name) then return
- if element_stack.is_empty then return
- var current_element = element_stack.pop
- current_element.append(flush_buffer.trim)
- if element_stack.is_empty then add_block(current_element.write_to_string)
- end
-
- redef fun end_listening do
- super
- if not element_stack.is_empty then
- var current_element = element_stack.first.write_to_string
- add_block(current_element)
- end
- add_block(flush_buffer.trim)
- element_stack.clear
- end
-
- private fun add_block(block: String) do
- if block.is_empty then return
- if in_detailed_description then
- doc.add(block)
- else
- doc.brief_description = block
- in_detailed_description = true
- end
- end
-end
-
-# Provides a mean to create a certain kind of HTML elements.
-private abstract class HtmlElementFactory
- # Create a new empty HTML element.
- #
- # Parameters:
- #
- # * `local_name`: Type of the Doxygen element that will be represented by
- # the HTML element.
- # * `attributes`: Attributes of the Doxygen element that will be
- # represented by the HTML element.
- fun create_element(local_name: String, attributes: Attributes): HTMLTag is abstract
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Doxygen’s XML documents reading.
-module doxml
-
-import compounddef
-
-# Reader for XML documents whose the schema is `compound.xsd`.
-class CompoundFileReader
- super DoxmlListener
-
- # The project graph.
- var model: ProjectGraph
-
- # The language-specific strategies to use.
- redef var source_language: SourceLanguage
-
- private var reader: XMLReader = new XophonReader
- private var compounddef: CompoundDefListener is noinit
- private var noop: NoopListener is noinit
-
- init do
- compounddef = new CompoundDefListener(reader, self)
- noop = new NoopListener(reader, self)
- end
-
- redef fun graph do return model
-
- # Read the document at the specified path.
- fun read(path: String) do
- reader.content_handler = self
- reader.parse_file(path)
- compounddef.compound = new UnknownCompound(model)
- end
-
- redef fun start_dox_element(local_name: String, atts: Attributes) do
- if local_name == "compounddef" then
- read_compound(atts)
- else if "doxygen" != local_name then
- noop.listen_until(dox_uri, local_name)
- end
- end
-
- private fun read_compound(atts: Attributes) do
- var kind = get_required(atts, "kind")
-
- create_compound(kind)
- # TODO Make all values of `kind` and `visibility` compatible with the Nit meta-model.
- if get_bool(atts, "final") then
- kind = "final {kind}"
- end
- if get_bool(atts, "sealed") then
- kind = "sealed {kind}"
- end
- if get_bool(atts, "abstract") then
- kind = "abstract {kind}"
- end
- compounddef.compound.kind = kind
- compounddef.compound.model_id = get_required(atts, "id")
- compounddef.compound.visibility = get_optional(atts, "prot", "")
- end
-
- private fun create_compound(kind: String) do
- if kind == "file" then
- compounddef.compound = new FileCompound(model)
- else if kind == "namespace" then
- compounddef.compound = new Namespace(model)
- else if kind == "class" or kind == "interface" or kind == "enum" then
- compounddef.compound = new ClassCompound(model)
- else
- compounddef.compound = new UnknownCompound(model)
- noop.listen_until(dox_uri, "compounddef")
- return
- end
- compounddef.listen_until(dox_uri, "compounddef")
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Adds a methods to convert Doxygen’s names into short names.
-module doxml::doxyname
-
-import model
-
-redef class Compound
-
- # Separator used by Doxygen to separate name’s components.
- protected fun doxyname_separator: String do return "::"
-
- # Set the `name` using the specified name generated by Doxygen.
- fun doxyname=(doxyname: String) do
- name = doxyname.to_short_name(doxyname_separator)
- end
-
- # Declare an inner class.
- #
- # Note: Althought Doxygen indicates that both arguments are optional,
- # declarations with an empty ID are not supported yet.
- #
- # Parameters:
- #
- # * `id`: `model_id` of the inner class.
- # * `doxyname`: qualified name of the inner class, as generated by Doxygen.
- # * `prot`: visibility (proctection).
- #
- # TODO: Handle cases where only the `doxyname` is available.
- fun doxygen_declare_class(id: String, doxyname: String, prot: String) do
- declare_class(id, doxyname.to_short_name(doxyname_separator), prot)
- end
-end
-
-redef class Namespace
- # Set the `name` and the `full_name` using the specified name generated by Doxygen.
- #
- # Warning: This method assumes that `model_id` is already set.
- redef fun doxyname=(doxyname: String) do
- full_name = doxyname
- super
- if doxyname == name and model_id != "" then
- # Doxygen does not represent the root namespace.
- # So, we have to link the root namespace with its children manually.
- graph.by_id[""].as(Namespace).declare_namespace(model_id, doxyname)
- end
- end
-end
-
-redef class FileCompound
- redef fun doxyname_separator do return "/"
-end
-
-redef class Text
- # Return the substring that come after the last occurrence of `separator`.
- #
- # Return the whole string if `sperator` is not present.
- private fun to_short_name(separator: String): SELFTYPE do
- var m = search_last(separator)
-
- if m == null then
- return self
- else
- return substring_from(m.after)
- end
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Common SAX listeners for entity definitions.
-module doxml::entitydef
-
-import doc_listener
-
-# Processes the content of an entity definition.
-abstract class EntityDefListener
- super StackableListener
-
- # The inner `TextListener`.
- protected var text: TextListener is noinit
-
- # The inner `DocListener`.
- protected var doc: DocListener is noinit
-
- # The inner `NoopListener`.
- protected var noop: NoopListener is noinit
-
- init do
- super
- text = new TextListener(reader, self)
- doc = new DocListener(reader, self)
- noop = new NoopListener(reader, self)
- end
-
- # The current entity.
- protected fun entity: Entity is abstract
-
- redef fun start_dox_element(local_name, atts) do
- if ["briefdescription", "detaileddescription", "inbodydescription"].has(local_name) then
- doc.doc = entity.doc
- doc.listen_until(dox_uri, local_name)
- else if "location" == local_name then
- entity.location = get_location(atts)
- else
- noop.listen_until(dox_uri, local_name)
- end
- end
-
- redef fun end_listening do
- super
- entity.put_in_graph
- end
-
- # Parse the attributes of a `location` element.
- protected fun get_location(atts: Attributes): neo_doxygen::Location do
- var location = new neo_doxygen::Location
-
- location.path = atts.value_ns("", "bodyfile") or else atts.value_ns("", "file")
- # Doxygen may indicate `[generated]`.
- if "[generated]" == location.path then location.path = null
- var line_start = atts.value_ns("", "bodystart") or else atts.value_ns("", "line") or else null
- if line_start != null then location.line_start = line_start.to_i
- var line_end = atts.value_ns("", "bodyend")
- if line_end != null then location.line_end = line_end.to_i
- var column_start = atts.value_ns("", "column")
- if column_start != null then location.column_start = column_start.to_i
- if location.line_start == location.line_end then
- location.column_end = location.column_start
- end
- return location
- end
-end
-
-# Processes the content of a `<param>` element.
-abstract class ParamListener[T: Parameter]
- super EntityDefListener
-
- # The current parameter.
- var parameter: T is noinit
-
- private var type_listener: TypeListener is noinit
-
- init do
- super
- type_listener = new TypeListener(reader, self)
- end
-
- redef fun entity do return parameter
-
- redef fun listen_until(uri, local_name) do
- super
- parameter = create_parameter
- end
-
- # Create a new parameter.
- protected fun create_parameter: T is abstract
-
- redef fun start_dox_element(local_name, atts) do
- if "declname" == local_name then
- text.listen_until(dox_uri, local_name)
- else if "type" == local_name then
- type_listener.listen_until(dox_uri, local_name)
- else
- super
- end
- end
-
- redef fun end_dox_element(local_name) do
- if "declname" == local_name then
- parameter.name = text.to_s
- else if "type" == local_name then
- source_language.apply_parameter_type(parameter, type_listener.linked_text)
- else
- super
- end
- end
-end
-
-# Processes the content of a `<param>` element in a `<templateparamlist>` element.
-class TypeParamListener
- super ParamListener[TypeParameter]
-
- redef fun create_parameter do return new TypeParameter(graph)
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Handle language-specific parts of the importation.
-module doxml::language_specific
-
-import model
-
-# Various importation logics that depend on the project’s language.
-abstract class SourceLanguage
-
- # Apply the information deduced from `type_text` to `member`.
- #
- # `type_text` is the content of the `<type>` element.
- fun apply_member_type(member: Member, type_text: RawType) do
- if type_text["text"] != null then
- member.static_type = type_text
- end
- end
-
- # Apply the information deduced from `type_text` to `parameter`.
- #
- # `type_text` is the content of the `<type>` element.
- fun apply_parameter_type(parameter: Parameter, type_text: RawType) do
- if type_text["text"] != null then
- parameter.static_type = type_text
- end
- end
-
- # Extract the specified keyword at the beginning of the specified text.
- #
- # If the keyword is at the beginning of the specified text, return `true`
- # and remove the keyword. Else, return false.
- #
- # Used to extract some keywords that Doxygen puts in the type.
- #
- # class DummySource
- # super JavaSource
- # #
- # fun test(text: LinkedText, keyword: String): Bool do
- # return extract_keyword(text, keyword)
- # end
- # end
- # #
- # var text = new RawType(new ProjectGraph(""))
- # var dummy = new DummySource
- # var res: Bool
- # #
- # text.add_part("abstract final", "")
- # res = dummy.test(text, "static")
- # assert not res
- # res = dummy.test(text, "abstract")
- # assert res
- # assert "final" == text["text"].as(JsonArray).first
- # res = dummy.test(text, "final")
- # assert res
- # assert text["text"] == null
- # res = dummy.test(text, "abstract")
- # assert not res
- protected fun extract_keyword(text: LinkedText, keyword: String): Bool do
- var text_array = text["text"]
- if text_array == null then return false
- assert text_array isa JsonArray
- if text_array.is_empty then return false
-
- var content = text_array.first.as(String).l_trim
- var link = text.links.first
- var found = false
-
- if link == null and content.has_prefix(keyword) then
- if keyword.length == content.length then
- content = ""
- found = true
- else if content.chars[keyword.length] <= ' ' then
- content = content.substring_from(keyword.length).l_trim
- found = true
- end
- if "" == content then
- text.shift_part
- else if found then
- text.set_part(0, content, "")
- end
- end
- return found
- end
-
- # Extract the specified suffix in the specified text.
- #
- # If the suffix is at the end of the specified text, return `true`
- # and remove the suffix. Else, return false.
- #
- # Used to extract stuff like `...` that Doxygen puts in the type.
- #
- # class DummySource
- # super JavaSource
- # #
- # fun test(text: LinkedText, s: String): Bool do
- # return extract_suffix(text, s)
- # end
- # end
- # #
- # var text = new RawType(new ProjectGraph(""))
- # var dummy = new DummySource
- # var res: Bool
- # #
- # text.add_part("Object...+++", "")
- # res = dummy.test(text, "...")
- # assert not res
- # res = dummy.test(text, "+++")
- # assert res
- # assert "Object..." == text["text"].as(JsonArray).first
- # res = dummy.test(text, "...")
- # assert res
- # assert "Object" == text["text"].as(JsonArray).first
- protected fun extract_suffix(text: LinkedText, suffix: String): Bool do
- var text_array = text["text"]
- if text_array == null then return false
- assert text_array isa JsonArray
- if text_array.is_empty then return false
-
- var content = text_array.last.as(String).r_trim
- var link = text.links.first
-
- if link == null and content.has_suffix(suffix) then
- content = content.substring(0, content.length - suffix.length).r_trim
- if "" == content then
- text.pop_part
- else
- text.set_part(0, content, "")
- end
- return true
- else
- return false
- end
- end
-end
-
-# The default importation logics.
-#
-# Do nothing special.
-class DefaultSource
- super SourceLanguage
-end
-
-# Importation logics for Java.
-class JavaSource
- super SourceLanguage
-
- redef fun apply_member_type(member, type_text) do
- # For abstract members, Doxygen put `abstract` at the beginning of the type.
- # We assume that Doxygen do not put annotations in the type (it seems to
- # be the case).
- if extract_keyword(type_text, "abstract") then
- member.is_abstract = true
- end
- # TODO final
- # TODO void
- # TODO Avoid using `RawType` when possible. Only use `RawType` as a fallback.
- super
- end
-
- redef fun apply_parameter_type(parmeter, type_text) do
- # We assume that Doxygen do not put annotations in the type (it seems to
- # be the case).
- # TODO final
- # TODO Avoid using `RawType` when possible. Only use `RawType` as a fallback.
- parmeter.is_vararg = extract_suffix(type_text, "...")
- super
- end
-end
-
-# Importation logics for Python.
-class PythonSource
- super SourceLanguage
-
- redef fun apply_member_type(member, type_text) do
- # Doxygen may forgot to remove the `def` keyword on methods.
- extract_keyword(type_text, "def")
- super
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Basic SAX listeners.
-module doxml::listener
-
-import saxophonit
-import model
-import language_specific
-
-# Common abstractions for SAX listeners reading XML documents generated by Doxygen.
-abstract class DoxmlListener
- super ContentHandler
-
- # The locator setted by calling `document_locator=`.
- protected var locator: nullable SAXLocator = null
-
- # The project graph.
- fun graph: ProjectGraph is abstract
-
- # The language-specific strategies to use.
- fun source_language: SourceLanguage is abstract
-
- redef fun document_locator=(locator: SAXLocator) do
- self.locator = locator
- end
-
- # The Doxygen’s namespace IRI.
- protected fun dox_uri: String do return ""
-
- redef fun start_element(uri: String, local_name: String, qname: String,
- atts: Attributes) do
- super
- if uri != dox_uri then return # None of our business.
- start_dox_element(local_name, atts)
- end
-
- # Process the start of an element in the Doxygen’s namespace.
- #
- # See `ContentHandler.start_element` for the description of the parameters.
- protected fun start_dox_element(local_name: String, atts: Attributes) do end
-
- redef fun end_element(uri: String, local_name: String, qname: String) do
- super
- if uri != dox_uri then return # None of our business.
- end_dox_element(local_name)
- end
-
- # Process the end of an element in the Doxygen’s namespace.
- #
- # See `ContentHandler.start_element` for the description of the parameters.
- protected fun end_dox_element(local_name: String) do end
-
- # Get the boolean value of the specified attribute.
- #
- # `false` by default.
- protected fun get_bool(atts: Attributes, local_name: String): Bool do
- return get_optional(atts, local_name, "no") == "yes"
- end
-
- # Get the value of an optional attribute.
- #
- # Parameters:
- #
- # * `atts`: attribute list.
- # * `local_name`: local name of the attribute.
- # * `default`: value to return when the specified attribute is not found.
- protected fun get_optional(atts: Attributes, local_name: String,
- default: String): String do
- return atts.value_ns(dox_uri, local_name) or else default
- end
-
- # Get the value of an required attribute.
- #
- # Parameters:
- #
- # * `atts`: attribute list.
- # * `local_name`: local name of the attribute.
- protected fun get_required(atts: Attributes, local_name: String): String do
- var value = atts.value_ns(dox_uri, local_name)
- if value == null then
- throw_error("The `{local_name}` attribute is required.")
- return ""
- else
- return value
- end
- end
-
- redef fun end_document do
- locator = null
- end
-
- # Throw an error with the specified message by prepending the current location.
- protected fun throw_error(message: String) do
- var e: SAXParseException
-
- if locator != null then
- e = new SAXParseException.with_locator(message, locator.as(not null))
- else
- e = new SAXParseException(message)
- end
- e.throw
- end
-end
-
-# A `DoxmlListener` that read only a part of a document.
-#
-# Temporary redirect events to itself until it ends processing its part.
-abstract class StackableListener
- super DoxmlListener
-
- # The associated reader.
- var reader: XMLReader
-
- # The parent listener.
- var parent: DoxmlListener
-
- # Namespace’s IRI of the element at the root of the part to process.
- private var root_uri: String = ""
-
- # Local name of the element at the root of the part to process.
- private var root_local_name: String = ""
-
- # The number of open element of the same type than the root of the part to process.
- private var depth = 0
-
- # The project graph.
- private var p_graph: ProjectGraph is noinit
-
- # The language-specific strategies to use.
- private var p_source: SourceLanguage is noinit
-
-
- init do
- super
- p_graph = parent.graph
- p_source = parent.source_language
- end
-
- redef fun graph do return p_graph
- redef fun source_language do return p_source
-
- # Temporary redirect events to itself until the end of the specified element.
- fun listen_until(uri: String, local_name: String) do
- root_uri = uri
- root_local_name = local_name
- depth = 1
- reader.content_handler = self
- locator = parent.locator
- end
-
- redef fun start_element(uri: String, local_name: String, qname: String,
- atts: Attributes) do
- super
- if uri == root_uri and local_name == root_local_name then
- depth += 1
- end
- end
-
- redef fun end_element(uri: String, local_name: String, qname: String) do
- super
- if uri == root_uri and local_name == root_local_name then
- depth -= 1
- if depth <= 0 then
- end_listening
- parent.end_element(uri, local_name, qname)
- end
- end
- end
-
- # Reset the reader’s listener to the parent.
- fun end_listening do
- reader.content_handler = parent
- locator = null
- end
-
- redef fun end_document do
- end_listening
- end
-end
-
-# A SAX listener that skips any event except the end of the part to process.
-#
-# Used to skip an entire element.
-class NoopListener
- super StackableListener
-end
-
-# Concatenates any text node found.
-class TextListener
- super StackableListener
-
- # The read text.
- protected var buffer: Buffer = new FlatBuffer
-
- # Is the last read chunk was ignorable white space?
- private var sp: Bool = false
-
- redef fun listen_until(uri: String, local_name: String) do
- buffer.clear
- sp = false
- super
- end
-
- redef fun characters(str: String) do
- if sp then
- if buffer.length > 0 then buffer.append(" ")
- sp = false
- end
- buffer.append(str)
- end
-
- redef fun ignorable_whitespace(str: String) do
- sp = true
- end
-
- # Flush the buffer.
- protected fun flush_buffer: String do
- var s = buffer.to_s
-
- buffer.clear
- sp = false
- return s
- end
-
- redef fun to_s do return buffer.to_s
-end
-
-# Processes a content of type `linkedTextType`.
-abstract class LinkedTextListener[T: LinkedText]
- super TextListener
-
- # The read text.
- var linked_text: T is noinit
-
- private var refid = ""
-
- # Create a new instance of `T`.
- protected fun create_linked_text: T is abstract
-
- redef fun listen_until(uri: String, local_name: String) do
- linked_text = create_linked_text
- refid = ""
- super
- end
-
- redef fun start_dox_element(local_name: String, atts: Attributes) do
- super
- push_part
- if "ref" == local_name then refid = get_required(atts, "refid")
- end
-
- redef fun end_dox_element(local_name: String) do
- super
- push_part
- if "ref" == local_name then refid = ""
- end
-
- private fun push_part do
- var s = flush_buffer
-
- if not s.is_empty then
- linked_text.add_part(s, refid)
- end
- end
-
- redef fun to_s do return linked_text.to_s
-end
-
-# Processes the content of a `<type>` element.
-class TypeListener
- super LinkedTextListener[RawType]
-
- private var raw_type: RawType is noinit
-
- redef fun create_linked_text do return new RawType(graph)
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# `memberdef` element reading.
-module doxml::memberdef
-
-import entitydef
-
-# Processes the content of a `<memberdef>` element.
-class MemberDefListener
- super EntityDefListener
-
- # The current member.
- var member: Member is writable, noinit
-
- private var type_listener: TypeListener is noinit
- private var param_listener: MemberParamListener is noinit
-
- init do
- super
- type_listener = new TypeListener(reader, self)
- param_listener = new MemberParamListener(reader, self)
- end
-
- redef fun entity do return member
-
- redef fun start_dox_element(local_name: String, atts: Attributes) do
- if "name" == local_name then
- text.listen_until(dox_uri, local_name)
- else if "reimplements" == local_name then
- member.reimplement(get_required(atts, "refid"))
- else if "type" == local_name then
- type_listener.listen_until(dox_uri, local_name)
- else if "param" == local_name then
- param_listener.listen_until(dox_uri, local_name)
- else
- super
- end
- end
-
- redef fun end_dox_element(local_name: String) do
- if "name" == local_name then
- member.name = text.to_s
- else if "type" == local_name then
- source_language.apply_member_type(member, type_listener.linked_text)
- else if "param" == local_name then
- member.add_parameter(param_listener.parameter)
- else
- super
- end
- end
-end
-
-# Processes the content of a `<param>` element in a `<memberdef>` element.
-class MemberParamListener
- super ParamListener[MemberParameter]
-
- redef fun create_parameter do return new MemberParameter(graph)
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# A storage medium for a graph.
-module graph_store
-
-import neo4j
-import console
-
-# A storage medium for a graph.
-#
-# Provides a way to save a Neo4j graph.
-abstract class GraphStore
-
- # Escape control sequence to save the cursor position.
- private var term_save_cursor: String = (new TermSaveCursor).to_s
-
- # Escape control sequence to rewind to the last saved cursor position.
- private var term_rewind: String = "{new TermRestoreCursor}{new TermEraseDisplayDown}"
-
- # Is the storage medium already contains at least one node with the specified label?
- fun has_node_label(name: String): Bool is abstract
-
- # Save all specified Neo4j entities.
- fun save_all(neo_entities: Collection[NeoEntity]) is abstract
-
- # Prepare the output to show the progress.
- #
- # This method must be called before the first call to `show_progress` or
- # `show_done`.
- protected fun prepare_display do printn "{term_save_cursor} "
-
- # Show the progress, in percentage.
- #
- # For use in the implementation of `save_all` only.
- protected fun show_progress(progress: Int) do
- printn "{term_rewind} {progress}% "
- end
-
- # Show a message to indicate that the task finished with success.
- #
- # For use in the implementation of `save_all` only.
- protected fun show_done do
- print "{term_rewind} Done."
- end
-end
-
-# An actual Neo4j database as a storage medium.
-class Neo4jStore
- super GraphStore
-
- # How many operations can be executed in one batch?
- private var batch_max_size = 1000
-
- # The Neo4j client to use.
- var client: Neo4jClient
-
- redef fun has_node_label(name) do
- var query = new CypherQuery.from_string(
- "match n where \{name\} in labels(n) return count(n)")
- query.params["name"] = name
- var data = client.cypher(query).as(JsonObject)["data"]
- var result = data.as(JsonArray).first.as(JsonArray).first.as(Int)
- return result > 0
- end
-
- redef fun save_all(neo_entities) do
- var batch = new NeoBatch(client)
- var len = neo_entities.length
- var sum = 0
- var i = 1
-
- prepare_display
- for nentity in neo_entities do
- batch.save_entity(nentity)
- if i == batch_max_size then
- do_batch(batch)
- sum += batch_max_size
- show_progress(sum * 100 / len)
- batch = new NeoBatch(client)
- i = 1
- else
- i += 1
- end
- end
- do_batch(batch)
- show_done
- end
-
- # Execute `batch` and check for errors.
- #
- # Abort if `batch.execute` returns errors.
- private fun do_batch(batch: NeoBatch) do
- var errors = batch.execute
- if not errors.is_empty then
- for e in errors do sys.stderr.write("{sys.program_name}: {e}\n")
- exit(1)
- end
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Nodes for classes.
-module model::class_compound
-
-import graph
-import member
-import type_entity
-
-# A class.
-class ClassCompound
- super Compound
-
- # The corresponding type.
- #
- # In the case of a generic class, defines bounds for type parameters.
- var class_type: ClassType is noinit
-
- # The definition.
- var class_def: ClassDef is noinit
-
- init do
- super
- class_type = new ClassType(graph)
- class_type.class_compound = self
- class_def = new ClassDef(graph, self)
- self.labels.add("MClass")
- kind = "class"
- visibility = "public"
- end
-
- # Return the number of type parameters.
- fun arity: Int do return class_type.arity
-
- redef fun name=(name) do
- super
- class_type.name = name
- class_def.name = name
- end
-
- redef fun location=(location) do
- super
- class_def.location = location
- end
-
- redef fun set_mdoc do
- super
- class_def["mdoc"] = doc
- end
-
- redef fun declare_super(id, full_name, prot, virt) do
- class_def.declare_super(id, full_name, prot, virt)
- end
-
- redef fun declare_member(member) do
- class_def.declare_member(member)
- end
-
- # Append the specified type parameter.
- fun add_type_parameter(parameter: TypeParameter) do
- class_type.arguments.add(parameter)
- end
-
- redef fun put_in_graph do
- super
- class_type.put_in_graph
- class_def.put_in_graph
- end
-
- redef fun put_edges do
- super
- graph.add_edge(self, "CLASSTYPE", class_type)
- if arity > 0 then
- var names = new JsonArray
-
- for p in class_type.arguments do
- names.add(p.name)
- end
- self["parameter_names"] = names
- end
- end
-end
-
-# The `MClassDef` node of a class.
-class ClassDef
- super CodeBlock
-
- # The defined class.
- var class_compound: ClassCompound
-
- # The `model_id` of the base classes.
- var supers: SimpleCollection[String] = new Array[String]
-
- # The set of the introduced/redefined members.
- #
- # Includes inner classes.
- #
- # Filled by `declare_member` and `declare_class`.
- #
- # Note: `declare_class` is defined by the `inner_class` module.
- #
- # SEE: `declare_member`
- # SEE: `declare_class`
- var members: SimpleCollection[MemberOrInner] = new Array[MemberOrInner]
-
- init do
- super
- self.labels.add("MClassDef")
- self["is_intro"] = true
- end
-
- # Declare a base compound (usually, a base class).
- #
- # Parameters:
- #
- # * `id`: `model_id` of the base compound. May be empty.
- # * `full_name`: qualified name of the base compound. May be empty.
- # * `prot`: visibility (proctection) of the relationship.
- # * `virt`: level of virtuality of the relationship.
- fun declare_super(id: String, full_name: String, prot: String,
- virt: String) do
- # TODO prot, virt, full_name
- if "" != id then
- supers.add(id)
- end
- end
-
- # Append the specified member.
- fun declare_member(member: Member) do
- members.add(member)
- end
-
- redef fun put_edges do
- super
- graph.add_edge(self, "BOUNDTYPE", class_compound.class_type)
- graph.add_edge(self, "MCLASS", class_compound)
- for s in supers do
- graph.add_edge(self, "INHERITS", graph.by_id[s].as(ClassCompound).class_type)
- end
- for m in members do
- if m.is_intro then
- var intro = m.introducer.as(not null)
- graph.add_edge(self, "INTRODUCES", intro)
- graph.add_edge(intro, "INTRO_CLASSDEF", self)
- end
- graph.add_edge(self, "DECLARES", m)
- end
- end
-end
-
-# A type defined by a class.
-class ClassType
- super TypeEntity
-
- # The associated class.
- #
- # You may use this attribute or `class_compound_id` to specify the class.
- var class_compound: nullable ClassCompound = null is writable
-
- # The `model_id` of the associated class.
- #
- # You may use this attribute or `class_compound` to specify the class.
- var class_compound_id: String = "" is writable
-
- # The type arguments or the type parameters.
- var arguments = new Array[TypeEntity]
-
- init do
- super
- self.labels.add("MClassType")
- end
-
- # Return the number of arguments.
- fun arity: Int do return arguments.length
-
- # Is the class generic?
- fun is_generic: Bool do return arity > 0
-
- redef fun put_in_graph do
- super
- if is_generic then
- self.labels.add("MGenericType")
- else
- var i = self.labels.index_of("MGenericType")
- if i >= 0 then self.labels.remove_at(i)
- end
- end
-
- redef fun put_edges do
- var cls = class_compound
-
- if cls == null and class_compound_id != "" then
- cls = graph.by_id[class_compound_id].as(ClassCompound)
- end
- assert cls != null
-
- super
- graph.add_edge(self, "CLASS", cls)
- assert cls.arity == self.arity
- for i in [0..arguments.length[ do
- var a = arguments[i]
- if cls.class_type != self then
- a.name = cls.class_type.arguments[i].name
- end
- if a isa TypeParameter then
- a.rank = i
- graph.add_edge(a, "CLASS", cls)
- end
- graph.add_edge(self, "ARGUMENT", a)
- end
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Documentation associated to an entity.
-module model::descriptions
-
-import json::static
-import json
-
-# Documentation associated to an entity.
-#
-# The documentation is written in Markdown format.
-#
-# ~~~nit
-# var doc = new Documentation
-#
-# doc.brief_description = "Do something."
-# doc.detailed_description = ["Do not lunch a rocket."]
-# assert doc.brief_description == "Do something."
-# assert doc.detailed_description == ["Do not lunch a rocket."]
-# assert doc.to_json == """["Do something.","Do not lunch a rocket."]"""
-#
-# doc.brief_description = ""
-# doc.detailed_description = ["The answer is `42`."]
-# assert doc.brief_description == "The answer is `42`."
-# assert doc.detailed_description == ["The answer is `42`."]
-# assert doc.to_json == """["The answer is `42`."]"""
-#
-# doc.detailed_description = ["The answer is `42`."]
-# doc.brief_description = ""
-# assert doc.brief_description == "The answer is `42`."
-# assert doc.detailed_description == ["The answer is `42`."]
-# assert doc.to_json == """["The answer is `42`."]"""
-#
-# doc.detailed_description = new Array[String]
-# doc.brief_description = ""
-# assert doc.is_empty
-# assert doc.brief_description == ""
-# assert doc.detailed_description == new Array[String]
-# assert doc.to_json == "[]"
-# ~~~
-class Documentation
- super Serializable
-
- private var content = new JsonStringArray
- private var has_brief_description: Bool = false
-
- # The brief description.
- #
- # If it is empty, the first element of `detailed_description` will be used
- # as brief description.
- fun brief_description=(brief_description: String) do
- if brief_description.is_empty then
- if has_brief_description then
- content.shift
- has_brief_description = false
- end
- else if has_brief_description then
- content.first = brief_description
- else
- content.unshift(brief_description)
- has_brief_description = true
- end
- end
-
- # The brief description.
- fun brief_description: String do
- if not is_empty then return content.first
- return ""
- end
-
- # The detailed description.
- #
- # Each element should represent a block.
- fun detailed_description=(detailed_description: SequenceRead[String]) do
- if has_brief_description then
- while content.length > 1 do content.pop
- else
- content.clear
- end
- content.add_all(detailed_description)
- end
-
- # The detailed description.
- #
- # Each element should represent a block.
- fun detailed_description: SequenceRead[String] do
- if not has_brief_description then return content
- if content.length > 1 then return content.subarray(1, content.length - 1)
- return new Array[String]
- end
-
- # Add a block of detailed description.
- fun add(block: String) do content.add block
-
- # Is the documentation empty?
- fun is_empty: Bool do return content.is_empty
-
- redef fun serialize_to(v) do content.serialize_to v
- redef fun accept_json_serializer(v) do content.serialize_to v
-end
-
-# A `Serializable` array of strings.
-private class JsonStringArray
- super JsonSequenceRead[String]
- super Array[String]
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Graphs and basic entities.
-module model::graph
-
-import neo4j
-import more_collections
-import location
-import descriptions
-
-# A Neo4j graph.
-class NeoGraph
- # All the nodes in the graph.
- var all_nodes: SimpleCollection[NeoNode] = new Array[NeoNode]
-
- # All the edges in the graph.
- var all_edges: SimpleCollection[NeoEdge] = new Array[NeoEdge]
-
- # Add a relationship between two nodes.
- #
- # Parameters are the same than for the constructor of `NeoEdge`.
- fun add_edge(from: NeoNode, rel_type: String, to: NeoNode) do
- all_edges.add(new NeoEdge(from, rel_type, to))
- end
-end
-
-# A project’s graph.
-#
-# Here is the usual steps to build a project graph:
-#
-# <ul>
-# <li>Instantiate `ProjectGraph` by giving the name that will label the project.</li>
-# <li>For each compound:
-# <ul>
-# <li>Instantiate the compound.</li>
-# <li>Provide all the related data.</li>
-# <li>Call the `put_in_graph` method of the compound.</li>
-# </ul></li>
-# <li>Call the `add_global_modules` method of the project’s graph (defined in
-# the `module_compound` module). This permits to take global classes into
-# account correctly.</li>
-# <li>Call the `put_edges` method of the project’s graph.</li>
-# </ul>
-class ProjectGraph
- super NeoGraph
-
- # The project’s name.
- var project_name: String
-
- # The node reperesenting the project.
- #
- # Once the project’s graph is initialized, this node must not be edited.
- var project = new NeoNode
-
- # Entities by `model_id`.
- var by_id: Map[String, Entity] = new HashMap[String, Entity]
-
- # Namespaces by `full_name`.
- var namespaces: Map[String, Namespace] = new HashMap[String, Namespace]
-
- # For each `ClassCompound` in the graph, the mapping between its `model_id` and its namespace.
- #
- # Defaults to the root namespace. An entry is added each time
- # `Namespace.declare_class` is called.
- #
- # Note: In the graph, there is no direct link between a namespace and a
- # class. It is the role of a module (created internally by a `FileCompound`)
- # to link a class with its namespace. So, this collection is used by modules
- # to know which class in a file belong to their related namespace. It is
- # also used by `FileCompound` to detect classes in the root namespace.
- var class_to_ns: Map[String, Namespace] is noinit
-
- # Initialize a new project graph using the specified project name.
- #
- # The specified name will label all nodes of the project’s graph.
- init do
- project.labels.add(project_name)
- project.labels.add("MEntity")
- project.labels.add("MProject")
- project["name"] = project_name
- all_nodes.add(project)
-
- var root = new RootNamespace(self)
- root.put_in_graph
- by_id[""] = root
- class_to_ns = new DefaultMap[String, Namespace](root)
- end
-
- # Request to all nodes in the graph to add their related edges.
- #
- # Note: For the rare cases where a node need to wait the `put_edges` to add
- # an implicit node, this method makes sure to call the `put_edges` method
- # of the newly added nodes only after processing all the nodes that was
- # already there.
- fun put_edges do
- all_edges.clear
- add_edge(project, "ROOT", by_id[""])
- for n in all_nodes do
- if n isa Entity then
- n.put_edges
- end
- end
- end
-end
-
-# A model’s entity.
-#
-# In practice, this is the base class of every node in a `ProjectGraph`.
-abstract class Entity
- super NeoNode
-
- # Graph that will embed the entity.
- var graph: ProjectGraph
-
- # ID of the entity in the model.
- #
- # Is empty for entities without an ID.
- var model_id: String = "" is writable
-
- # The full (qualified) name, as presented by the original model.
- #
- # Fully independant of `name`. By default, equals to `""` for the root
- # namespace.
- var full_name: nullable String = null is writable
-
- # Associated documentation.
- var doc = new Documentation is writable
-
- init do
- self.labels.add(graph.project_name)
- self.labels.add("MEntity")
- end
-
- # The short (unqualified) name.
- fun name=(name: String) do
- self["name"] = name
- end
-
- # The short (unqualified) name.
- fun name: String do
- var name = self["name"]
- assert name isa String
- return name
- end
-
- # Include the documentation of `self` in the graph.
- protected fun set_mdoc do
- self["mdoc"] = doc
- end
-
- # The namespace separator of Nit/C++.
- #
- # Used to join two or more names when we need to work around some
- # limitations of the Nit model.
- fun ns_separator: String do return "::"
-
- # Set the location of the entity in the source code.
- fun location=(location: nullable neo_doxygen::Location) do
- self["location"] = location
- end
-
- # Get the location of the entity in the source code.
- fun location: nullable neo_doxygen::Location do
- return self["location"].as(nullable neo_doxygen::Location)
- end
-
- # Put the entity in the graph.
- #
- # Called by the loader when it has finished to read the entity.
- fun put_in_graph do
- if not doc.is_empty then
- set_mdoc
- end
- graph.all_nodes.add(self)
- if model_id != "" then graph.by_id[model_id] = self
- end
-
- # Put the related edges in the graph.
- #
- # This method is called on each node by `ProjectGraph.put_edges`.
- #
- # Note: Even at this step, the entity may modify its own attributes and
- # inner entities’ ones because some values are only known once the entity
- # know its relationships with the rest of the graph.
- fun put_edges do end
-end
-
-# An entity whose the location is mandatory.
-abstract class CodeBlock
- super Entity
-
- init do
- self["location"] = new neo_doxygen::Location
- end
-
- redef fun location=(location) do
- if location == null then
- super(new neo_doxygen::Location)
- else
- super
- end
- end
-end
-
-# A compound.
-#
-# Usually corresponds to a `<compounddef>` element in of the XML output of
-# Doxygen.
-abstract class Compound
- super Entity
-
- # Set the declared visibility (the protection) of the compound.
- fun visibility=(visibility: String) do
- self["visibility"] = visibility
- end
-
- # Set the specific kind of the compound.
- fun kind=(kind: String) do
- self["kind"] = kind
- end
-
- # Declare an inner namespace.
- #
- # Note: Although Doxygen indicates that the name is optional,
- # declarations with an empty name are not supported yet, except for the root
- # namespace. For the root namespace, both arguments are empty.
- #
- # Parameters:
- #
- # * `id`: `model_id` of the inner namespace. May be empty.
- # * `full_name`: qualified name of the inner namespace. Use an empty name
- # for the root namespace.
- fun declare_namespace(id: String, full_name: String) do end
-
- # Declare an inner class.
- #
- # Note: Although Doxygen indicates that both arguments are optional,
- # declarations with an empty ID are not supported yet.
- #
- # Parameters:
- #
- # * `id`: `model_id` of the inner class.
- # * `name`: short name of the inner class.
- # * `prot`: visibility (proctection).
- fun declare_class(id: String, name: String, prot: String) do end
-
- # Declare a base compound (usually, a base class).
- #
- # Parameters:
- #
- # * `id`: `model_id` of the base compound. May be empty.
- # * `full_name`: qualified name of the base compound. May be empty.
- # * `prot`: visibility (proctection) of the relationship.
- # * `virt`: level of virtuality of the relationship.
- fun declare_super(id: String, full_name: String, prot: String,
- virt: String) do end
-end
-
-# An unrecognized compound.
-#
-# Used to simplify the handling of ignored entities.
-class UnknownCompound
- super Compound
-
- redef fun put_in_graph do end
- redef fun put_edges do end
-end
-
-# A namespace.
-#
-# Corresponds to a group in Nit.
-class Namespace
- super Compound
-
- # The inner namespaces.
- var inner_namespaces: SimpleCollection[NamespaceRef] = new Array[NamespaceRef]
-
- init do
- super
- self.labels.add("MGroup")
- end
-
- redef fun declare_namespace(id, full_name) do
- inner_namespaces.add new NamespaceRef(id, full_name)
- end
-
- redef fun declare_class(id, name, prot) do
- assert not id.is_empty else
- sys.stderr.write "Inner class declarations without ID are not yet supported.\n"
- end
- graph.class_to_ns[id] = self
- end
-
- redef fun put_in_graph do
- super
- var full_name = self.full_name
- if full_name isa String then graph.namespaces[full_name] = self
- end
-
- redef fun put_edges do
- super
- graph.add_edge(self, "PROJECT", graph.project)
- for ns in inner_namespaces do
- var node = ns.seek_in(graph)
- graph.add_edge(node, "PARENT", self)
- graph.add_edge(self, "NESTS", node)
- end
- end
-end
-
-# A reference to a namespace.
-class NamespaceRef
- # The `model_id` of the target.
- #
- # Empty when unknown or for the root namespace.
- var model_id: String
-
- # The `full_name` of the target.
- #
- # Empty only for the root namespace.
- var full_name: String
-
- # Look for the targeted namespace in the specified graph.
- fun seek_in(graph: ProjectGraph): Namespace do
- var ns_compound: Namespace
-
- if model_id.is_empty and not full_name.is_empty then
- # ID unspecified. => We have to look by name
- assert graph.namespaces.has_key(full_name) else
- sys.stderr.write "Namespace `{full_name}` not found."
- end
- ns_compound = graph.namespaces[full_name]
- else
- ns_compound = graph.by_id[model_id].as(Namespace)
- end
- return ns_compound
- end
-end
-
-# The root namespace of a `ProjectGraph`.
-#
-# This the only entity in the graph whose `model_id` is really `""`.
-# Added automatically at the initialization of a `ProjectGraph`.
-class RootNamespace
- super Namespace
-
- init do
- super
- full_name = ""
- name = graph.project_name
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Adds the possibility to define inner classses.
-module model::inner_class
-
-import member
-import class_compound
-
-# An inner class.
-class InnerClass
- super MemberOrInner
-
- redef type INTRODUCER_TYPE: InnerClassIntroducer
-
- # The outer class definition.
- #
- # Used to correct the short name of the inner class definition when
- # `put_edges` is called.
- #
- # SEE: The notice concerning `name` in `/src/neo.nit`.
- var outer: ClassDef
-
- # The `model_id` of the actual inner class (`ClassCompound`).
- var inner: String
-
- init do
- super
- self.labels.add("MInnerClassDef")
- end
-
- redef fun is_intro do return true
- redef fun create_introducer do return new InnerClassIntroducer(graph, self)
- redef fun resolve_introducer do return introducer
-
- redef fun put_edges do
- super
- var inner = graph.by_id[self.inner]
- assert inner isa ClassCompound
- var inner_def = inner.class_def
- # Correct the short name of `inner` to avoid name collisions in a module.
- inner_def.name = "{outer.name}{ns_separator}{name}"
- graph.add_edge(self, "NESTS", inner_def)
- end
-end
-
-# A `MProperty` node for an inner class.
-class InnerClassIntroducer
- super MemberIntroducer
-
- # The definition.
- var def: InnerClass
-
- init do
- super
- self.labels.add("MInnerClass")
- end
-
- redef fun put_edges do
- super
- var inner = graph.by_id[def.inner]
- assert inner isa ClassCompound
- var outer = def.outer.class_compound
- # Correct the short name of `inner` to avoid name collisions in a module.
- inner.name = "{outer.name}{ns_separator}{name}"
- graph.add_edge(self, "NESTS", inner)
- end
-end
-
-# Implements `declare_class`.
-redef class ClassCompound
- redef fun declare_class(id, name, prot) do
- class_def.declare_class(id, name, prot)
- end
-end
-
-# Implements `declare_class`.
-redef class ClassDef
-
- # The set of the defined inner classes.
- #
- # All `InnerClass` entities registred here are automatically added to the
- # graph with the `ClassDef`.
- #
- # To ensure that each inner class will be correctly linked,
- # `declare_class` should be used to add each inner class.
- var inner_classes: SimpleCollection[InnerClass] = new Array[InnerClass]
-
- # Declare an inner class.
- #
- # Parameters:
- #
- # * `id`: `model_id` of the inner class definition.
- # * `name`: name of the inner class definition.
- # * `prot`: visibility (proctection).
- fun declare_class(id: String, name: String, prot: String) do
- var member = new InnerClass(graph, self, id)
- member.name = name
- member.visibility = prot
- members.add member
- inner_classes.add member
- end
-
- redef fun put_in_graph do
- super
- for member in inner_classes do
- member.put_in_graph
- end
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# A text with links.
-module model::linked_text
-
-import graph
-
-# A text with links.
-abstract class LinkedText
- super Entity
-
- # All link in the text.
- #
- # Do not edit directly.
- var links: Sequence[nullable Link] = new Array[nullable Link]
-
- # Remove all the parts.
- fun clear_parts do
- self["text"] = null
- links.clear
- end
-
- # Remove the first part.
- fun shift_part do
- var text = self["text"]
- assert text isa JsonArray
- text.shift
- links.shift
- if text.is_empty then
- self["text"] = null
- end
- end
-
- # Remove the last part.
- fun pop_part do
- var text = self["text"]
- assert text isa JsonArray
- text.pop
- links.pop
- if text.is_empty then
- self["text"] = null
- end
- end
-
- # Remove the part at the specified index.
- fun remove_part_at(index: Int) do
- var text = self["text"]
- assert text isa JsonArray
- text.remove_at(index)
- links.remove_at(index)
- if text.is_empty then
- self["text"] = null
- end
- end
-
- # Change a part of text.
- #
- # Parameters:
- #
- # * `index` : the index of the part.
- # * `content` : textual content.
- # * `refid` : `model_id` of the linked entity or `""`.
- fun set_part(index: Int, content: String, refid: String) do
- var text = self["text"]
- assert text isa JsonArray
- text[index] = content
- if not refid.is_empty then
- links[index] = create_link(links.length, refid)
- else
- links[index] = null
- end
- end
-
- # Append a part of text.
- #
- # Parameters:
- #
- # * `content` : textual content.
- # * `refid` : `model_id` of the linked entity or `""`.
- fun add_part(content: String, refid: String) do
- var text = self["text"]
-
- if text == null then
- text = new JsonArray
- self["text"] = text
- end
- assert text isa JsonArray
- text.add(content)
- if not refid.is_empty then
- links.add(create_link(links.length, refid))
- else
- links.add(null)
- end
- end
-
- # Create a link to the specified entity.
- protected fun create_link(rank:Int, refid: String): Link is abstract
-
- redef fun to_s do
- var text = self["text"]
-
- if text isa JsonArray then
- return text.join
- else
- return "UNDEFINED"
- end
- end
-
- redef fun put_in_graph do
- super
- for link in links do
- if link isa Link then
- link.put_in_graph
- end
- end
- end
-
- redef fun put_edges do
- super
- for i in [0..links.length[ do
- var link = links[i]
- if link isa Link then
- link["rank"] = i
- graph.add_edge(self, "LINK", link)
- end
- end
- end
-end
-
-# A link.
-abstract class Link
- super Entity
-
- # * `refid` : `model_id` of the linked entity.
- var refid: String
-
- init do
- super
- self["rank"] = -1
- end
-
- redef fun put_edges do
- graph.add_edge(self, "TARGET", graph.by_id[refid])
- end
-
- # Specify the rank (index) of the parameter in the signature.
- #
- # Called by `LinkedText.put_edges`.
- private fun rank=(rank: Int) do
- self["rank"] = rank
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# This module is used to model locations in source files.
-module location
-
-import json
-
-# A location inside a source file.
-class Location
- super Serializable
-
- # The file’s path.
- var path: nullable String = null is writable
-
- # The one-based index of the first line.
- var line_start: Int = 1 is writable
-
- # The one-based index of the last line.
- var line_end: Int = 1 is writable
-
- # The one-based column index of the first character.
- var column_start: Int = 1 is writable
-
- # The one-based column index of the last character.
- var column_end: Int = 1 is writable
-
- redef fun to_s do
- var path = path
- var file_part = "/dev/null:"
- if path != null and path.length > 0 then file_part = "{path}:"
- return "{file_part}{line_start},{column_start}--{line_end},{column_end}"
- end
-
- redef fun serialize_to(v) do to_s.serialize_to v
- redef fun accept_json_serializer(v) do to_s.serialize_to v
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Members.
-module model::member
-
-import graph
-import type_entity
-
-# A member or an inner class.
-abstract class MemberOrInner
- super CodeBlock
-
- # The type of the introducer.
- type INTRODUCER_TYPE: MemberIntroducer
-
- # The node used to represent the `MProperty` node.
- #
- # Only defined if `self` is at the root of a reimplementation graph, and
- # only once `put_in_graph` is called.
- var introducer: nullable INTRODUCER_TYPE = null
-
- init do
- super
- self.labels.add("MPropDef")
- end
-
- # Does this member introduce the property?
- fun is_intro: Bool is abstract
-
- redef fun put_in_graph do
- super
- self["is_intro"] = is_intro
- if is_intro then
- var visibility = self["visibility"]
- var name = self["name"]
-
- introducer = create_introducer
- if name isa String then
- introducer.name = name
- end
- if visibility isa String then
- introducer.visibility = visibility
- end
- introducer.put_in_graph
- end
- end
-
- redef fun put_edges do
- super
- var intro = resolve_introducer
-
- assert intro != null
- graph.add_edge(self, "DEFINES", intro)
- end
-
- # Set the visibility.
- fun visibility=(visibility: String) do
- self["visibility"] = visibility
- if introducer != null then
- introducer.as(not null).visibility = visibility
- end
- end
-
- # Get the visibility.
- #
- # Return `""` by default.
- fun visibility: String do
- var visibility = self["visibility"]
- if visibility isa String then return visibility
- return ""
- end
-
- redef fun name=(name: String) do
- super
- if introducer != null then
- introducer.as(not null).name = name
- end
- end
-
- # Create an instance of `MemberIntroducer` that will be linked to `self`.
- protected fun create_introducer: INTRODUCER_TYPE is abstract
-
- # Find the nearest reimplementation root.
- fun resolve_introducer: nullable INTRODUCER_TYPE is abstract
-end
-
-# A member.
-abstract class Member
- super MemberOrInner
-
- # Members that this member redefines/reimplements.
- var reimplemented: SimpleCollection[String] = new Array[String]
-
- # Set the static type.
- fun static_type=(static_type: nullable TypeEntity) is abstract
-
- # Get the static type.
- fun static_type: nullable TypeEntity is abstract
-
- # Append the specified parameter to the signature.
- fun add_parameter(parameter: MemberParameter) do end
-
- # Append a member that is reimplemeneted by `self`.
- fun reimplement(parent: String) do
- reimplemented.add(parent)
- end
-
- redef fun is_intro do return reimplemented.length <= 0
-
- # Is the member abstract?
- fun is_abstract=(is_abstract: Bool) do
- self["is_abstract"] = is_abstract
- end
-
- # Find the nearest reimplementation root.
- #
- # var g = new ProjectGraph("foo")
- # var m1 = new Attribute(g)
- # var m2 = new Attribute(g)
- # var m3 = new Attribute(g)
- # #
- # m1.model_id = "1"
- # m1.put_in_graph
- # m2.reimplement("1")
- # m2.put_in_graph
- # assert m1.resolve_introducer == m1.introducer
- # assert m2.resolve_introducer == m1.introducer
- # #
- # m3.model_id = "3"
- # m3.reimplement("3")
- # m3.put_in_graph
- # assert m3.resolve_introducer == null
- redef fun resolve_introducer do
- if introducer == null then
- var member_queue = new List[String]
- var visited = new HashSet[Member]
- var member: Member
-
- member_queue.add_all(reimplemented)
- while not member_queue.is_empty do
- member = graph.by_id[member_queue.shift].as(Member)
- if visited.has(member) then
- return null
- else if member.is_intro then
- return member.introducer
- else
- visited.add(member)
- member_queue.add_all(member.reimplemented)
- end
- end
- return null
- else
- return introducer
- end
- end
-end
-
-# An unrecognized member.
-#
-# Used to simplify the handling of ignored entities.
-class UnknownMember
- super Member
-
- redef fun put_in_graph do end
- redef fun put_edges do end
-end
-
-# A local definition of a method.
-class Method
- super Member
-
- redef type INTRODUCER_TYPE: MethodIntroducer
-
- # The method’s signature.
- var signature: Signature is noinit, writable
-
- init do
- super
- self.labels.add("MMethodDef")
- self["is_intern"] = false # TODO
- self["is_extern"] = false # TODO
- signature = new Signature(graph)
- is_abstract = false
- end
-
- # Set the return type.
- redef fun static_type=(static_type: nullable TypeEntity) do
- signature.return_type = static_type
- end
-
- # Get the return type.
- redef fun static_type: nullable TypeEntity do return signature.return_type
-
- redef fun add_parameter(parameter: MemberParameter) do
- signature.parameters.add(parameter)
- end
-
- redef fun create_introducer do return new MethodIntroducer(graph)
-
- redef fun put_in_graph do
- super
- signature.put_in_graph
- end
-
- redef fun put_edges do
- super
- graph.add_edge(self, "SIGNATURE", signature)
- end
-end
-
-# A local definition of an attribute.
-class Attribute
- super Member
-
- redef type INTRODUCER_TYPE: AttributeIntroducer
-
- # The declared type.
- redef var static_type: nullable TypeEntity = null is writable
-
- init do
- super
- self.labels.add("MAttributeDef")
- end
-
- redef fun create_introducer do return new AttributeIntroducer(graph)
-
- redef fun put_in_graph do
- super
- if static_type != null then
- static_type.as(not null).put_in_graph
- end
- end
-
- redef fun put_edges do
- super
- if static_type != null then
- graph.add_edge(self, "TYPE", static_type.as(not null))
- end
- end
-end
-
-# The `MProperty` node of a root of a reimplementation graph.
-abstract class MemberIntroducer
- super Entity
-
- init do
- super
- self.labels.add("MProperty")
- self["visibility"] = "public"
- end
-
- # Set the visibility.
- fun visibility=(visibility: String) do
- self["visibility"] = visibility
- end
-
- # Get the visibility.
- #
- # Return `""` by default.
- fun visibility: String do
- var visibility = self["visibility"]
- if visibility isa String then return visibility
- return ""
- end
-end
-
-# A `MProperty` node for a method.
-class MethodIntroducer
- super MemberIntroducer
-
- init do
- super
- self.labels.add("MMethod")
- self["is_init"] = false # TODO
- end
-end
-
-# A `MProperty` node for an attribute.
-class AttributeIntroducer
- super MemberIntroducer
-
- init do
- super
- self.labels.add("MAttribute")
- end
-end
-
-redef class Compound
- # Append the specified member.
- fun declare_member(member: Member) do end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# The model used to populate the Neo4j graph.
-module model
-
-import location
-import linked_text
-import graph
-import class_compound
-import module_compound
-import member
-import inner_class
-import namespace_members
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Nodes for modules and files.
-module model::module_compound
-
-import graph
-import class_compound
-import namespace_members
-
-# A source file.
-#
-# Creates one modules by inner namespace. The full name of the modules begin
-# with the namespace’s full name, and end with the unqualified name of the file,
-# without the extension.
-#
-# Note: If a module associated to the root namespace is needed, it is added to
-# the graph only when `put_edges` is called.
-class FileCompound
- super Compound
- super CodeBlock
-
- # Modules corresponding to the namespaces defined/redefined in the file.
- private var inner_namespaces = new Array[Module]
-
- # `model_id` of the classes declared in the file.
- private var inner_classes = new Array[String]
-
- # The last component of the path, without the extension.
- #
- # Used as the unqualified name of the modules.
- private var basename: String = ""
-
- init do
- super
- end
-
- redef fun location=(location) do
- super
- for m in inner_namespaces do m.location = location
- end
-
- redef fun name=(name) do
- # Example: `MyClass.java`
- super
- var match = name.search_last(".")
-
- if match == null then
- basename = name
- else
- basename = name.substring(0, match.from)
- end
- # Update the modules’ name.
- for m in inner_namespaces do m.update_name
- end
-
- redef fun declare_namespace(id, full_name) do
- var m: Module
-
- assert not full_name.is_empty or id.is_empty else
- sys.stderr.write "Inner mamespace declarations without name are not yet supported (except for the root namespace).\n"
- end
- m = new Module(graph, self, new NamespaceRef(id, full_name))
- m.location = location
- inner_namespaces.add m
- end
-
- redef fun declare_class(id, name, prot) do
- assert not id.is_empty else
- sys.stderr.write "Inner class declarations without ID are not yet supported.\n"
- end
- inner_classes.add id
- end
-
- redef fun put_in_graph do
- # Do not add `self` to the Neo4j graph...
- # ... but add its modules...
- for m in inner_namespaces do m.put_in_graph
- # ... and add `self` to the indexes.
- if model_id != "" then graph.by_id[model_id] = self
- graph.files.add self
- end
-
- # If the file contains some classes in the root namespace, add an implicit
- # module to handle them.
- #
- # This method is called by `ProjectGraph.add_global_modules` and assumes
- # that all the namespaces are already fully set and put in the graph.
- fun declare_root_namespace do
- if has_globals then
- declare_namespace("", "")
- inner_namespaces.last.put_in_graph
- end
- end
-
- # Does this file contain classes in the root namespace?
- private fun has_globals: Bool do
- var root = graph.by_id[""]
- for c in inner_classes do
- if graph.class_to_ns[c] == root then return true
- end
- return false
- end
-end
-
-# A `MModule` node.
-#
-# For each file, there is one module by inner namespace.
-private class Module
- super Compound
- super CodeBlock
-
- # The file that declares the module.
- var file_compound: FileCompound
-
- # The namespace defined or redefined by the module.
- var namespace: NamespaceRef
-
- init do
- super
- self.labels.add("MModule")
- update_name
- end
-
- # Update the `name`.
- #
- # Update the short name of the module to the `basename` of the file that
- # declares it.
- fun update_name do name = file_compound.basename
-
- redef fun put_edges do
- var ns_compound = namespace.seek_in(graph)
- var self_class = ns_compound.self_class
- var class_count = 0
- var last_class: nullable ClassCompound = null
-
- graph.add_edge(ns_compound, "DECLARES", self)
-
- for c in file_compound.inner_classes do
- if graph.class_to_ns[c] != ns_compound then continue
- var class_compound = graph.by_id[c].as(ClassCompound)
- last_class = class_compound
- class_count += 1
- graph.add_edge(self, "INTRODUCES", class_compound)
- graph.add_edge(self, "DEFINES", class_compound.class_def)
- end
-
- if self_class isa SelfClass then
- # We assume that only one file is linked to the namespace.
- # TODO When Doxygen will provide a way to know which file defines which member, use it.
- self_class.location = file_compound.location
- graph.add_edge(self, "INTRODUCES", self_class)
- graph.add_edge(self, "DEFINES", self_class.class_def)
- end
-
- if doc.is_empty and class_count == 1 then
- doc = last_class.as(not null).doc
- end
- if doc.is_empty then doc = file_compound.doc
- if doc.is_empty then doc = ns_compound.doc
- if not doc.is_empty then set_mdoc
- end
-end
-
-# Adds the `add_global_modules` phase to `ProjectGraph`.
-redef class ProjectGraph
-
- # Project’s source files.
- var files: SimpleCollection[FileCompound] = new Array[FileCompound]
-
- # Add the modules that define the root namespace.
- #
- # **Must** be called before any call to `put_edges`, and after all the
- # namespaces are fully set and put in the graph.
- #
- # Note: This method is not idempotent so it has to be called only once.
- fun add_global_modules do
- for f in files do f.declare_root_namespace
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Add support for namespace’s members.
-module model::namespace_members
-
-import class_compound
-import member
-
-redef class Namespace
- # The class that contains the namespace’s direct members.
- #
- # Left `null` for the root namespace and for any namespace with no direct
- # member. Automatically put in the graph with the namespace.
- #
- # Note: In the graph, the `self_class` not linked directly to the namespace.
- # This is the role of the modules implicitly created by `FileCompound`s to
- # link a namespace to its `self_class`.
- #
- # SEE: `declare_member`
- var self_class: nullable SelfClass = null
-
- # Add the specified member as a direct children of the namespace.
- redef fun declare_member(member) do
- if self_class == null then self_class = new SelfClass(graph, self)
- self_class.as(not null).declare_member(member)
- end
-
- redef fun put_in_graph do
- super
- var self_class = self.self_class
- if self_class isa SelfClass then self_class.put_in_graph
- end
-end
-
-redef class RootNamespace
- redef fun declare_member(member) do
- assert false else
- # TODO Check how Doxygen modelize member of the root namespace.
- # Note: Doxygen does not modelize the root namespace.
- sys.stderr.write "The addition of a member to the root namespace is not supported yet."
- end
- end
-end
-
-# A class that contains a namespace’s direct members.
-class SelfClass
- super ClassCompound
-
- # The namespace of the members
- var namespace: Namespace
-
- init do
- super
- name = "(self)"
- end
-
- redef fun put_in_graph do
- if doc.is_empty then doc = namespace.doc
- super
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Typing and parameters.
-module model::type_entity
-
-import graph
-import linked_text
-
-# Base class of all types and signatures.
-abstract class TypeEntity
- super Entity
-
- init do
- super
- self.labels.add("MType")
- end
-end
-
-# A type parameter or a type argument.
-#
-# Note : The class relationship and the rank are set by `MClassType.put_edges`.
-class TypeParameter
- super TypeEntity
- super Parameter
-
- init do
- super
- self.labels.add("MParameterType")
- end
-end
-
-
-# A type described by a text.
-class RawType
- super TypeEntity
- super LinkedText
-
- init do
- super
- self.labels.add("MRawType")
- end
-
- redef fun create_link(rank, refid) do return new TypeLink(graph, refid)
-end
-
-# A link in a `RawType`.
-class TypeLink
- super Link
-
- init do
- super
- self.labels.add("MTypePart")
- end
-end
-
-
-# A signature of a method.
-class Signature
- super TypeEntity
-
- # The parameters.
- var parameters = new Array[MemberParameter]
-
- # The static type of the returned value.
- var return_type: nullable TypeEntity = null is writable
-
- init do
- super
- self.labels.add("MSignature")
- end
-
- redef fun put_in_graph do
- super
- if return_type isa TypeEntity then
- return_type.as(TypeEntity).put_in_graph
- end
- for p in parameters do
- p.put_in_graph
- end
- end
-
- redef fun put_edges do
- super
- if parameters.length > 0 then
- var names = new JsonArray
-
- for i in [0..parameters.length[ do
- var p = parameters[i]
- p.rank = i
- names.add(p.name)
- graph.add_edge(self, "PARAMETER", p)
- end
- self["parameter_names"] = names
- end
- if return_type != null then
- graph.add_edge(self, "RETURNTYPE", return_type.as(not null))
- end
- end
-end
-
-# A parameter or an argument.
-abstract class Parameter
- super Entity
-
- # The static type of the parameter.
- var static_type: nullable TypeEntity = null is writable
-
- init do
- super
- self["is_vararg"] = false
- self["rank"] = -1
- end
-
- # Is the parameter a “vararg”?
- fun is_vararg=(is_vararg: Bool) do
- self["is_vararg"] = is_vararg
- end
-
- # Is the parameter a “vararg”?
- fun is_vararg: Bool do
- var value = self["is_vararg"]
- assert value isa Bool
- return value
- end
-
- # Set the rank (index) of the parameter in the signature.
- fun rank=(rank: Int) do
- self["rank"] = rank
- end
-
- redef fun put_in_graph do
- super
- if static_type != null then
- static_type.as(not null).put_in_graph
- end
- end
-
- redef fun put_edges do
- super
- graph.add_edge(self, "TYPE", static_type.as(not null))
- end
-end
-
-# A parameter of a member.
-#
-# Note : The rank are set by `Signature.put_edges`.
-class MemberParameter
- super Parameter
-
- init do
- super
- self.labels.add("MParameter")
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Doxygen XML to Neo4j.
-#
-# Converts a Doxygen XML output into a model in Neo4j that is readable by the
-# `nx` tool.
-module neo_doxygen
-
-import model
-import doxml
-import graph_store
-import console
-import opts
-
-# An importation task.
-class NeoDoxygenJob
-
- # The storage medium to use.
- var store: GraphStore
-
- # The loaded project graph.
- var model: ProjectGraph is noinit
-
- # Escape control sequence to save the cursor position.
- private var term_save_cursor: String = (new TermSaveCursor).to_s
-
- # Escape control sequence to rewind to the last saved cursor position.
- private var term_rewind: String = "{new TermRestoreCursor}{new TermEraseDisplayDown}"
-
- # Generate a graph from the specified project model.
- #
- # Parameters:
- #
- # * `name`: project name.
- # * `dir`: Doxygen XML output directory path.
- # * `source`: The language-specific logics to use.
- fun load_project(name: String, dir: String, source: SourceLanguage) do
- check_name name
- model = new ProjectGraph(name)
- var reader = new CompoundFileReader(model, source)
- # Queue for sub-directories.
- var directories = new Array[String]
- var file_count = 0
-
- if dir == "" then
- printn "Reading the current directory... "
- else
- printn "Reading {dir}... "
- end
- loop
- for f in list_files(dir) do
- var path = dir/f
- if path.file_stat.as(not null).is_dir then
- directories.push(path)
- else if f.has_suffix(".xml") and f != "index.xml" then
- reader.read(path)
- file_count += 1
- end
- end
- if directories.length <= 0 then break
- dir = directories.pop
- end
- model.add_global_modules
- print "Done."
- if file_count < 2 then
- print "{file_count} file read."
- else
- print "{file_count} files read."
- end
- end
-
- # List files in a directory.
- #
- # This method may be redefined to force the order in which the files
- # are read by `load_project`.
- protected fun list_files(dir: String): Collection[String] do
- return dir.files
- end
-
- # Check the project’s name.
- private fun check_name(name: String) do
- assert name_valid: not name.chars.first.is_upper else
- sys.stderr.write("{sys.program_name}: The project’s name must not" +
- " begin with an upper case letter. Got `{name}`.\n")
- end
- assert name_unused: not store.has_node_label(name) else
- sys.stderr.write("{sys.program_name}: The label `{name}` is already" +
- " used in the specified graph.\n")
- end
- end
-
- # Save the graph.
- fun save do
- sys.stdout.write "Linking nodes...{term_save_cursor} "
- model.put_edges
- print "{term_rewind} Done."
- var nodes = model.all_nodes
- sys.stdout.write "Saving {nodes.length} nodes..."
- store.save_all(nodes)
- var edges = model.all_edges
- sys.stdout.write "Saving {edges.length} edges..."
- store.save_all(edges)
- end
-end
-
-# The main class.
-class NeoDoxygenCommand
-
- # Invalid arguments
- var e_usage = 64
-
- # Available options for `--src-lang`.
- var sources = new HashMap[String, SourceLanguage]
-
- # The synopsis.
- var synopsis: String = "[--dest <url>] [--src-lang <lang>]\n" +
- " [--] <project_name> <doxml_dir>"
-
- # The synopsis for the help page.
- var help_synopsis = "[-h|--help]"
-
- # The default destination.
- var default_dest = "http://localhost:7474"
-
- # Processes the options.
- var option_context = new OptionContext
-
- # The `--src-lang` option.
- var opt_src_lang: OptionEnum is noinit
-
- # The `--dest` option.
- var opt_dest: OptionString is noinit
-
- # The `-h|--help` option.
- var opt_help: OptionBool is noinit
-
- init do
- sources["any"] = new DefaultSource
- sources["java"] = new JavaSource
- sources["python"] = new PythonSource
-
- var prefix = new OptionText("""
-{{{"NAME".bold}}}
- {{{sys.program_name}}} — Doxygen XML to Neo4j.
-
-{{{"SYNOPSIS".bold}}}
- {{{sys.program_name}}} {{{synopsis}}}
- {{{sys.program_name}}} {{{help_synopsis}}}
-
-{{{"DESCRIPTION".bold}}}
- Convert a Doxygen XML output into a model in Neo4j that is readable by the
- `nx` tool.
-
-{{{"ARGUMENTS".bold}}}
- <project_name> The internal name of the project. Must the same name as the
- one specified to the `nx` tool. Must not begin by an upper
- case letter.
-
- <doxml_dir> The directory where the XML documents generated by Doxygen are
- located.
-
-{{{"OPTIONS".bold}}}
-""")
- option_context.add_option(prefix)
-
- opt_dest = new OptionString("The URL of the destination graph. `{default_dest}` by default.",
- "--dest")
- opt_dest.default_value = default_dest
- option_context.add_option(opt_dest)
-
- opt_help = new OptionBool("Show the help (this page).",
- "-h", "--help")
- option_context.add_option(opt_help)
-
- var keys = new Array[String].from(sources.keys)
- opt_src_lang = new OptionEnum(keys,
- "The programming language to assume when processing chunks in the declarations left as-is by Doxygen. Use `any` (the default) to disable any language-specific processing.",
- keys.index_of("any"), "--src-lang")
- option_context.add_option(opt_src_lang)
- end
-
- # Start the application.
- fun main: Int do
- if args.is_empty then
- show_help
- return e_usage
- end
- option_context.parse(args)
-
- var errors = option_context.errors
- var rest = option_context.rest
-
- if errors.is_empty and not opt_help.value and rest.length != 2 then
- errors.add "Unexpected number of additional arguments. Expecting 2; got {rest.length}."
- end
- if not errors.is_empty then
- for e in errors do print_error(e)
- show_usage
- return e_usage
- end
- if opt_help.value then
- show_help
- return 0
- end
-
- var source = sources[opt_src_lang.value_name]
- var dest = opt_dest.value
- var project_name = rest[0]
- var dir = rest[1]
- var neo = new NeoDoxygenJob(create_store(dest or else default_dest))
-
- neo.load_project(project_name, dir, source)
- neo.save
- return 0
- end
-
- # Create an instance of `GraphStore` for the specified destination.
- protected fun create_store(dest: String): GraphStore do
- return new Neo4jStore(new Neo4jClient(dest))
- end
-
- # Show the help.
- fun show_help do
- option_context.usage
- end
-
- # Show the usage.
- fun show_usage do
- sys.stderr.write "Usage: {sys.program_name} {synopsis}\n"
- sys.stderr.write "For details, run `{sys.program_name} --help`.\n"
- end
-
- # Print an error.
- fun print_error(e: String) do
- sys.stderr.write "{sys.program_name}: {e}\n"
- end
-end
-
-# Add handling of multi-line descriptions.
-#
-# Note: The algorithm is naive and do not handle internationalisation,
-# multi-byte characters and control characters.
-redef class Option
-
- redef fun pretty(off) do
- var s = super
-
- if s.length > 80 and off < 80 then
- var column_length = 80 - off
- var left = 0
- var right = 80
- var buf = new FlatBuffer
- var prefix = "\n{" " * off}"
-
- loop
- while right > left and s.chars[right] != ' ' do
- right -= 1
- end
- if left == right then
- buf.append s.substring(left, column_length)
- right += column_length
- else
- buf.append s.substring(left, right - left)
- right += 1
- end
- buf.append prefix
- left = right
- right += column_length
- if right >= s.length then break
- end
- buf.append s.substring_from(left)
- buf.append "\n"
- return buf.to_s
- else
- return "{s}\n"
- end
- end
-end
-
-exit((new NeoDoxygenCommand).main)
+++ /dev/null
-Test scripts for `neo_doxygen`.
-
-The name of each test script is prefixed by `neo_doxygen_` to avoid name
-conflicts in `/tests/sav` and `/tests/out`. The expected output of each script
-is saved as a `*.res` file in `/tests/sav`.
-
-Note: All paths indicated here are relative to the root of the repository.
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import tests
-intrude import model::module_compound
-
-var graph = new ProjectGraph("foo")
-var file = new FileCompound(graph)
-var bar_class = new ClassCompound(graph)
-var a_ns = new Namespace(graph)
-
-file.full_name = "Baz.java"
-file.declare_class("classa_bar", "a::Bar", "public")
-file.declare_namespace("namespacea", "a")
-file.doc.brief_description = "A file."
-file.put_in_graph
-
-a_ns.full_name = "a"
-a_ns.model_id = "namespacea"
-a_ns.declare_class("classa_bar", "a::Bar", "public")
-a_ns.doc.brief_description = "A namespace."
-a_ns.put_in_graph
-
-bar_class.model_id = "classa_bar"
-bar_class.full_name = "a::Bar"
-bar_class.doc.brief_description = "A class."
-bar_class.put_in_graph
-
-graph.add_global_modules
-graph.put_edges
-
-assert file.inner_namespaces[0]["mdoc"] == bar_class.doc
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# A variant of the `neo_doxygen` program that produces a debugging output of the graph instead of saving it.
-#
-# Note: The `--dest` option is ignored.
-module tests::neo_doxygen_dump
-
-import tests
-import neo_doxygen
-
-redef class Sys
- redef fun program_name do return "%PROGRAM_NAME%"
-end
-
-redef class NeoDoxygenJob
- redef fun list_files(dir) do
- var a = super.to_a
- default_comparator.sort(a)
- return a
- end
-end
-
-redef class NeoDoxygenCommand
- redef fun create_store(url) do return new DebugStore
-end
-
-# Dummy storage medium that write a debugging output to the standard output.
-#
-# For testing purposes only.
-class DebugStore
- super GraphStore
-
- redef fun has_node_label(name) do return false
-
- redef fun save_all(neo_entities) do
- print ""
- for n in neo_entities do
- if n isa NeoEdge then
- var buffer = new Buffer
- n.debug buffer
- print buffer
- end
- end
- print "---===DONE===---"
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import tests
-import model::module_compound
-
-var graph = new ProjectGraph("foo")
-var file = new FileCompound(graph)
-var file_2 = new FileCompound(graph)
-var bar_class = new ClassCompound(graph)
-var baz_class = new ClassCompound(graph)
-var a_ns = new Namespace(graph)
-var b_ns = new Namespace(graph)
-var c_ns = new Namespace(graph)
-var d_ns = new Namespace(graph)
-var buffer = new Buffer
-var root_ns = graph.by_id[""].as(Namespace)
-var location
-
-file.name = "Bar.java"
-file.model_id = "_Bar_8java"
-location = new neo_doxygen::Location
-location.path = "a/b/Bar.java"
-file.location = location
-file.declare_class("classa_b_bar", "a::b::Bar", "package")
-file.declare_class("classbaz", "Baz", "")
-file.declare_namespace("", "a::b")
-file.doc.brief_description = "The first file."
-file.put_in_graph
-
-file_2.name = "Bar.java"
-file_2.model_id = "_Bar_8java_2"
-location = new neo_doxygen::Location
-location.path = "Bar.java"
-file_2.location = location
-file_2.declare_namespace("namespacec", "c")
-file_2.declare_namespace("", "d")
-file_2.put_in_graph
-
-bar_class.model_id = "classa_b_bar"
-bar_class.name = "Bar"
-location = new neo_doxygen::Location
-location.path = "a/b/Bar.class"
-location.line_start = 5
-location.column_start = 1
-location.line_end = 100
-location.column_end = 10
-bar_class.location = location
-bar_class.put_in_graph
-
-baz_class.model_id = "classbaz"
-baz_class.name = "Baz"
-location = new neo_doxygen::Location
-location.path = "Baz.jar"
-baz_class.location = location
-baz_class.put_in_graph
-
-root_ns.declare_namespace("", "a")
-root_ns.declare_namespace("namespacec", "c")
-root_ns.declare_namespace("", "d")
-
-a_ns.name = "a"
-a_ns.full_name = "a"
-a_ns.declare_namespace("", "a::b")
-a_ns.put_in_graph
-
-b_ns.name = "b"
-b_ns.full_name = "a::b"
-b_ns.declare_class("classa_b_bar", "", "")
-b_ns.put_in_graph
-
-c_ns.model_id = "namespacec"
-c_ns.name = "c"
-c_ns.full_name = "c"
-c_ns.put_in_graph
-
-d_ns.model_id = "namespaced"
-d_ns.name = "d"
-d_ns.full_name = "d"
-d_ns.put_in_graph
-
-print "---===WITHOUT GLOBALS===---"
-graph.put_edges
-graph.debug buffer
-print buffer
-
-print "---===WITH GLOBALS===---"
-buffer.clear
-graph.add_global_modules
-graph.put_edges
-graph.debug buffer
-print buffer
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import tests
-
-var graph = new ProjectGraph("foo")
-var buffer = new Buffer
-
-graph.put_edges
-graph.debug buffer
-print buffer
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import tests
-import model
-
-var graph = new ProjectGraph("foo")
-var file = new FileCompound(graph)
-var root_ns = graph.by_id[""].as(Namespace)
-var ns = new Namespace(graph)
-var member = new Attribute(graph)
-var buffer = new Buffer
-
-file.name = "foo.py"
-file.model_id = "_foo_8py"
-file.declare_namespace("namespacefoo", "foo")
-file.put_in_graph
-
-member.name = "bar"
-member.put_in_graph
-
-ns.model_id = "namespacefoo"
-ns.name = "foo"
-ns.declare_member(member)
-ns.doc.brief_description = "A documented namespace."
-ns.put_in_graph
-
-root_ns.declare_namespace("namespacefoo", "")
-
-graph.add_global_modules
-graph.put_edges
-graph.debug buffer
-print buffer
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Base module for tests related to `neo_doxygen`.
-module tests::tests
-
-import model::graph
-
-# Adds debugging output to graphs.
-redef class NeoGraph
-
- # Append the debugging output of all relationships to the specified buffer.
- fun debug(buffer: Buffer) do
- buffer.append "# Graph\n"
- for edge in all_edges do
- edge.debug buffer
- end
- end
-end
-
-# Adds debugging output to relationships.
-redef class NeoEdge
-
- # Append the debugging output of this relationship to the specified buffer.
- #
- # Append the relationship type, the properties, and the debugging output of
- # both extremities.
- fun debug(buffer: Buffer) do
- var rel_type = self.rel_type or else "?"
- buffer.append "Edge\n"
- buffer.append "=type={rel_type.length}:{rel_type}\n"
- buffer.append "=properties=JsonObject({properties.length}):\n"
- buffer.append properties.to_json
- buffer.append "\n----\n=from="
- from.debug buffer
- buffer.append "----\n=to="
- to.debug buffer
- buffer.append "\n"
- end
-end
-
-# Adds debugging output to nodes.
-redef class NeoNode
-
- # Append the debugging output of this node to the specified buffer.
- #
- # Append the labels and the properties.
- fun debug(buffer: Buffer) do
- buffer.append "Node\n"
- buffer.append "=labels=Array({labels.length}):\n"
- for lab in labels do buffer.append "{lab.length}:{lab}\n"
- buffer.append "=properties=JsonObject({properties.length}):\n"
- buffer.append properties.to_json
- buffer.append "\n"
- end
-end
-
-# Adds debugging output to entities.
-redef class Entity
-
- # Append the debugging output of this entity to the specified buffer.
- #
- # Append the `model_id`, the labels and the properties.
- redef fun debug(buffer) do
- buffer.append "Entity#{model_id.length}:{model_id}\n"
- buffer.append "=labels=Array({labels.length}):\n"
- for lab in labels do buffer.append "{lab.length}:{lab}\n"
- buffer.append "=properties=JsonObject({properties.length}):\n"
- buffer.append properties.to_json
- buffer.append "\n"
- end
-end
+++ /dev/null
-/*/xml/* -diff
+++ /dev/null
-/*/Makefile
-/*/.nx_config
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# All the dummy projects.
-PROJECTS=$(dir $(wildcard ./*/Doxyfile))
-
-.PHONY: xml bootstrap
-
-# Regenerate the XML documents.
-xml: bootstrap
- for p in $(PROJECTS); do $(MAKE) -C "$$p" xml || exit; done
-
-# Generate the Makefiles in the sub-directories.
-bootstrap:
- for p in $(PROJECTS); do { \
- echo '# FILE GENERATED BY ../Makefile'"\n" > "$$p/Makefile" || exit; \
- cat doxyproject.mk >> "$$p/Makefile" || exit; \
- } ; done
+++ /dev/null
-Data files for tests.
-
-For test scripts, see `../src/tests`. To regenerate the XML documents, run
-`make`.
-
-## Required to Generate the XML documents
-
-* [Doxygen](http://www.doxygen.org/)
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-.PHONY: clean doxygen strip_paths xml
-
-# Regenerate the XML documents.
-xml: strip_paths
-
-clean:
- rm -rf xml
-
-doxygen: clean
- doxygen Doxyfile
-
-# Get rid of the absolute paths in the generated files.
-#
-# Doxygen ignores the `STRIP_FROM_PATH` setting when generating a XML output.
-# So, we have to replace the paths manually in order to get reproducible
-# results.
-#
-# WARNING: FOR USE ON TEST DATA ONLY.
-strip_paths: doxygen
- . ../../sh-lib/more_sed.sh; \
- replace `readlink -f -- ./src` '%SOURCE_DIRECTORY%' xml/*.xml
+++ /dev/null
-# Doxyfile 1.8.8
-
-# 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 = "Test Project"
-
-# 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 =
-
-# 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 =
-
-# With the PROJECT_LOGO tag one can specify a logo or an 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
-
-# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
-# characters to appear in the names of generated files. If set to NO, non-ASCII
-# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
-# U+3044.
-# The default value is: NO.
-
-ALLOW_UNICODE_NAMES = 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 = YES
-
-# 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
-
-# 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 =
-
-# 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 (fixed format Fortran:
-# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
-# Fortran. In the later case the parser tries to guess whether the code is fixed
-# or free formatted code, this is the default for Fortran type files), 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 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. If 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 = NO
-
-# 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 = YES
-
-# 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 =
-
-# 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. 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 = src
-
-# 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 =
-
-# 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 =
-
-# 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 =
-
-# 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 = *
-
-# 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 =
-
-# 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 =
-
-#---------------------------------------------------------------------------
-# 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 = NO
-
-# 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 additional user-defined
-# cascading style sheets that are 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 therefore more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
-# Note: The order of the extra stylesheet files is of importance (e.g. the last
-# stylesheet in the list overrules the setting of the previous ones in the
-# list). 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. Furthermore it
-# enables the Previous and Next buttons.
-# 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
-
-# If 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 pre-rendered 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 flavors 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,
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# string, for the replacement values of the other commands the user is referred
-# to HTML_HEADER.
-# 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. See
-# LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the 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 USE_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
-
-# The MAN_SUBDIR tag determines the name of the directory created within
-# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
-# MAN_EXTENSION with the initial . removed.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_SUBDIR =
-
-# 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
-
-# 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 = NO
-
-#---------------------------------------------------------------------------
-# 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
-
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
-#---------------------------------------------------------------------------
-# 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 include 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 references 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 a 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 = YES
-
-# 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 = NO
-
-# 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 in 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 = YES
-
-# 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 = NO
-
-# 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 = NO
-
-# 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 =
-
-# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
-# path where java can find the plantuml.jar file. If left blank, it is assumed
-# PlantUML is not used or called during a preprocessing step. Doxygen will
-# generate a warning when it encounters a \startuml command in this case and
-# will not generate output for the diagram.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-PLANTUML_JAR_PATH =
-
-# 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 to 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
+++ /dev/null
-This directory contains an empty project for testing purposes.
-
-To regenerate the XML output located in `xml`, run `make`. If the `Makefile`
-does not exists, you can regenerate it by running `make bootstrap` in the parent
-directory.
+++ /dev/null
-<!-- XSLT script to combine the generated output into a single file.
- If you have xsltproc you could use:
- xsltproc combine.xslt index.xml >all.xml
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
- <xsl:output method="xml" version="1.0" indent="no" standalone="yes" />
- <xsl:template match="/">
- <doxygen version="{doxygenindex/@version}">
- <!-- Load all doxgen generated xml files -->
- <xsl:for-each select="doxygenindex/compound">
- <xsl:copy-of select="document( concat( @refid, '.xml' ) )/doxygen/*" />
- </xsl:for-each>
- </doxygen>
- </xsl:template>
-</xsl:stylesheet>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygen" type="DoxygenType"/>
-
- <!-- Complex types -->
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="compounddef" type="compounddefType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="version" type="DoxVersionNumber" use="required" />
- </xsd:complexType>
-
- <xsd:complexType name="compounddefType">
- <xsd:sequence>
- <xsd:element name="compoundname" type="xsd:string"/>
- <xsd:element name="title" type="xsd:string" minOccurs="0" />
- <xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="incdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inheritancegraph" type="graphType" minOccurs="0" />
- <xsd:element name="collaborationgraph" type="graphType" minOccurs="0" />
- <xsd:element name="programlisting" type="listingType" minOccurs="0" />
- <xsd:element name="location" type="locationType" minOccurs="0" />
- <xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="kind" type="DoxCompoundKind" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="abstract" type="DoxBool" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listofallmembersType">
- <xsd:sequence>
- <xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="memberRefType">
- <xsd:sequence>
- <xsd:element name="scope" />
- <xsd:element name="name" />
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- <xsd:attribute name="ambiguityscope" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="compoundRefType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" use="optional" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="reimplementType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="incType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="local" type="DoxBool" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refTextType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- <xsd:attribute name="tooltip" type="xsd:string" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="sectiondefType">
- <xsd:sequence>
- <xsd:element name="header" type="xsd:string" minOccurs="0" />
- <xsd:element name="description" type="descriptionType" minOccurs="0" />
- <xsd:element name="memberdef" type="memberdefType" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="memberdefType">
- <xsd:sequence>
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="definition" minOccurs="0" />
- <xsd:element name="argsstring" minOccurs="0" />
- <xsd:element name="name" />
- <xsd:element name="read" minOccurs="0" />
- <xsd:element name="write" minOccurs="0" />
- <xsd:element name="bitfield" minOccurs="0" />
- <xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="exceptions" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="location" type="locationType" />
- <xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxMemberKind" />
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="static" type="DoxBool" />
- <xsd:attribute name="const" type="DoxBool" use="optional"/>
- <xsd:attribute name="explicit" type="DoxBool" use="optional"/>
- <xsd:attribute name="inline" type="DoxBool" use="optional"/>
- <xsd:attribute name="virt" type="DoxVirtualKind" use="optional"/>
- <xsd:attribute name="volatile" type="DoxBool" use="optional"/>
- <xsd:attribute name="mutable" type="DoxBool" use="optional"/>
- <!-- Qt property -->
- <xsd:attribute name="readable" type="DoxBool" use="optional"/>
- <xsd:attribute name="writable" type="DoxBool" use="optional"/>
- <!-- C++/CLI variable -->
- <xsd:attribute name="initonly" type="DoxBool" use="optional"/>
- <!-- C++/CLI and C# property -->
- <xsd:attribute name="settable" type="DoxBool" use="optional"/>
- <xsd:attribute name="gettable" type="DoxBool" use="optional"/>
- <!-- C++/CLI function -->
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="new" type="DoxBool" use="optional"/>
- <!-- C++/CLI event -->
- <xsd:attribute name="add" type="DoxBool" use="optional"/>
- <xsd:attribute name="remove" type="DoxBool" use="optional"/>
- <xsd:attribute name="raise" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 protocol method -->
- <xsd:attribute name="optional" type="DoxBool" use="optional"/>
- <xsd:attribute name="required" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 property accessor -->
- <xsd:attribute name="accessor" type="DoxAccessor" use="optional"/>
- <!-- UNO IDL -->
- <xsd:attribute name="attribute" type="DoxBool" use="optional"/>
- <xsd:attribute name="property" type="DoxBool" use="optional"/>
- <xsd:attribute name="readonly" type="DoxBool" use="optional"/>
- <xsd:attribute name="bound" type="DoxBool" use="optional"/>
- <xsd:attribute name="removable" type="DoxBool" use="optional"/>
- <xsd:attribute name="contrained" type="DoxBool" use="optional"/>
- <xsd:attribute name="transient" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybevoid" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybedefault" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybeambiguous" type="DoxBool" use="optional"/>
-
- </xsd:complexType>
-
- <xsd:complexType name="descriptionType" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" minOccurs="0"/>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="enumvalueType" mixed="true">
- <xsd:sequence>
- <xsd:element name="name" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="templateparamlistType">
- <xsd:sequence>
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="paramType">
- <xsd:sequence>
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="declname" minOccurs="0" />
- <xsd:element name="defname" minOccurs="0" />
- <xsd:element name="array" minOccurs="0" />
- <xsd:element name="defval" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="linkedTextType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="graphType">
- <xsd:sequence>
- <xsd:element name="node" type="nodeType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="nodeType">
- <xsd:sequence>
- <xsd:element name="label" />
- <xsd:element name="link" type="linkType" minOccurs="0" />
- <xsd:element name="childnode" type="childnodeType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="childnodeType">
- <xsd:sequence>
- <xsd:element name="edgelabel" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="relation" type="DoxGraphRelation" />
- </xsd:complexType>
-
- <xsd:complexType name="linkType">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listingType">
- <xsd:sequence>
- <xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="codelineType">
- <xsd:sequence>
- <xsd:element name="highlight" type="highlightType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="lineno" type="xsd:integer" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="refkind" type="DoxRefKind" />
- <xsd:attribute name="external" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="highlightType" mixed="true">
- <xsd:choice minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="sp" />
- <xsd:element name="ref" type="refTextType" />
- </xsd:choice>
- <xsd:attribute name="class" type="DoxHighlightClass" />
- </xsd:complexType>
-
- <xsd:complexType name="referenceType" mixed="true">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="compoundref" type="xsd:string" use="optional" />
- <xsd:attribute name="startline" type="xsd:integer" />
- <xsd:attribute name="endline" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="locationType">
- <xsd:attribute name="file" type="xsd:string" />
- <xsd:attribute name="line" type="xsd:integer" />
- <xsd:attribute name="column" type="xsd:integer" use="optional"/>
- <xsd:attribute name="bodyfile" type="xsd:string" />
- <xsd:attribute name="bodystart" type="xsd:integer" />
- <xsd:attribute name="bodyend" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS1Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS2Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect4" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS3Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS4Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docInternalType" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docTitleCmdGroup">
- <xsd:choice>
- <xsd:element name="ulink" type="docURLLink" />
- <xsd:element name="bold" type="docMarkupType" />
- <xsd:element name="emphasis" type="docMarkupType" />
- <xsd:element name="computeroutput" type="docMarkupType" />
- <xsd:element name="subscript" type="docMarkupType" />
- <xsd:element name="superscript" type="docMarkupType" />
- <xsd:element name="center" type="docMarkupType" />
- <xsd:element name="small" type="docMarkupType" />
- <xsd:element name="htmlonly" type="xsd:string" />
- <xsd:element name="manonly" type="xsd:string" />
- <xsd:element name="xmlonly" type="xsd:string" />
- <xsd:element name="rtfonly" type="xsd:string" />
- <xsd:element name="latexonly" type="xsd:string" />
- <xsd:element name="dot" type="xsd:string" />
- <xsd:element name="plantuml" type="xsd:string" />
- <xsd:element name="anchor" type="docAnchorType" />
- <xsd:element name="formula" type="docFormulaType" />
- <xsd:element name="ref" type="docRefTextType" />
- <xsd:element name="nonbreakablespace" type="docEmptyType" />
- <xsd:element name="iexcl" type="docEmptyType" />
- <xsd:element name="cent" type="docEmptyType" />
- <xsd:element name="pound" type="docEmptyType" />
- <xsd:element name="curren" type="docEmptyType" />
- <xsd:element name="yen" type="docEmptyType" />
- <xsd:element name="brvbar" type="docEmptyType" />
- <xsd:element name="sect" type="docEmptyType" />
- <xsd:element name="umlaut" type="docEmptyType" />
- <xsd:element name="copy" type="docEmptyType" />
- <xsd:element name="ordf" type="docEmptyType" />
- <xsd:element name="laquo" type="docEmptyType" />
- <xsd:element name="not" type="docEmptyType" />
- <xsd:element name="shy" type="docEmptyType" />
- <xsd:element name="registered" type="docEmptyType" />
- <xsd:element name="macr" type="docEmptyType" />
- <xsd:element name="deg" type="docEmptyType" />
- <xsd:element name="plusmn" type="docEmptyType" />
- <xsd:element name="sup2" type="docEmptyType" />
- <xsd:element name="sup3" type="docEmptyType" />
- <xsd:element name="acute" type="docEmptyType" />
- <xsd:element name="micro" type="docEmptyType" />
- <xsd:element name="para" type="docEmptyType" />
- <xsd:element name="middot" type="docEmptyType" />
- <xsd:element name="cedil" type="docEmptyType" />
- <xsd:element name="sup1" type="docEmptyType" />
- <xsd:element name="ordm" type="docEmptyType" />
- <xsd:element name="raquo" type="docEmptyType" />
- <xsd:element name="frac14" type="docEmptyType" />
- <xsd:element name="frac12" type="docEmptyType" />
- <xsd:element name="frac34" type="docEmptyType" />
- <xsd:element name="iquest" type="docEmptyType" />
- <xsd:element name="Agrave" type="docEmptyType" />
- <xsd:element name="Aacute" type="docEmptyType" />
- <xsd:element name="Acirc" type="docEmptyType" />
- <xsd:element name="Atilde" type="docEmptyType" />
- <xsd:element name="Aumlaut" type="docEmptyType" />
- <xsd:element name="Aring" type="docEmptyType" />
- <xsd:element name="AElig" type="docEmptyType" />
- <xsd:element name="Ccedil" type="docEmptyType" />
- <xsd:element name="Egrave" type="docEmptyType" />
- <xsd:element name="Eacute" type="docEmptyType" />
- <xsd:element name="Ecirc" type="docEmptyType" />
- <xsd:element name="Eumlaut" type="docEmptyType" />
- <xsd:element name="Igrave" type="docEmptyType" />
- <xsd:element name="Iacute" type="docEmptyType" />
- <xsd:element name="Icirc" type="docEmptyType" />
- <xsd:element name="Iumlaut" type="docEmptyType" />
- <xsd:element name="ETH" type="docEmptyType" />
- <xsd:element name="Ntilde" type="docEmptyType" />
- <xsd:element name="Ograve" type="docEmptyType" />
- <xsd:element name="Oacute" type="docEmptyType" />
- <xsd:element name="Ocirc" type="docEmptyType" />
- <xsd:element name="Otilde" type="docEmptyType" />
- <xsd:element name="Oumlaut" type="docEmptyType" />
- <xsd:element name="times" type="docEmptyType" />
- <xsd:element name="Oslash" type="docEmptyType" />
- <xsd:element name="Ugrave" type="docEmptyType" />
- <xsd:element name="Uacute" type="docEmptyType" />
- <xsd:element name="Ucirc" type="docEmptyType" />
- <xsd:element name="Uumlaut" type="docEmptyType" />
- <xsd:element name="Yacute" type="docEmptyType" />
- <xsd:element name="THORN" type="docEmptyType" />
- <xsd:element name="szlig" type="docEmptyType" />
- <xsd:element name="agrave" type="docEmptyType" />
- <xsd:element name="aacute" type="docEmptyType" />
- <xsd:element name="acirc" type="docEmptyType" />
- <xsd:element name="atilde" type="docEmptyType" />
- <xsd:element name="aumlaut" type="docEmptyType" />
- <xsd:element name="aring" type="docEmptyType" />
- <xsd:element name="aelig" type="docEmptyType" />
- <xsd:element name="ccedil" type="docEmptyType" />
- <xsd:element name="egrave" type="docEmptyType" />
- <xsd:element name="eacute" type="docEmptyType" />
- <xsd:element name="ecirc" type="docEmptyType" />
- <xsd:element name="eumlaut" type="docEmptyType" />
- <xsd:element name="igrave" type="docEmptyType" />
- <xsd:element name="iacute" type="docEmptyType" />
- <xsd:element name="icirc" type="docEmptyType" />
- <xsd:element name="iumlaut" type="docEmptyType" />
- <xsd:element name="eth" type="docEmptyType" />
- <xsd:element name="ntilde" type="docEmptyType" />
- <xsd:element name="ograve" type="docEmptyType" />
- <xsd:element name="oacute" type="docEmptyType" />
- <xsd:element name="ocirc" type="docEmptyType" />
- <xsd:element name="otilde" type="docEmptyType" />
- <xsd:element name="oumlaut" type="docEmptyType" />
- <xsd:element name="divide" type="docEmptyType" />
- <xsd:element name="oslash" type="docEmptyType" />
- <xsd:element name="ugrave" type="docEmptyType" />
- <xsd:element name="uacute" type="docEmptyType" />
- <xsd:element name="ucirc" type="docEmptyType" />
- <xsd:element name="uumlaut" type="docEmptyType" />
- <xsd:element name="yacute" type="docEmptyType" />
- <xsd:element name="thorn" type="docEmptyType" />
- <xsd:element name="yumlaut" type="docEmptyType" />
- <xsd:element name="fnof" type="docEmptyType" />
- <xsd:element name="Alpha" type="docEmptyType" />
- <xsd:element name="Beta" type="docEmptyType" />
- <xsd:element name="Gamma" type="docEmptyType" />
- <xsd:element name="Delta" type="docEmptyType" />
- <xsd:element name="Epsilon" type="docEmptyType" />
- <xsd:element name="Zeta" type="docEmptyType" />
- <xsd:element name="Eta" type="docEmptyType" />
- <xsd:element name="Theta" type="docEmptyType" />
- <xsd:element name="Iota" type="docEmptyType" />
- <xsd:element name="Kappa" type="docEmptyType" />
- <xsd:element name="Lambda" type="docEmptyType" />
- <xsd:element name="Mu" type="docEmptyType" />
- <xsd:element name="Nu" type="docEmptyType" />
- <xsd:element name="Xi" type="docEmptyType" />
- <xsd:element name="Omicron" type="docEmptyType" />
- <xsd:element name="Pi" type="docEmptyType" />
- <xsd:element name="Rho" type="docEmptyType" />
- <xsd:element name="Sigma" type="docEmptyType" />
- <xsd:element name="Tau" type="docEmptyType" />
- <xsd:element name="Upsilon" type="docEmptyType" />
- <xsd:element name="Phi" type="docEmptyType" />
- <xsd:element name="Chi" type="docEmptyType" />
- <xsd:element name="Psi" type="docEmptyType" />
- <xsd:element name="Omega" type="docEmptyType" />
- <xsd:element name="alpha" type="docEmptyType" />
- <xsd:element name="beta" type="docEmptyType" />
- <xsd:element name="gamma" type="docEmptyType" />
- <xsd:element name="delta" type="docEmptyType" />
- <xsd:element name="epsilon" type="docEmptyType" />
- <xsd:element name="zeta" type="docEmptyType" />
- <xsd:element name="eta" type="docEmptyType" />
- <xsd:element name="theta" type="docEmptyType" />
- <xsd:element name="iota" type="docEmptyType" />
- <xsd:element name="kappa" type="docEmptyType" />
- <xsd:element name="lambda" type="docEmptyType" />
- <xsd:element name="mu" type="docEmptyType" />
- <xsd:element name="nu" type="docEmptyType" />
- <xsd:element name="xi" type="docEmptyType" />
- <xsd:element name="omicron" type="docEmptyType" />
- <xsd:element name="pi" type="docEmptyType" />
- <xsd:element name="rho" type="docEmptyType" />
- <xsd:element name="sigmaf" type="docEmptyType" />
- <xsd:element name="sigma" type="docEmptyType" />
- <xsd:element name="tau" type="docEmptyType" />
- <xsd:element name="upsilon" type="docEmptyType" />
- <xsd:element name="phi" type="docEmptyType" />
- <xsd:element name="chi" type="docEmptyType" />
- <xsd:element name="psi" type="docEmptyType" />
- <xsd:element name="omega" type="docEmptyType" />
- <xsd:element name="thetasym" type="docEmptyType" />
- <xsd:element name="upsih" type="docEmptyType" />
- <xsd:element name="piv" type="docEmptyType" />
- <xsd:element name="bull" type="docEmptyType" />
- <xsd:element name="hellip" type="docEmptyType" />
- <xsd:element name="prime" type="docEmptyType" />
- <xsd:element name="Prime" type="docEmptyType" />
- <xsd:element name="oline" type="docEmptyType" />
- <xsd:element name="frasl" type="docEmptyType" />
- <xsd:element name="weierp" type="docEmptyType" />
- <xsd:element name="image" type="docEmptyType" />
- <xsd:element name="real" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- <xsd:element name="alefsym" type="docEmptyType" />
- <xsd:element name="larr" type="docEmptyType" />
- <xsd:element name="uarr" type="docEmptyType" />
- <xsd:element name="rarr" type="docEmptyType" />
- <xsd:element name="darr" type="docEmptyType" />
- <xsd:element name="harr" type="docEmptyType" />
- <xsd:element name="crarr" type="docEmptyType" />
- <xsd:element name="lArr" type="docEmptyType" />
- <xsd:element name="uArr" type="docEmptyType" />
- <xsd:element name="rArr" type="docEmptyType" />
- <xsd:element name="dArr" type="docEmptyType" />
- <xsd:element name="hArr" type="docEmptyType" />
- <xsd:element name="forall" type="docEmptyType" />
- <xsd:element name="part" type="docEmptyType" />
- <xsd:element name="exist" type="docEmptyType" />
- <xsd:element name="empty" type="docEmptyType" />
- <xsd:element name="nabla" type="docEmptyType" />
- <xsd:element name="isin" type="docEmptyType" />
- <xsd:element name="notin" type="docEmptyType" />
- <xsd:element name="ni" type="docEmptyType" />
- <xsd:element name="prod" type="docEmptyType" />
- <xsd:element name="sum" type="docEmptyType" />
- <xsd:element name="minus" type="docEmptyType" />
- <xsd:element name="lowast" type="docEmptyType" />
- <xsd:element name="radic" type="docEmptyType" />
- <xsd:element name="prop" type="docEmptyType" />
- <xsd:element name="infin" type="docEmptyType" />
- <xsd:element name="ang" type="docEmptyType" />
- <xsd:element name="and" type="docEmptyType" />
- <xsd:element name="or" type="docEmptyType" />
- <xsd:element name="cap" type="docEmptyType" />
- <xsd:element name="cup" type="docEmptyType" />
- <xsd:element name="int" type="docEmptyType" />
- <xsd:element name="there4" type="docEmptyType" />
- <xsd:element name="sim" type="docEmptyType" />
- <xsd:element name="cong" type="docEmptyType" />
- <xsd:element name="asymp" type="docEmptyType" />
- <xsd:element name="ne" type="docEmptyType" />
- <xsd:element name="equiv" type="docEmptyType" />
- <xsd:element name="le" type="docEmptyType" />
- <xsd:element name="ge" type="docEmptyType" />
- <xsd:element name="sub" type="docEmptyType" />
- <xsd:element name="sup" type="docEmptyType" />
- <xsd:element name="nsub" type="docEmptyType" />
- <xsd:element name="sube" type="docEmptyType" />
- <xsd:element name="supe" type="docEmptyType" />
- <xsd:element name="oplus" type="docEmptyType" />
- <xsd:element name="otimes" type="docEmptyType" />
- <xsd:element name="perp" type="docEmptyType" />
- <xsd:element name="sdot" type="docEmptyType" />
- <xsd:element name="lceil" type="docEmptyType" />
- <xsd:element name="rceil" type="docEmptyType" />
- <xsd:element name="lfloor" type="docEmptyType" />
- <xsd:element name="rfloor" type="docEmptyType" />
- <xsd:element name="lang" type="docEmptyType" />
- <xsd:element name="rang" type="docEmptyType" />
- <xsd:element name="loz" type="docEmptyType" />
- <xsd:element name="spades" type="docEmptyType" />
- <xsd:element name="clubs" type="docEmptyType" />
- <xsd:element name="hearts" type="docEmptyType" />
- <xsd:element name="diams" type="docEmptyType" />
- <xsd:element name="OElig" type="docEmptyType" />
- <xsd:element name="oelig" type="docEmptyType" />
- <xsd:element name="Scaron" type="docEmptyType" />
- <xsd:element name="scaron" type="docEmptyType" />
- <xsd:element name="Yumlaut" type="docEmptyType" />
- <xsd:element name="circ" type="docEmptyType" />
- <xsd:element name="tilde" type="docEmptyType" />
- <xsd:element name="ensp" type="docEmptyType" />
- <xsd:element name="emsp" type="docEmptyType" />
- <xsd:element name="thinsp" type="docEmptyType" />
- <xsd:element name="zwnj" type="docEmptyType" />
- <xsd:element name="zwj" type="docEmptyType" />
- <xsd:element name="lrm" type="docEmptyType" />
- <xsd:element name="rlm" type="docEmptyType" />
- <xsd:element name="ndash" type="docEmptyType" />
- <xsd:element name="mdash" type="docEmptyType" />
- <xsd:element name="lsquo" type="docEmptyType" />
- <xsd:element name="rsquo" type="docEmptyType" />
- <xsd:element name="sbquo" type="docEmptyType" />
- <xsd:element name="ldquo" type="docEmptyType" />
- <xsd:element name="rdquo" type="docEmptyType" />
- <xsd:element name="bdquo" type="docEmptyType" />
- <xsd:element name="dagger" type="docEmptyType" />
- <xsd:element name="Dagger" type="docEmptyType" />
- <xsd:element name="permil" type="docEmptyType" />
- <xsd:element name="lsaquo" type="docEmptyType" />
- <xsd:element name="rsaquo" type="docEmptyType" />
- <xsd:element name="euro" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docTitleType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:group name="docCmdGroup">
- <xsd:choice>
- <xsd:group ref="docTitleCmdGroup"/>
- <xsd:element name="linebreak" type="docEmptyType" />
- <xsd:element name="hruler" type="docEmptyType" />
- <xsd:element name="preformatted" type="docMarkupType" />
- <xsd:element name="programlisting" type="listingType" />
- <xsd:element name="verbatim" type="xsd:string" />
- <xsd:element name="indexentry" type="docIndexEntryType" />
- <xsd:element name="orderedlist" type="docListType" />
- <xsd:element name="itemizedlist" type="docListType" />
- <xsd:element name="simplesect" type="docSimpleSectType" />
- <xsd:element name="title" type="docTitleType" />
- <xsd:element name="variablelist" type="docVariableListType" />
- <xsd:element name="table" type="docTableType" />
- <xsd:element name="heading" type="docHeadingType" />
- <xsd:element name="image" type="docImageType" />
- <xsd:element name="dotfile" type="docFileType" />
- <xsd:element name="mscfile" type="docFileType" />
- <xsd:element name="diafile" type="docFileType" />
- <xsd:element name="toclist" type="docTocListType" />
- <xsd:element name="language" type="docLanguageType" />
- <xsd:element name="parameterlist" type="docParamListType" />
- <xsd:element name="xrefsect" type="docXRefSectType" />
- <xsd:element name="copydoc" type="docCopyType" />
- <xsd:element name="blockquote" type="docBlockQuoteType" />
- <xsd:element name="parblock" type="docParBlockType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docParaType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docMarkupType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docURLLink" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="url" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docAnchorType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFormulaType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docIndexEntryType">
- <xsd:sequence>
- <xsd:element name="primaryie" type="xsd:string" />
- <xsd:element name="secondaryie" type="xsd:string" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListType">
- <xsd:sequence>
- <xsd:element name="listitem" type="docListItemType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListItemType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docSimpleSectType">
- <xsd:sequence>
- <xsd:element name="title" type="docTitleType" minOccurs="0" />
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="para" type="docParaType" minOccurs="1" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSimpleSectKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docVarListEntryType">
- <xsd:sequence>
- <xsd:element name="term" type="docTitleType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docVariableListGroup">
- <xsd:sequence>
- <xsd:element name="varlistentry" type="docVarListEntryType" />
- <xsd:element name="listitem" type="docListItemType" />
- </xsd:sequence>
- </xsd:group>
-
- <xsd:complexType name="docVariableListType">
- <xsd:sequence>
- <xsd:group ref="docVariableListGroup" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docRefTextType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTableType">
- <xsd:sequence>
- <xsd:element name="row" type="docRowType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="caption" type="docCaptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="rows" type="xsd:integer" />
- <xsd:attribute name="cols" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docRowType">
- <xsd:sequence>
- <xsd:element name="entry" type="docEntryType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEntryType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="thead" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="docCaptionType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docHeadingType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="level" type="xsd:integer" /> <!-- todo: range 1-6 -->
- </xsd:complexType>
-
- <xsd:complexType name="docImageType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="type" type="DoxImageKind" />
- <xsd:attribute name="name" type="xsd:string" />
- <xsd:attribute name="width" type="xsd:string" />
- <xsd:attribute name="height" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFileType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="name" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocItemType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocListType">
- <xsd:sequence>
- <xsd:element name="tocitem" type="docTocItemType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docLanguageType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="langid" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListType">
- <xsd:sequence>
- <xsd:element name="parameteritem" type="docParamListItem" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxParamListKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListItem">
- <xsd:sequence>
- <xsd:element name="parameternamelist" type="docParamNameList" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parameterdescription" type="descriptionType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamNameList">
- <xsd:sequence>
- <xsd:element name="parametertype" type="docParamType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parametername" type="docParamName" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamName" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- <xsd:attribute name="direction" type="DoxParamDir" use="optional" />
- </xsd:complexType>
-
- <xsd:complexType name="docXRefSectType">
- <xsd:sequence>
- <xsd:element name="xreftitle" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="xrefdescription" type="descriptionType" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docCopyType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="link" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docBlockQuoteType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParBlockType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEmptyType"/>
-
- <!-- Simple types -->
-
- <xsd:simpleType name="DoxBool">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="yes" />
- <xsd:enumeration value="no" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxGraphRelation">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="include" />
- <xsd:enumeration value="usage" />
- <xsd:enumeration value="template-instance" />
- <xsd:enumeration value="public-inheritance" />
- <xsd:enumeration value="protected-inheritance" />
- <xsd:enumeration value="private-inheritance" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxRefKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="compound" />
- <xsd:enumeration value="member" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxMemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="variable" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="function" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="dcop" />
- <xsd:enumeration value="slot" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="service" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxProtectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="public" />
- <xsd:enumeration value="protected" />
- <xsd:enumeration value="private" />
- <xsd:enumeration value="package" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVirtualKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="non-virtual" />
- <xsd:enumeration value="virtual" />
- <xsd:enumeration value="pure-virtual" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class" />
- <xsd:enumeration value="struct" />
- <xsd:enumeration value="union" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="protocol" />
- <xsd:enumeration value="category" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="service" />
- <xsd:enumeration value="singleton" />
- <xsd:enumeration value="module" />
- <xsd:enumeration value="type" />
- <xsd:enumeration value="file" />
- <xsd:enumeration value="namespace" />
- <xsd:enumeration value="group" />
- <xsd:enumeration value="page" />
- <xsd:enumeration value="example" />
- <xsd:enumeration value="dir" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="user-defined" />
- <xsd:enumeration value="public-type" />
- <xsd:enumeration value="public-func" />
- <xsd:enumeration value="public-attrib" />
- <xsd:enumeration value="public-slot" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="dcop-func" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="public-static-func" />
- <xsd:enumeration value="public-static-attrib" />
- <xsd:enumeration value="protected-type" />
- <xsd:enumeration value="protected-func" />
- <xsd:enumeration value="protected-attrib" />
- <xsd:enumeration value="protected-slot" />
- <xsd:enumeration value="protected-static-func" />
- <xsd:enumeration value="protected-static-attrib" />
- <xsd:enumeration value="package-type" />
- <xsd:enumeration value="package-func" />
- <xsd:enumeration value="package-attrib" />
- <xsd:enumeration value="package-static-func" />
- <xsd:enumeration value="package-static-attrib" />
- <xsd:enumeration value="private-type" />
- <xsd:enumeration value="private-func" />
- <xsd:enumeration value="private-attrib" />
- <xsd:enumeration value="private-slot" />
- <xsd:enumeration value="private-static-func" />
- <xsd:enumeration value="private-static-attrib" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="related" />
- <xsd:enumeration value="define" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="func" />
- <xsd:enumeration value="var" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxHighlightClass">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="comment" />
- <xsd:enumeration value="normal" />
- <xsd:enumeration value="preprocessor" />
- <xsd:enumeration value="keyword" />
- <xsd:enumeration value="keywordtype" />
- <xsd:enumeration value="keywordflow" />
- <xsd:enumeration value="stringliteral" />
- <xsd:enumeration value="charliteral" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSimpleSectKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="see" />
- <xsd:enumeration value="return" />
- <xsd:enumeration value="author" />
- <xsd:enumeration value="authors" />
- <xsd:enumeration value="version" />
- <xsd:enumeration value="since" />
- <xsd:enumeration value="date" />
- <xsd:enumeration value="note" />
- <xsd:enumeration value="warning" />
- <xsd:enumeration value="pre" />
- <xsd:enumeration value="post" />
- <xsd:enumeration value="copyright" />
- <xsd:enumeration value="invariant" />
- <xsd:enumeration value="remark" />
- <xsd:enumeration value="attention" />
- <xsd:enumeration value="par" />
- <xsd:enumeration value="rcs" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVersionNumber">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="\d+\.\d+.*" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxImageKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="html" />
- <xsd:enumeration value="latex" />
- <xsd:enumeration value="rtf" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamListKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="param" />
- <xsd:enumeration value="retval" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="templateparam" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCharRange">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="[aeiouncAEIOUNC]" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamDir">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="in"/>
- <xsd:enumeration value="out"/>
- <xsd:enumeration value="inout"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxAccessor">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="retain"/>
- <xsd:enumeration value="copy"/>
- <xsd:enumeration value="assign"/>
- <xsd:enumeration value="weak"/>
- <xsd:enumeration value="strong"/>
- <xsd:enumeration value="unretained"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygenindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="index.xsd" version="1.8.8">
-</doxygenindex>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygenindex" type="DoxygenType"/>
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence>
- <xsd:element name="compound" type="CompoundType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="version" type="xsd:string" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="CompoundType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- <xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="CompoundKind" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="MemberType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="MemberKind" use="required"/>
- </xsd:complexType>
-
- <xsd:simpleType name="CompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class"/>
- <xsd:enumeration value="struct"/>
- <xsd:enumeration value="union"/>
- <xsd:enumeration value="interface"/>
- <xsd:enumeration value="protocol"/>
- <xsd:enumeration value="category"/>
- <xsd:enumeration value="exception"/>
- <xsd:enumeration value="file"/>
- <xsd:enumeration value="namespace"/>
- <xsd:enumeration value="group"/>
- <xsd:enumeration value="page"/>
- <xsd:enumeration value="example"/>
- <xsd:enumeration value="dir"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="MemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define"/>
- <xsd:enumeration value="property"/>
- <xsd:enumeration value="event"/>
- <xsd:enumeration value="variable"/>
- <xsd:enumeration value="typedef"/>
- <xsd:enumeration value="enum"/>
- <xsd:enumeration value="enumvalue"/>
- <xsd:enumeration value="function"/>
- <xsd:enumeration value="signal"/>
- <xsd:enumeration value="prototype"/>
- <xsd:enumeration value="friend"/>
- <xsd:enumeration value="dcop"/>
- <xsd:enumeration value="slot"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-# Doxyfile 1.8.8
-
-# 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 = "Test Project"
-
-# 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 =
-
-# 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 =
-
-# With the PROJECT_LOGO tag one can specify a logo or an 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
-
-# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
-# characters to appear in the names of generated files. If set to NO, non-ASCII
-# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
-# U+3044.
-# The default value is: NO.
-
-ALLOW_UNICODE_NAMES = 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 = YES
-
-# 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
-
-# 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 = YES
-
-# 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 =
-
-# 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 (fixed format Fortran:
-# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
-# Fortran. In the later case the parser tries to guess whether the code is fixed
-# or free formatted code, this is the default for Fortran type files), 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 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. If 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 = NO
-
-# 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 = YES
-
-# 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 =
-
-# 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. 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 = src
-
-# 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 =
-
-# 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 =
-
-# 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 =
-
-# 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 = *
-
-# 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 =
-
-# 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 =
-
-#---------------------------------------------------------------------------
-# 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 = NO
-
-# 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 additional user-defined
-# cascading style sheets that are 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 therefore more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
-# Note: The order of the extra stylesheet files is of importance (e.g. the last
-# stylesheet in the list overrules the setting of the previous ones in the
-# list). 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. Furthermore it
-# enables the Previous and Next buttons.
-# 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
-
-# If 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 pre-rendered 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 flavors 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,
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# string, for the replacement values of the other commands the user is referred
-# to HTML_HEADER.
-# 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. See
-# LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the 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 USE_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
-
-# The MAN_SUBDIR tag determines the name of the directory created within
-# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
-# MAN_EXTENSION with the initial . removed.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_SUBDIR =
-
-# 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
-
-# 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 = NO
-
-#---------------------------------------------------------------------------
-# 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
-
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
-#---------------------------------------------------------------------------
-# 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 include 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 references 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 a 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 = YES
-
-# 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 = NO
-
-# 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 in 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 = YES
-
-# 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 = NO
-
-# 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 = NO
-
-# 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 =
-
-# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
-# path where java can find the plantuml.jar file. If left blank, it is assumed
-# PlantUML is not used or called during a preprocessing step. Doxygen will
-# generate a warning when it encounters a \startuml command in this case and
-# will not generate output for the diagram.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-PLANTUML_JAR_PATH =
-
-# 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 to 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
+++ /dev/null
-This directory contains a dummy Java project for testing purposes.
-
-To regenerate the XML output located in `xml`, run `make`. If the `Makefile`
-does not exists, you can regenerate it by running `make bootstrap` in the parent
-directory.
+++ /dev/null
-/* This file is part of NIT ( http://www.nitlanguage.org ).
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * A class with an inner class.
- */
-public class OuterClass {
- /**
- * An instance (non-static) inner class.
- */
- public class InnerClass {}
-}
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="_outer_class_8java" kind="file">
- <compoundname>OuterClass.java</compoundname>
- <innerclass refid="class_outer_class" prot="public">OuterClass</innerclass>
- <innerclass refid="class_outer_class_1_1_inner_class" prot="public">OuterClass::InnerClass</innerclass>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/OuterClass.java"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="class_outer_class" kind="class" prot="public">
- <compoundname>OuterClass</compoundname>
- <innerclass refid="class_outer_class_1_1_inner_class" prot="public">OuterClass::InnerClass</innerclass>
- <briefdescription>
-<para>A class with an inner class. </para> </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/OuterClass.java" line="19" column="1" bodyfile="%SOURCE_DIRECTORY%/OuterClass.java" bodystart="19" bodyend="24"/>
- <listofallmembers>
- </listofallmembers>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="class_outer_class_1_1_inner_class" kind="class" prot="public">
- <compoundname>OuterClass::InnerClass</compoundname>
- <briefdescription>
-<para>An instance (non-static) inner class. </para> </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/OuterClass.java" line="23" column="1" bodyfile="%SOURCE_DIRECTORY%/OuterClass.java" bodystart="23" bodyend="23"/>
- <listofallmembers>
- </listofallmembers>
- </compounddef>
-</doxygen>
+++ /dev/null
-<!-- XSLT script to combine the generated output into a single file.
- If you have xsltproc you could use:
- xsltproc combine.xslt index.xml >all.xml
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
- <xsl:output method="xml" version="1.0" indent="no" standalone="yes" />
- <xsl:template match="/">
- <doxygen version="{doxygenindex/@version}">
- <!-- Load all doxgen generated xml files -->
- <xsl:for-each select="doxygenindex/compound">
- <xsl:copy-of select="document( concat( @refid, '.xml' ) )/doxygen/*" />
- </xsl:for-each>
- </doxygen>
- </xsl:template>
-</xsl:stylesheet>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygen" type="DoxygenType"/>
-
- <!-- Complex types -->
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="compounddef" type="compounddefType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="version" type="DoxVersionNumber" use="required" />
- </xsd:complexType>
-
- <xsd:complexType name="compounddefType">
- <xsd:sequence>
- <xsd:element name="compoundname" type="xsd:string"/>
- <xsd:element name="title" type="xsd:string" minOccurs="0" />
- <xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="incdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inheritancegraph" type="graphType" minOccurs="0" />
- <xsd:element name="collaborationgraph" type="graphType" minOccurs="0" />
- <xsd:element name="programlisting" type="listingType" minOccurs="0" />
- <xsd:element name="location" type="locationType" minOccurs="0" />
- <xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="kind" type="DoxCompoundKind" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="abstract" type="DoxBool" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listofallmembersType">
- <xsd:sequence>
- <xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="memberRefType">
- <xsd:sequence>
- <xsd:element name="scope" />
- <xsd:element name="name" />
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- <xsd:attribute name="ambiguityscope" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="compoundRefType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" use="optional" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="reimplementType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="incType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="local" type="DoxBool" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refTextType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- <xsd:attribute name="tooltip" type="xsd:string" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="sectiondefType">
- <xsd:sequence>
- <xsd:element name="header" type="xsd:string" minOccurs="0" />
- <xsd:element name="description" type="descriptionType" minOccurs="0" />
- <xsd:element name="memberdef" type="memberdefType" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="memberdefType">
- <xsd:sequence>
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="definition" minOccurs="0" />
- <xsd:element name="argsstring" minOccurs="0" />
- <xsd:element name="name" />
- <xsd:element name="read" minOccurs="0" />
- <xsd:element name="write" minOccurs="0" />
- <xsd:element name="bitfield" minOccurs="0" />
- <xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="exceptions" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="location" type="locationType" />
- <xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxMemberKind" />
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="static" type="DoxBool" />
- <xsd:attribute name="const" type="DoxBool" use="optional"/>
- <xsd:attribute name="explicit" type="DoxBool" use="optional"/>
- <xsd:attribute name="inline" type="DoxBool" use="optional"/>
- <xsd:attribute name="virt" type="DoxVirtualKind" use="optional"/>
- <xsd:attribute name="volatile" type="DoxBool" use="optional"/>
- <xsd:attribute name="mutable" type="DoxBool" use="optional"/>
- <!-- Qt property -->
- <xsd:attribute name="readable" type="DoxBool" use="optional"/>
- <xsd:attribute name="writable" type="DoxBool" use="optional"/>
- <!-- C++/CLI variable -->
- <xsd:attribute name="initonly" type="DoxBool" use="optional"/>
- <!-- C++/CLI and C# property -->
- <xsd:attribute name="settable" type="DoxBool" use="optional"/>
- <xsd:attribute name="gettable" type="DoxBool" use="optional"/>
- <!-- C++/CLI function -->
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="new" type="DoxBool" use="optional"/>
- <!-- C++/CLI event -->
- <xsd:attribute name="add" type="DoxBool" use="optional"/>
- <xsd:attribute name="remove" type="DoxBool" use="optional"/>
- <xsd:attribute name="raise" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 protocol method -->
- <xsd:attribute name="optional" type="DoxBool" use="optional"/>
- <xsd:attribute name="required" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 property accessor -->
- <xsd:attribute name="accessor" type="DoxAccessor" use="optional"/>
- <!-- UNO IDL -->
- <xsd:attribute name="attribute" type="DoxBool" use="optional"/>
- <xsd:attribute name="property" type="DoxBool" use="optional"/>
- <xsd:attribute name="readonly" type="DoxBool" use="optional"/>
- <xsd:attribute name="bound" type="DoxBool" use="optional"/>
- <xsd:attribute name="removable" type="DoxBool" use="optional"/>
- <xsd:attribute name="contrained" type="DoxBool" use="optional"/>
- <xsd:attribute name="transient" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybevoid" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybedefault" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybeambiguous" type="DoxBool" use="optional"/>
-
- </xsd:complexType>
-
- <xsd:complexType name="descriptionType" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" minOccurs="0"/>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="enumvalueType" mixed="true">
- <xsd:sequence>
- <xsd:element name="name" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="templateparamlistType">
- <xsd:sequence>
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="paramType">
- <xsd:sequence>
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="declname" minOccurs="0" />
- <xsd:element name="defname" minOccurs="0" />
- <xsd:element name="array" minOccurs="0" />
- <xsd:element name="defval" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="linkedTextType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="graphType">
- <xsd:sequence>
- <xsd:element name="node" type="nodeType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="nodeType">
- <xsd:sequence>
- <xsd:element name="label" />
- <xsd:element name="link" type="linkType" minOccurs="0" />
- <xsd:element name="childnode" type="childnodeType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="childnodeType">
- <xsd:sequence>
- <xsd:element name="edgelabel" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="relation" type="DoxGraphRelation" />
- </xsd:complexType>
-
- <xsd:complexType name="linkType">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listingType">
- <xsd:sequence>
- <xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="codelineType">
- <xsd:sequence>
- <xsd:element name="highlight" type="highlightType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="lineno" type="xsd:integer" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="refkind" type="DoxRefKind" />
- <xsd:attribute name="external" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="highlightType" mixed="true">
- <xsd:choice minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="sp" />
- <xsd:element name="ref" type="refTextType" />
- </xsd:choice>
- <xsd:attribute name="class" type="DoxHighlightClass" />
- </xsd:complexType>
-
- <xsd:complexType name="referenceType" mixed="true">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="compoundref" type="xsd:string" use="optional" />
- <xsd:attribute name="startline" type="xsd:integer" />
- <xsd:attribute name="endline" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="locationType">
- <xsd:attribute name="file" type="xsd:string" />
- <xsd:attribute name="line" type="xsd:integer" />
- <xsd:attribute name="column" type="xsd:integer" use="optional"/>
- <xsd:attribute name="bodyfile" type="xsd:string" />
- <xsd:attribute name="bodystart" type="xsd:integer" />
- <xsd:attribute name="bodyend" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS1Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS2Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect4" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS3Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS4Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docInternalType" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docTitleCmdGroup">
- <xsd:choice>
- <xsd:element name="ulink" type="docURLLink" />
- <xsd:element name="bold" type="docMarkupType" />
- <xsd:element name="emphasis" type="docMarkupType" />
- <xsd:element name="computeroutput" type="docMarkupType" />
- <xsd:element name="subscript" type="docMarkupType" />
- <xsd:element name="superscript" type="docMarkupType" />
- <xsd:element name="center" type="docMarkupType" />
- <xsd:element name="small" type="docMarkupType" />
- <xsd:element name="htmlonly" type="xsd:string" />
- <xsd:element name="manonly" type="xsd:string" />
- <xsd:element name="xmlonly" type="xsd:string" />
- <xsd:element name="rtfonly" type="xsd:string" />
- <xsd:element name="latexonly" type="xsd:string" />
- <xsd:element name="dot" type="xsd:string" />
- <xsd:element name="plantuml" type="xsd:string" />
- <xsd:element name="anchor" type="docAnchorType" />
- <xsd:element name="formula" type="docFormulaType" />
- <xsd:element name="ref" type="docRefTextType" />
- <xsd:element name="nonbreakablespace" type="docEmptyType" />
- <xsd:element name="iexcl" type="docEmptyType" />
- <xsd:element name="cent" type="docEmptyType" />
- <xsd:element name="pound" type="docEmptyType" />
- <xsd:element name="curren" type="docEmptyType" />
- <xsd:element name="yen" type="docEmptyType" />
- <xsd:element name="brvbar" type="docEmptyType" />
- <xsd:element name="sect" type="docEmptyType" />
- <xsd:element name="umlaut" type="docEmptyType" />
- <xsd:element name="copy" type="docEmptyType" />
- <xsd:element name="ordf" type="docEmptyType" />
- <xsd:element name="laquo" type="docEmptyType" />
- <xsd:element name="not" type="docEmptyType" />
- <xsd:element name="shy" type="docEmptyType" />
- <xsd:element name="registered" type="docEmptyType" />
- <xsd:element name="macr" type="docEmptyType" />
- <xsd:element name="deg" type="docEmptyType" />
- <xsd:element name="plusmn" type="docEmptyType" />
- <xsd:element name="sup2" type="docEmptyType" />
- <xsd:element name="sup3" type="docEmptyType" />
- <xsd:element name="acute" type="docEmptyType" />
- <xsd:element name="micro" type="docEmptyType" />
- <xsd:element name="para" type="docEmptyType" />
- <xsd:element name="middot" type="docEmptyType" />
- <xsd:element name="cedil" type="docEmptyType" />
- <xsd:element name="sup1" type="docEmptyType" />
- <xsd:element name="ordm" type="docEmptyType" />
- <xsd:element name="raquo" type="docEmptyType" />
- <xsd:element name="frac14" type="docEmptyType" />
- <xsd:element name="frac12" type="docEmptyType" />
- <xsd:element name="frac34" type="docEmptyType" />
- <xsd:element name="iquest" type="docEmptyType" />
- <xsd:element name="Agrave" type="docEmptyType" />
- <xsd:element name="Aacute" type="docEmptyType" />
- <xsd:element name="Acirc" type="docEmptyType" />
- <xsd:element name="Atilde" type="docEmptyType" />
- <xsd:element name="Aumlaut" type="docEmptyType" />
- <xsd:element name="Aring" type="docEmptyType" />
- <xsd:element name="AElig" type="docEmptyType" />
- <xsd:element name="Ccedil" type="docEmptyType" />
- <xsd:element name="Egrave" type="docEmptyType" />
- <xsd:element name="Eacute" type="docEmptyType" />
- <xsd:element name="Ecirc" type="docEmptyType" />
- <xsd:element name="Eumlaut" type="docEmptyType" />
- <xsd:element name="Igrave" type="docEmptyType" />
- <xsd:element name="Iacute" type="docEmptyType" />
- <xsd:element name="Icirc" type="docEmptyType" />
- <xsd:element name="Iumlaut" type="docEmptyType" />
- <xsd:element name="ETH" type="docEmptyType" />
- <xsd:element name="Ntilde" type="docEmptyType" />
- <xsd:element name="Ograve" type="docEmptyType" />
- <xsd:element name="Oacute" type="docEmptyType" />
- <xsd:element name="Ocirc" type="docEmptyType" />
- <xsd:element name="Otilde" type="docEmptyType" />
- <xsd:element name="Oumlaut" type="docEmptyType" />
- <xsd:element name="times" type="docEmptyType" />
- <xsd:element name="Oslash" type="docEmptyType" />
- <xsd:element name="Ugrave" type="docEmptyType" />
- <xsd:element name="Uacute" type="docEmptyType" />
- <xsd:element name="Ucirc" type="docEmptyType" />
- <xsd:element name="Uumlaut" type="docEmptyType" />
- <xsd:element name="Yacute" type="docEmptyType" />
- <xsd:element name="THORN" type="docEmptyType" />
- <xsd:element name="szlig" type="docEmptyType" />
- <xsd:element name="agrave" type="docEmptyType" />
- <xsd:element name="aacute" type="docEmptyType" />
- <xsd:element name="acirc" type="docEmptyType" />
- <xsd:element name="atilde" type="docEmptyType" />
- <xsd:element name="aumlaut" type="docEmptyType" />
- <xsd:element name="aring" type="docEmptyType" />
- <xsd:element name="aelig" type="docEmptyType" />
- <xsd:element name="ccedil" type="docEmptyType" />
- <xsd:element name="egrave" type="docEmptyType" />
- <xsd:element name="eacute" type="docEmptyType" />
- <xsd:element name="ecirc" type="docEmptyType" />
- <xsd:element name="eumlaut" type="docEmptyType" />
- <xsd:element name="igrave" type="docEmptyType" />
- <xsd:element name="iacute" type="docEmptyType" />
- <xsd:element name="icirc" type="docEmptyType" />
- <xsd:element name="iumlaut" type="docEmptyType" />
- <xsd:element name="eth" type="docEmptyType" />
- <xsd:element name="ntilde" type="docEmptyType" />
- <xsd:element name="ograve" type="docEmptyType" />
- <xsd:element name="oacute" type="docEmptyType" />
- <xsd:element name="ocirc" type="docEmptyType" />
- <xsd:element name="otilde" type="docEmptyType" />
- <xsd:element name="oumlaut" type="docEmptyType" />
- <xsd:element name="divide" type="docEmptyType" />
- <xsd:element name="oslash" type="docEmptyType" />
- <xsd:element name="ugrave" type="docEmptyType" />
- <xsd:element name="uacute" type="docEmptyType" />
- <xsd:element name="ucirc" type="docEmptyType" />
- <xsd:element name="uumlaut" type="docEmptyType" />
- <xsd:element name="yacute" type="docEmptyType" />
- <xsd:element name="thorn" type="docEmptyType" />
- <xsd:element name="yumlaut" type="docEmptyType" />
- <xsd:element name="fnof" type="docEmptyType" />
- <xsd:element name="Alpha" type="docEmptyType" />
- <xsd:element name="Beta" type="docEmptyType" />
- <xsd:element name="Gamma" type="docEmptyType" />
- <xsd:element name="Delta" type="docEmptyType" />
- <xsd:element name="Epsilon" type="docEmptyType" />
- <xsd:element name="Zeta" type="docEmptyType" />
- <xsd:element name="Eta" type="docEmptyType" />
- <xsd:element name="Theta" type="docEmptyType" />
- <xsd:element name="Iota" type="docEmptyType" />
- <xsd:element name="Kappa" type="docEmptyType" />
- <xsd:element name="Lambda" type="docEmptyType" />
- <xsd:element name="Mu" type="docEmptyType" />
- <xsd:element name="Nu" type="docEmptyType" />
- <xsd:element name="Xi" type="docEmptyType" />
- <xsd:element name="Omicron" type="docEmptyType" />
- <xsd:element name="Pi" type="docEmptyType" />
- <xsd:element name="Rho" type="docEmptyType" />
- <xsd:element name="Sigma" type="docEmptyType" />
- <xsd:element name="Tau" type="docEmptyType" />
- <xsd:element name="Upsilon" type="docEmptyType" />
- <xsd:element name="Phi" type="docEmptyType" />
- <xsd:element name="Chi" type="docEmptyType" />
- <xsd:element name="Psi" type="docEmptyType" />
- <xsd:element name="Omega" type="docEmptyType" />
- <xsd:element name="alpha" type="docEmptyType" />
- <xsd:element name="beta" type="docEmptyType" />
- <xsd:element name="gamma" type="docEmptyType" />
- <xsd:element name="delta" type="docEmptyType" />
- <xsd:element name="epsilon" type="docEmptyType" />
- <xsd:element name="zeta" type="docEmptyType" />
- <xsd:element name="eta" type="docEmptyType" />
- <xsd:element name="theta" type="docEmptyType" />
- <xsd:element name="iota" type="docEmptyType" />
- <xsd:element name="kappa" type="docEmptyType" />
- <xsd:element name="lambda" type="docEmptyType" />
- <xsd:element name="mu" type="docEmptyType" />
- <xsd:element name="nu" type="docEmptyType" />
- <xsd:element name="xi" type="docEmptyType" />
- <xsd:element name="omicron" type="docEmptyType" />
- <xsd:element name="pi" type="docEmptyType" />
- <xsd:element name="rho" type="docEmptyType" />
- <xsd:element name="sigmaf" type="docEmptyType" />
- <xsd:element name="sigma" type="docEmptyType" />
- <xsd:element name="tau" type="docEmptyType" />
- <xsd:element name="upsilon" type="docEmptyType" />
- <xsd:element name="phi" type="docEmptyType" />
- <xsd:element name="chi" type="docEmptyType" />
- <xsd:element name="psi" type="docEmptyType" />
- <xsd:element name="omega" type="docEmptyType" />
- <xsd:element name="thetasym" type="docEmptyType" />
- <xsd:element name="upsih" type="docEmptyType" />
- <xsd:element name="piv" type="docEmptyType" />
- <xsd:element name="bull" type="docEmptyType" />
- <xsd:element name="hellip" type="docEmptyType" />
- <xsd:element name="prime" type="docEmptyType" />
- <xsd:element name="Prime" type="docEmptyType" />
- <xsd:element name="oline" type="docEmptyType" />
- <xsd:element name="frasl" type="docEmptyType" />
- <xsd:element name="weierp" type="docEmptyType" />
- <xsd:element name="image" type="docEmptyType" />
- <xsd:element name="real" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- <xsd:element name="alefsym" type="docEmptyType" />
- <xsd:element name="larr" type="docEmptyType" />
- <xsd:element name="uarr" type="docEmptyType" />
- <xsd:element name="rarr" type="docEmptyType" />
- <xsd:element name="darr" type="docEmptyType" />
- <xsd:element name="harr" type="docEmptyType" />
- <xsd:element name="crarr" type="docEmptyType" />
- <xsd:element name="lArr" type="docEmptyType" />
- <xsd:element name="uArr" type="docEmptyType" />
- <xsd:element name="rArr" type="docEmptyType" />
- <xsd:element name="dArr" type="docEmptyType" />
- <xsd:element name="hArr" type="docEmptyType" />
- <xsd:element name="forall" type="docEmptyType" />
- <xsd:element name="part" type="docEmptyType" />
- <xsd:element name="exist" type="docEmptyType" />
- <xsd:element name="empty" type="docEmptyType" />
- <xsd:element name="nabla" type="docEmptyType" />
- <xsd:element name="isin" type="docEmptyType" />
- <xsd:element name="notin" type="docEmptyType" />
- <xsd:element name="ni" type="docEmptyType" />
- <xsd:element name="prod" type="docEmptyType" />
- <xsd:element name="sum" type="docEmptyType" />
- <xsd:element name="minus" type="docEmptyType" />
- <xsd:element name="lowast" type="docEmptyType" />
- <xsd:element name="radic" type="docEmptyType" />
- <xsd:element name="prop" type="docEmptyType" />
- <xsd:element name="infin" type="docEmptyType" />
- <xsd:element name="ang" type="docEmptyType" />
- <xsd:element name="and" type="docEmptyType" />
- <xsd:element name="or" type="docEmptyType" />
- <xsd:element name="cap" type="docEmptyType" />
- <xsd:element name="cup" type="docEmptyType" />
- <xsd:element name="int" type="docEmptyType" />
- <xsd:element name="there4" type="docEmptyType" />
- <xsd:element name="sim" type="docEmptyType" />
- <xsd:element name="cong" type="docEmptyType" />
- <xsd:element name="asymp" type="docEmptyType" />
- <xsd:element name="ne" type="docEmptyType" />
- <xsd:element name="equiv" type="docEmptyType" />
- <xsd:element name="le" type="docEmptyType" />
- <xsd:element name="ge" type="docEmptyType" />
- <xsd:element name="sub" type="docEmptyType" />
- <xsd:element name="sup" type="docEmptyType" />
- <xsd:element name="nsub" type="docEmptyType" />
- <xsd:element name="sube" type="docEmptyType" />
- <xsd:element name="supe" type="docEmptyType" />
- <xsd:element name="oplus" type="docEmptyType" />
- <xsd:element name="otimes" type="docEmptyType" />
- <xsd:element name="perp" type="docEmptyType" />
- <xsd:element name="sdot" type="docEmptyType" />
- <xsd:element name="lceil" type="docEmptyType" />
- <xsd:element name="rceil" type="docEmptyType" />
- <xsd:element name="lfloor" type="docEmptyType" />
- <xsd:element name="rfloor" type="docEmptyType" />
- <xsd:element name="lang" type="docEmptyType" />
- <xsd:element name="rang" type="docEmptyType" />
- <xsd:element name="loz" type="docEmptyType" />
- <xsd:element name="spades" type="docEmptyType" />
- <xsd:element name="clubs" type="docEmptyType" />
- <xsd:element name="hearts" type="docEmptyType" />
- <xsd:element name="diams" type="docEmptyType" />
- <xsd:element name="OElig" type="docEmptyType" />
- <xsd:element name="oelig" type="docEmptyType" />
- <xsd:element name="Scaron" type="docEmptyType" />
- <xsd:element name="scaron" type="docEmptyType" />
- <xsd:element name="Yumlaut" type="docEmptyType" />
- <xsd:element name="circ" type="docEmptyType" />
- <xsd:element name="tilde" type="docEmptyType" />
- <xsd:element name="ensp" type="docEmptyType" />
- <xsd:element name="emsp" type="docEmptyType" />
- <xsd:element name="thinsp" type="docEmptyType" />
- <xsd:element name="zwnj" type="docEmptyType" />
- <xsd:element name="zwj" type="docEmptyType" />
- <xsd:element name="lrm" type="docEmptyType" />
- <xsd:element name="rlm" type="docEmptyType" />
- <xsd:element name="ndash" type="docEmptyType" />
- <xsd:element name="mdash" type="docEmptyType" />
- <xsd:element name="lsquo" type="docEmptyType" />
- <xsd:element name="rsquo" type="docEmptyType" />
- <xsd:element name="sbquo" type="docEmptyType" />
- <xsd:element name="ldquo" type="docEmptyType" />
- <xsd:element name="rdquo" type="docEmptyType" />
- <xsd:element name="bdquo" type="docEmptyType" />
- <xsd:element name="dagger" type="docEmptyType" />
- <xsd:element name="Dagger" type="docEmptyType" />
- <xsd:element name="permil" type="docEmptyType" />
- <xsd:element name="lsaquo" type="docEmptyType" />
- <xsd:element name="rsaquo" type="docEmptyType" />
- <xsd:element name="euro" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docTitleType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:group name="docCmdGroup">
- <xsd:choice>
- <xsd:group ref="docTitleCmdGroup"/>
- <xsd:element name="linebreak" type="docEmptyType" />
- <xsd:element name="hruler" type="docEmptyType" />
- <xsd:element name="preformatted" type="docMarkupType" />
- <xsd:element name="programlisting" type="listingType" />
- <xsd:element name="verbatim" type="xsd:string" />
- <xsd:element name="indexentry" type="docIndexEntryType" />
- <xsd:element name="orderedlist" type="docListType" />
- <xsd:element name="itemizedlist" type="docListType" />
- <xsd:element name="simplesect" type="docSimpleSectType" />
- <xsd:element name="title" type="docTitleType" />
- <xsd:element name="variablelist" type="docVariableListType" />
- <xsd:element name="table" type="docTableType" />
- <xsd:element name="heading" type="docHeadingType" />
- <xsd:element name="image" type="docImageType" />
- <xsd:element name="dotfile" type="docFileType" />
- <xsd:element name="mscfile" type="docFileType" />
- <xsd:element name="diafile" type="docFileType" />
- <xsd:element name="toclist" type="docTocListType" />
- <xsd:element name="language" type="docLanguageType" />
- <xsd:element name="parameterlist" type="docParamListType" />
- <xsd:element name="xrefsect" type="docXRefSectType" />
- <xsd:element name="copydoc" type="docCopyType" />
- <xsd:element name="blockquote" type="docBlockQuoteType" />
- <xsd:element name="parblock" type="docParBlockType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docParaType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docMarkupType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docURLLink" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="url" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docAnchorType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFormulaType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docIndexEntryType">
- <xsd:sequence>
- <xsd:element name="primaryie" type="xsd:string" />
- <xsd:element name="secondaryie" type="xsd:string" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListType">
- <xsd:sequence>
- <xsd:element name="listitem" type="docListItemType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListItemType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docSimpleSectType">
- <xsd:sequence>
- <xsd:element name="title" type="docTitleType" minOccurs="0" />
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="para" type="docParaType" minOccurs="1" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSimpleSectKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docVarListEntryType">
- <xsd:sequence>
- <xsd:element name="term" type="docTitleType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docVariableListGroup">
- <xsd:sequence>
- <xsd:element name="varlistentry" type="docVarListEntryType" />
- <xsd:element name="listitem" type="docListItemType" />
- </xsd:sequence>
- </xsd:group>
-
- <xsd:complexType name="docVariableListType">
- <xsd:sequence>
- <xsd:group ref="docVariableListGroup" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docRefTextType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTableType">
- <xsd:sequence>
- <xsd:element name="row" type="docRowType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="caption" type="docCaptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="rows" type="xsd:integer" />
- <xsd:attribute name="cols" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docRowType">
- <xsd:sequence>
- <xsd:element name="entry" type="docEntryType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEntryType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="thead" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="docCaptionType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docHeadingType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="level" type="xsd:integer" /> <!-- todo: range 1-6 -->
- </xsd:complexType>
-
- <xsd:complexType name="docImageType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="type" type="DoxImageKind" />
- <xsd:attribute name="name" type="xsd:string" />
- <xsd:attribute name="width" type="xsd:string" />
- <xsd:attribute name="height" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFileType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="name" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocItemType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocListType">
- <xsd:sequence>
- <xsd:element name="tocitem" type="docTocItemType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docLanguageType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="langid" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListType">
- <xsd:sequence>
- <xsd:element name="parameteritem" type="docParamListItem" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxParamListKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListItem">
- <xsd:sequence>
- <xsd:element name="parameternamelist" type="docParamNameList" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parameterdescription" type="descriptionType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamNameList">
- <xsd:sequence>
- <xsd:element name="parametertype" type="docParamType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parametername" type="docParamName" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamName" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- <xsd:attribute name="direction" type="DoxParamDir" use="optional" />
- </xsd:complexType>
-
- <xsd:complexType name="docXRefSectType">
- <xsd:sequence>
- <xsd:element name="xreftitle" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="xrefdescription" type="descriptionType" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docCopyType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="link" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docBlockQuoteType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParBlockType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEmptyType"/>
-
- <!-- Simple types -->
-
- <xsd:simpleType name="DoxBool">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="yes" />
- <xsd:enumeration value="no" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxGraphRelation">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="include" />
- <xsd:enumeration value="usage" />
- <xsd:enumeration value="template-instance" />
- <xsd:enumeration value="public-inheritance" />
- <xsd:enumeration value="protected-inheritance" />
- <xsd:enumeration value="private-inheritance" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxRefKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="compound" />
- <xsd:enumeration value="member" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxMemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="variable" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="function" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="dcop" />
- <xsd:enumeration value="slot" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="service" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxProtectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="public" />
- <xsd:enumeration value="protected" />
- <xsd:enumeration value="private" />
- <xsd:enumeration value="package" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVirtualKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="non-virtual" />
- <xsd:enumeration value="virtual" />
- <xsd:enumeration value="pure-virtual" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class" />
- <xsd:enumeration value="struct" />
- <xsd:enumeration value="union" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="protocol" />
- <xsd:enumeration value="category" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="service" />
- <xsd:enumeration value="singleton" />
- <xsd:enumeration value="module" />
- <xsd:enumeration value="type" />
- <xsd:enumeration value="file" />
- <xsd:enumeration value="namespace" />
- <xsd:enumeration value="group" />
- <xsd:enumeration value="page" />
- <xsd:enumeration value="example" />
- <xsd:enumeration value="dir" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="user-defined" />
- <xsd:enumeration value="public-type" />
- <xsd:enumeration value="public-func" />
- <xsd:enumeration value="public-attrib" />
- <xsd:enumeration value="public-slot" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="dcop-func" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="public-static-func" />
- <xsd:enumeration value="public-static-attrib" />
- <xsd:enumeration value="protected-type" />
- <xsd:enumeration value="protected-func" />
- <xsd:enumeration value="protected-attrib" />
- <xsd:enumeration value="protected-slot" />
- <xsd:enumeration value="protected-static-func" />
- <xsd:enumeration value="protected-static-attrib" />
- <xsd:enumeration value="package-type" />
- <xsd:enumeration value="package-func" />
- <xsd:enumeration value="package-attrib" />
- <xsd:enumeration value="package-static-func" />
- <xsd:enumeration value="package-static-attrib" />
- <xsd:enumeration value="private-type" />
- <xsd:enumeration value="private-func" />
- <xsd:enumeration value="private-attrib" />
- <xsd:enumeration value="private-slot" />
- <xsd:enumeration value="private-static-func" />
- <xsd:enumeration value="private-static-attrib" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="related" />
- <xsd:enumeration value="define" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="func" />
- <xsd:enumeration value="var" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxHighlightClass">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="comment" />
- <xsd:enumeration value="normal" />
- <xsd:enumeration value="preprocessor" />
- <xsd:enumeration value="keyword" />
- <xsd:enumeration value="keywordtype" />
- <xsd:enumeration value="keywordflow" />
- <xsd:enumeration value="stringliteral" />
- <xsd:enumeration value="charliteral" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSimpleSectKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="see" />
- <xsd:enumeration value="return" />
- <xsd:enumeration value="author" />
- <xsd:enumeration value="authors" />
- <xsd:enumeration value="version" />
- <xsd:enumeration value="since" />
- <xsd:enumeration value="date" />
- <xsd:enumeration value="note" />
- <xsd:enumeration value="warning" />
- <xsd:enumeration value="pre" />
- <xsd:enumeration value="post" />
- <xsd:enumeration value="copyright" />
- <xsd:enumeration value="invariant" />
- <xsd:enumeration value="remark" />
- <xsd:enumeration value="attention" />
- <xsd:enumeration value="par" />
- <xsd:enumeration value="rcs" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVersionNumber">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="\d+\.\d+.*" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxImageKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="html" />
- <xsd:enumeration value="latex" />
- <xsd:enumeration value="rtf" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamListKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="param" />
- <xsd:enumeration value="retval" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="templateparam" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCharRange">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="[aeiouncAEIOUNC]" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamDir">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="in"/>
- <xsd:enumeration value="out"/>
- <xsd:enumeration value="inout"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxAccessor">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="retain"/>
- <xsd:enumeration value="copy"/>
- <xsd:enumeration value="assign"/>
- <xsd:enumeration value="weak"/>
- <xsd:enumeration value="strong"/>
- <xsd:enumeration value="unretained"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="dir_68267d1309a1af8e8297ef4c3efbcdba" kind="dir">
- <compoundname>src</compoundname>
- <innerfile refid="_outer_class_8java">OuterClass.java</innerfile>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygenindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="index.xsd" version="1.8.8">
- <compound refid="class_outer_class_1_1_inner_class" kind="class"><name>OuterClass::InnerClass</name>
- </compound>
- <compound refid="class_outer_class" kind="class"><name>OuterClass</name>
- </compound>
- <compound refid="_outer_class_8java" kind="file"><name>OuterClass.java</name>
- </compound>
- <compound refid="dir_68267d1309a1af8e8297ef4c3efbcdba" kind="dir"><name>src</name>
- </compound>
-</doxygenindex>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygenindex" type="DoxygenType"/>
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence>
- <xsd:element name="compound" type="CompoundType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="version" type="xsd:string" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="CompoundType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- <xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="CompoundKind" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="MemberType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="MemberKind" use="required"/>
- </xsd:complexType>
-
- <xsd:simpleType name="CompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class"/>
- <xsd:enumeration value="struct"/>
- <xsd:enumeration value="union"/>
- <xsd:enumeration value="interface"/>
- <xsd:enumeration value="protocol"/>
- <xsd:enumeration value="category"/>
- <xsd:enumeration value="exception"/>
- <xsd:enumeration value="file"/>
- <xsd:enumeration value="namespace"/>
- <xsd:enumeration value="group"/>
- <xsd:enumeration value="page"/>
- <xsd:enumeration value="example"/>
- <xsd:enumeration value="dir"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="MemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define"/>
- <xsd:enumeration value="property"/>
- <xsd:enumeration value="event"/>
- <xsd:enumeration value="variable"/>
- <xsd:enumeration value="typedef"/>
- <xsd:enumeration value="enum"/>
- <xsd:enumeration value="enumvalue"/>
- <xsd:enumeration value="function"/>
- <xsd:enumeration value="signal"/>
- <xsd:enumeration value="prototype"/>
- <xsd:enumeration value="friend"/>
- <xsd:enumeration value="dcop"/>
- <xsd:enumeration value="slot"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-# Doxyfile 1.8.8
-
-# 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 = "Test Project"
-
-# 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 =
-
-# 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 =
-
-# With the PROJECT_LOGO tag one can specify a logo or an 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
-
-# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
-# characters to appear in the names of generated files. If set to NO, non-ASCII
-# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
-# U+3044.
-# The default value is: NO.
-
-ALLOW_UNICODE_NAMES = 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 = YES
-
-# 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
-
-# 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 = YES
-
-# 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 =
-
-# 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 (fixed format Fortran:
-# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
-# Fortran. In the later case the parser tries to guess whether the code is fixed
-# or free formatted code, this is the default for Fortran type files), 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 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. If 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 = NO
-
-# 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 = YES
-
-# 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 =
-
-# 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. 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 = src
-
-# 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 =
-
-# 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 =
-
-# 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 =
-
-# 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 = *
-
-# 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 =
-
-# 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 =
-
-#---------------------------------------------------------------------------
-# 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 = NO
-
-# 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 additional user-defined
-# cascading style sheets that are 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 therefore more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
-# Note: The order of the extra stylesheet files is of importance (e.g. the last
-# stylesheet in the list overrules the setting of the previous ones in the
-# list). 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. Furthermore it
-# enables the Previous and Next buttons.
-# 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
-
-# If 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 pre-rendered 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 flavors 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,
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# string, for the replacement values of the other commands the user is referred
-# to HTML_HEADER.
-# 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. See
-# LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the 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 USE_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
-
-# The MAN_SUBDIR tag determines the name of the directory created within
-# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
-# MAN_EXTENSION with the initial . removed.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_SUBDIR =
-
-# 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
-
-# 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 = NO
-
-#---------------------------------------------------------------------------
-# 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
-
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
-#---------------------------------------------------------------------------
-# 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 include 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 references 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 a 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 = YES
-
-# 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 = NO
-
-# 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 in 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 = YES
-
-# 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 = NO
-
-# 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 = NO
-
-# 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 =
-
-# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
-# path where java can find the plantuml.jar file. If left blank, it is assumed
-# PlantUML is not used or called during a preprocessing step. Doxygen will
-# generate a warning when it encounters a \startuml command in this case and
-# will not generate output for the diagram.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-PLANTUML_JAR_PATH =
-
-# 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 to 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
+++ /dev/null
-This directory contains a dummy Java project for testing purposes.
-
-To regenerate the XML output located in `xml`, run `make`. If the `Makefile`
-does not exists, you can regenerate it by running `make bootstrap` in the parent
-directory.
+++ /dev/null
-/* This file is part of NIT ( http://www.nitlanguage.org ).
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.example.foo;
-
-public abstract class A {
- /**
- * Does something...
- */
- public abstract boolean bar(int x, EmptyClass y);
-}
+++ /dev/null
-/* This file is part of NIT ( http://www.nitlanguage.org ).
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.example.foo;
-
-public class B extends A implements C {
- protected String qux = "quux";
-
- public boolean bar(int x, EmptyClass y) {
- return false;
- }
-
- /**
- * Some overriden documentation.
- */
- public void baz() {}
-}
+++ /dev/null
-/* This file is part of NIT ( http://www.nitlanguage.org ).
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.example.foo;
-
-/**
- * An interface
- */
-public interface C {
- /**
- * “Answer to the Ultimate Question of Life, the Universe, and Everything.“
- */
- public static final long THE_ANSWER = 42L;
-
- /**
- * A function with implicit modifiers.
- */
- void baz();
-}
+++ /dev/null
-/* This file is part of NIT ( http://www.nitlanguage.org ).
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.example.foo;
-
-/**
- * This class is empty and is only visible in this package.
- */
-class EmptyClass {}
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="_a_8java" kind="file">
- <compoundname>A.java</compoundname>
- <innerclass refid="classorg_1_1example_1_1foo_1_1_a" prot="public">org::example::foo::A</innerclass>
- <innernamespace refid="namespaceorg_1_1example_1_1foo">org::example::foo</innernamespace>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/A.java"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="_b_8java" kind="file">
- <compoundname>B.java</compoundname>
- <innerclass refid="classorg_1_1example_1_1foo_1_1_b" prot="public">org::example::foo::B</innerclass>
- <innernamespace refid="namespaceorg_1_1example_1_1foo">org::example::foo</innernamespace>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/B.java"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="_c_8java" kind="file">
- <compoundname>C.java</compoundname>
- <innerclass refid="interfaceorg_1_1example_1_1foo_1_1_c" prot="public">org::example::foo::C</innerclass>
- <innernamespace refid="namespaceorg_1_1example_1_1foo">org::example::foo</innernamespace>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/C.java"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="_empty_class_8java" kind="file">
- <compoundname>EmptyClass.java</compoundname>
- <innerclass refid="classorg_1_1example_1_1foo_1_1_empty_class" prot="package">org::example::foo::EmptyClass</innerclass>
- <innernamespace refid="namespaceorg_1_1example_1_1foo">org::example::foo</innernamespace>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/EmptyClass.java"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="classorg_1_1example_1_1foo_1_1_a" kind="class" prot="public" abstract="yes">
- <compoundname>org::example::foo::A</compoundname>
- <derivedcompoundref refid="classorg_1_1example_1_1foo_1_1_b" prot="public" virt="non-virtual">org.example.foo.B</derivedcompoundref>
- <sectiondef kind="public-func">
- <memberdef kind="function" id="classorg_1_1example_1_1foo_1_1_a_1add415ae4129969055d678c7e7e048852" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
- <type>abstract boolean</type>
- <definition>abstract boolean org.example.foo.A.bar</definition>
- <argsstring>(int x, EmptyClass y)</argsstring>
- <name>bar</name>
- <param>
- <type>int</type>
- <declname>x</declname>
- </param>
- <param>
- <type>EmptyClass</type>
- <declname>y</declname>
- </param>
- <briefdescription>
-<para>Does something... </para> </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <inbodydescription>
- </inbodydescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/A.java" line="22" column="1"/>
- </memberdef>
- </sectiondef>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <inheritancegraph>
- <node id="0">
- <label>org.example.foo.A</label>
- <link refid="classorg_1_1example_1_1foo_1_1_a"/>
- </node>
- <node id="1">
- <label>org.example.foo.B</label>
- <link refid="classorg_1_1example_1_1foo_1_1_b"/>
- <childnode refid="0" relation="public-inheritance">
- </childnode>
- </node>
- </inheritancegraph>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/A.java" line="18" column="1" bodyfile="%SOURCE_DIRECTORY%/org/example/foo/A.java" bodystart="18" bodyend="23"/>
- <listofallmembers>
- <member refid="classorg_1_1example_1_1foo_1_1_a_1add415ae4129969055d678c7e7e048852" prot="public" virt="non-virtual"><scope>org::example::foo::A</scope><name>bar</name></member>
- </listofallmembers>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="classorg_1_1example_1_1foo_1_1_b" kind="class" prot="public">
- <compoundname>org::example::foo::B</compoundname>
- <basecompoundref refid="classorg_1_1example_1_1foo_1_1_a" prot="public" virt="non-virtual">org.example.foo.A</basecompoundref>
- <basecompoundref refid="interfaceorg_1_1example_1_1foo_1_1_c" prot="public" virt="non-virtual">org.example.foo.C</basecompoundref>
- <sectiondef kind="protected-attrib">
- <memberdef kind="variable" id="classorg_1_1example_1_1foo_1_1_b_1ac6b627949b10b9357eefc0cafcae1d87" prot="protected" static="no" mutable="no">
- <type>String</type>
- <definition>String org.example.foo.B.qux</definition>
- <argsstring></argsstring>
- <name>qux</name>
- <initializer>= "quux"</initializer>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <inbodydescription>
- </inbodydescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/B.java" line="19" column="1" bodyfile="%SOURCE_DIRECTORY%/org/example/foo/B.java" bodystart="19" bodyend="-1"/>
- </memberdef>
- </sectiondef>
- <sectiondef kind="public-func">
- <memberdef kind="function" id="classorg_1_1example_1_1foo_1_1_b_1a11e157943665cc9e3a9be1502ebeb3b5" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
- <type>boolean</type>
- <definition>boolean org.example.foo.B.bar</definition>
- <argsstring>(int x, EmptyClass y)</argsstring>
- <name>bar</name>
- <param>
- <type>int</type>
- <declname>x</declname>
- </param>
- <param>
- <type>EmptyClass</type>
- <declname>y</declname>
- </param>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <inbodydescription>
- </inbodydescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/B.java" line="21" column="1" bodyfile="%SOURCE_DIRECTORY%/org/example/foo/B.java" bodystart="21" bodyend="23"/>
- </memberdef>
- <memberdef kind="function" id="classorg_1_1example_1_1foo_1_1_b_1a733f4e076f29c7d0c41ed258199ea1d9" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
- <type>void</type>
- <definition>void org.example.foo.B.baz</definition>
- <argsstring>()</argsstring>
- <name>baz</name>
- <reimplements refid="interfaceorg_1_1example_1_1foo_1_1_c_1a28ac7ce349ebb3e4a7747a8dd951582b">baz</reimplements>
- <briefdescription>
-<para>Some overriden documentation. </para> </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <inbodydescription>
- </inbodydescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/B.java" line="28" column="1" bodyfile="%SOURCE_DIRECTORY%/org/example/foo/B.java" bodystart="28" bodyend="28"/>
- </memberdef>
- </sectiondef>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <inheritancegraph>
- <node id="4">
- <label>org.example.foo.A</label>
- <link refid="classorg_1_1example_1_1foo_1_1_a"/>
- </node>
- <node id="3">
- <label>org.example.foo.B</label>
- <link refid="classorg_1_1example_1_1foo_1_1_b"/>
- <childnode refid="4" relation="public-inheritance">
- </childnode>
- <childnode refid="5" relation="public-inheritance">
- </childnode>
- </node>
- <node id="5">
- <label>org.example.foo.C</label>
- <link refid="interfaceorg_1_1example_1_1foo_1_1_c"/>
- </node>
- </inheritancegraph>
- <collaborationgraph>
- <node id="7">
- <label>org.example.foo.A</label>
- <link refid="classorg_1_1example_1_1foo_1_1_a"/>
- </node>
- <node id="6">
- <label>org.example.foo.B</label>
- <link refid="classorg_1_1example_1_1foo_1_1_b"/>
- <childnode refid="7" relation="public-inheritance">
- </childnode>
- <childnode refid="8" relation="public-inheritance">
- </childnode>
- </node>
- <node id="8">
- <label>org.example.foo.C</label>
- <link refid="interfaceorg_1_1example_1_1foo_1_1_c"/>
- </node>
- </collaborationgraph>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/B.java" line="18" column="1" bodyfile="%SOURCE_DIRECTORY%/org/example/foo/B.java" bodystart="18" bodyend="29"/>
- <listofallmembers>
- <member refid="classorg_1_1example_1_1foo_1_1_b_1a11e157943665cc9e3a9be1502ebeb3b5" prot="public" virt="non-virtual"><scope>org::example::foo::B</scope><name>bar</name></member>
- <member refid="classorg_1_1example_1_1foo_1_1_b_1a733f4e076f29c7d0c41ed258199ea1d9" prot="public" virt="non-virtual"><scope>org::example::foo::B</scope><name>baz</name></member>
- <member refid="classorg_1_1example_1_1foo_1_1_b_1ac6b627949b10b9357eefc0cafcae1d87" prot="protected" virt="non-virtual"><scope>org::example::foo::B</scope><name>qux</name></member>
- <member refid="interfaceorg_1_1example_1_1foo_1_1_c_1a4e97061eb40b045e820de05b33c43d21" prot="public" virt="non-virtual"><scope>org::example::foo::B</scope><name>THE_ANSWER</name></member>
- </listofallmembers>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="classorg_1_1example_1_1foo_1_1_empty_class" kind="class" prot="package">
- <compoundname>org::example::foo::EmptyClass</compoundname>
- <briefdescription>
-<para>This class is empty and is only visible in this package. </para> </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/EmptyClass.java" line="21" column="1" bodyfile="%SOURCE_DIRECTORY%/org/example/foo/EmptyClass.java" bodystart="21" bodyend="21"/>
- <listofallmembers>
- </listofallmembers>
- </compounddef>
-</doxygen>
+++ /dev/null
-<!-- XSLT script to combine the generated output into a single file.
- If you have xsltproc you could use:
- xsltproc combine.xslt index.xml >all.xml
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
- <xsl:output method="xml" version="1.0" indent="no" standalone="yes" />
- <xsl:template match="/">
- <doxygen version="{doxygenindex/@version}">
- <!-- Load all doxgen generated xml files -->
- <xsl:for-each select="doxygenindex/compound">
- <xsl:copy-of select="document( concat( @refid, '.xml' ) )/doxygen/*" />
- </xsl:for-each>
- </doxygen>
- </xsl:template>
-</xsl:stylesheet>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygen" type="DoxygenType"/>
-
- <!-- Complex types -->
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="compounddef" type="compounddefType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="version" type="DoxVersionNumber" use="required" />
- </xsd:complexType>
-
- <xsd:complexType name="compounddefType">
- <xsd:sequence>
- <xsd:element name="compoundname" type="xsd:string"/>
- <xsd:element name="title" type="xsd:string" minOccurs="0" />
- <xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="incdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inheritancegraph" type="graphType" minOccurs="0" />
- <xsd:element name="collaborationgraph" type="graphType" minOccurs="0" />
- <xsd:element name="programlisting" type="listingType" minOccurs="0" />
- <xsd:element name="location" type="locationType" minOccurs="0" />
- <xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="kind" type="DoxCompoundKind" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="abstract" type="DoxBool" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listofallmembersType">
- <xsd:sequence>
- <xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="memberRefType">
- <xsd:sequence>
- <xsd:element name="scope" />
- <xsd:element name="name" />
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- <xsd:attribute name="ambiguityscope" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="compoundRefType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" use="optional" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="reimplementType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="incType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="local" type="DoxBool" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refTextType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- <xsd:attribute name="tooltip" type="xsd:string" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="sectiondefType">
- <xsd:sequence>
- <xsd:element name="header" type="xsd:string" minOccurs="0" />
- <xsd:element name="description" type="descriptionType" minOccurs="0" />
- <xsd:element name="memberdef" type="memberdefType" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="memberdefType">
- <xsd:sequence>
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="definition" minOccurs="0" />
- <xsd:element name="argsstring" minOccurs="0" />
- <xsd:element name="name" />
- <xsd:element name="read" minOccurs="0" />
- <xsd:element name="write" minOccurs="0" />
- <xsd:element name="bitfield" minOccurs="0" />
- <xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="exceptions" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="location" type="locationType" />
- <xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxMemberKind" />
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="static" type="DoxBool" />
- <xsd:attribute name="const" type="DoxBool" use="optional"/>
- <xsd:attribute name="explicit" type="DoxBool" use="optional"/>
- <xsd:attribute name="inline" type="DoxBool" use="optional"/>
- <xsd:attribute name="virt" type="DoxVirtualKind" use="optional"/>
- <xsd:attribute name="volatile" type="DoxBool" use="optional"/>
- <xsd:attribute name="mutable" type="DoxBool" use="optional"/>
- <!-- Qt property -->
- <xsd:attribute name="readable" type="DoxBool" use="optional"/>
- <xsd:attribute name="writable" type="DoxBool" use="optional"/>
- <!-- C++/CLI variable -->
- <xsd:attribute name="initonly" type="DoxBool" use="optional"/>
- <!-- C++/CLI and C# property -->
- <xsd:attribute name="settable" type="DoxBool" use="optional"/>
- <xsd:attribute name="gettable" type="DoxBool" use="optional"/>
- <!-- C++/CLI function -->
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="new" type="DoxBool" use="optional"/>
- <!-- C++/CLI event -->
- <xsd:attribute name="add" type="DoxBool" use="optional"/>
- <xsd:attribute name="remove" type="DoxBool" use="optional"/>
- <xsd:attribute name="raise" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 protocol method -->
- <xsd:attribute name="optional" type="DoxBool" use="optional"/>
- <xsd:attribute name="required" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 property accessor -->
- <xsd:attribute name="accessor" type="DoxAccessor" use="optional"/>
- <!-- UNO IDL -->
- <xsd:attribute name="attribute" type="DoxBool" use="optional"/>
- <xsd:attribute name="property" type="DoxBool" use="optional"/>
- <xsd:attribute name="readonly" type="DoxBool" use="optional"/>
- <xsd:attribute name="bound" type="DoxBool" use="optional"/>
- <xsd:attribute name="removable" type="DoxBool" use="optional"/>
- <xsd:attribute name="contrained" type="DoxBool" use="optional"/>
- <xsd:attribute name="transient" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybevoid" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybedefault" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybeambiguous" type="DoxBool" use="optional"/>
-
- </xsd:complexType>
-
- <xsd:complexType name="descriptionType" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" minOccurs="0"/>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="enumvalueType" mixed="true">
- <xsd:sequence>
- <xsd:element name="name" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="templateparamlistType">
- <xsd:sequence>
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="paramType">
- <xsd:sequence>
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="declname" minOccurs="0" />
- <xsd:element name="defname" minOccurs="0" />
- <xsd:element name="array" minOccurs="0" />
- <xsd:element name="defval" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="linkedTextType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="graphType">
- <xsd:sequence>
- <xsd:element name="node" type="nodeType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="nodeType">
- <xsd:sequence>
- <xsd:element name="label" />
- <xsd:element name="link" type="linkType" minOccurs="0" />
- <xsd:element name="childnode" type="childnodeType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="childnodeType">
- <xsd:sequence>
- <xsd:element name="edgelabel" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="relation" type="DoxGraphRelation" />
- </xsd:complexType>
-
- <xsd:complexType name="linkType">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listingType">
- <xsd:sequence>
- <xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="codelineType">
- <xsd:sequence>
- <xsd:element name="highlight" type="highlightType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="lineno" type="xsd:integer" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="refkind" type="DoxRefKind" />
- <xsd:attribute name="external" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="highlightType" mixed="true">
- <xsd:choice minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="sp" />
- <xsd:element name="ref" type="refTextType" />
- </xsd:choice>
- <xsd:attribute name="class" type="DoxHighlightClass" />
- </xsd:complexType>
-
- <xsd:complexType name="referenceType" mixed="true">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="compoundref" type="xsd:string" use="optional" />
- <xsd:attribute name="startline" type="xsd:integer" />
- <xsd:attribute name="endline" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="locationType">
- <xsd:attribute name="file" type="xsd:string" />
- <xsd:attribute name="line" type="xsd:integer" />
- <xsd:attribute name="column" type="xsd:integer" use="optional"/>
- <xsd:attribute name="bodyfile" type="xsd:string" />
- <xsd:attribute name="bodystart" type="xsd:integer" />
- <xsd:attribute name="bodyend" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS1Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS2Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect4" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS3Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS4Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docInternalType" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docTitleCmdGroup">
- <xsd:choice>
- <xsd:element name="ulink" type="docURLLink" />
- <xsd:element name="bold" type="docMarkupType" />
- <xsd:element name="emphasis" type="docMarkupType" />
- <xsd:element name="computeroutput" type="docMarkupType" />
- <xsd:element name="subscript" type="docMarkupType" />
- <xsd:element name="superscript" type="docMarkupType" />
- <xsd:element name="center" type="docMarkupType" />
- <xsd:element name="small" type="docMarkupType" />
- <xsd:element name="htmlonly" type="xsd:string" />
- <xsd:element name="manonly" type="xsd:string" />
- <xsd:element name="xmlonly" type="xsd:string" />
- <xsd:element name="rtfonly" type="xsd:string" />
- <xsd:element name="latexonly" type="xsd:string" />
- <xsd:element name="dot" type="xsd:string" />
- <xsd:element name="plantuml" type="xsd:string" />
- <xsd:element name="anchor" type="docAnchorType" />
- <xsd:element name="formula" type="docFormulaType" />
- <xsd:element name="ref" type="docRefTextType" />
- <xsd:element name="nonbreakablespace" type="docEmptyType" />
- <xsd:element name="iexcl" type="docEmptyType" />
- <xsd:element name="cent" type="docEmptyType" />
- <xsd:element name="pound" type="docEmptyType" />
- <xsd:element name="curren" type="docEmptyType" />
- <xsd:element name="yen" type="docEmptyType" />
- <xsd:element name="brvbar" type="docEmptyType" />
- <xsd:element name="sect" type="docEmptyType" />
- <xsd:element name="umlaut" type="docEmptyType" />
- <xsd:element name="copy" type="docEmptyType" />
- <xsd:element name="ordf" type="docEmptyType" />
- <xsd:element name="laquo" type="docEmptyType" />
- <xsd:element name="not" type="docEmptyType" />
- <xsd:element name="shy" type="docEmptyType" />
- <xsd:element name="registered" type="docEmptyType" />
- <xsd:element name="macr" type="docEmptyType" />
- <xsd:element name="deg" type="docEmptyType" />
- <xsd:element name="plusmn" type="docEmptyType" />
- <xsd:element name="sup2" type="docEmptyType" />
- <xsd:element name="sup3" type="docEmptyType" />
- <xsd:element name="acute" type="docEmptyType" />
- <xsd:element name="micro" type="docEmptyType" />
- <xsd:element name="para" type="docEmptyType" />
- <xsd:element name="middot" type="docEmptyType" />
- <xsd:element name="cedil" type="docEmptyType" />
- <xsd:element name="sup1" type="docEmptyType" />
- <xsd:element name="ordm" type="docEmptyType" />
- <xsd:element name="raquo" type="docEmptyType" />
- <xsd:element name="frac14" type="docEmptyType" />
- <xsd:element name="frac12" type="docEmptyType" />
- <xsd:element name="frac34" type="docEmptyType" />
- <xsd:element name="iquest" type="docEmptyType" />
- <xsd:element name="Agrave" type="docEmptyType" />
- <xsd:element name="Aacute" type="docEmptyType" />
- <xsd:element name="Acirc" type="docEmptyType" />
- <xsd:element name="Atilde" type="docEmptyType" />
- <xsd:element name="Aumlaut" type="docEmptyType" />
- <xsd:element name="Aring" type="docEmptyType" />
- <xsd:element name="AElig" type="docEmptyType" />
- <xsd:element name="Ccedil" type="docEmptyType" />
- <xsd:element name="Egrave" type="docEmptyType" />
- <xsd:element name="Eacute" type="docEmptyType" />
- <xsd:element name="Ecirc" type="docEmptyType" />
- <xsd:element name="Eumlaut" type="docEmptyType" />
- <xsd:element name="Igrave" type="docEmptyType" />
- <xsd:element name="Iacute" type="docEmptyType" />
- <xsd:element name="Icirc" type="docEmptyType" />
- <xsd:element name="Iumlaut" type="docEmptyType" />
- <xsd:element name="ETH" type="docEmptyType" />
- <xsd:element name="Ntilde" type="docEmptyType" />
- <xsd:element name="Ograve" type="docEmptyType" />
- <xsd:element name="Oacute" type="docEmptyType" />
- <xsd:element name="Ocirc" type="docEmptyType" />
- <xsd:element name="Otilde" type="docEmptyType" />
- <xsd:element name="Oumlaut" type="docEmptyType" />
- <xsd:element name="times" type="docEmptyType" />
- <xsd:element name="Oslash" type="docEmptyType" />
- <xsd:element name="Ugrave" type="docEmptyType" />
- <xsd:element name="Uacute" type="docEmptyType" />
- <xsd:element name="Ucirc" type="docEmptyType" />
- <xsd:element name="Uumlaut" type="docEmptyType" />
- <xsd:element name="Yacute" type="docEmptyType" />
- <xsd:element name="THORN" type="docEmptyType" />
- <xsd:element name="szlig" type="docEmptyType" />
- <xsd:element name="agrave" type="docEmptyType" />
- <xsd:element name="aacute" type="docEmptyType" />
- <xsd:element name="acirc" type="docEmptyType" />
- <xsd:element name="atilde" type="docEmptyType" />
- <xsd:element name="aumlaut" type="docEmptyType" />
- <xsd:element name="aring" type="docEmptyType" />
- <xsd:element name="aelig" type="docEmptyType" />
- <xsd:element name="ccedil" type="docEmptyType" />
- <xsd:element name="egrave" type="docEmptyType" />
- <xsd:element name="eacute" type="docEmptyType" />
- <xsd:element name="ecirc" type="docEmptyType" />
- <xsd:element name="eumlaut" type="docEmptyType" />
- <xsd:element name="igrave" type="docEmptyType" />
- <xsd:element name="iacute" type="docEmptyType" />
- <xsd:element name="icirc" type="docEmptyType" />
- <xsd:element name="iumlaut" type="docEmptyType" />
- <xsd:element name="eth" type="docEmptyType" />
- <xsd:element name="ntilde" type="docEmptyType" />
- <xsd:element name="ograve" type="docEmptyType" />
- <xsd:element name="oacute" type="docEmptyType" />
- <xsd:element name="ocirc" type="docEmptyType" />
- <xsd:element name="otilde" type="docEmptyType" />
- <xsd:element name="oumlaut" type="docEmptyType" />
- <xsd:element name="divide" type="docEmptyType" />
- <xsd:element name="oslash" type="docEmptyType" />
- <xsd:element name="ugrave" type="docEmptyType" />
- <xsd:element name="uacute" type="docEmptyType" />
- <xsd:element name="ucirc" type="docEmptyType" />
- <xsd:element name="uumlaut" type="docEmptyType" />
- <xsd:element name="yacute" type="docEmptyType" />
- <xsd:element name="thorn" type="docEmptyType" />
- <xsd:element name="yumlaut" type="docEmptyType" />
- <xsd:element name="fnof" type="docEmptyType" />
- <xsd:element name="Alpha" type="docEmptyType" />
- <xsd:element name="Beta" type="docEmptyType" />
- <xsd:element name="Gamma" type="docEmptyType" />
- <xsd:element name="Delta" type="docEmptyType" />
- <xsd:element name="Epsilon" type="docEmptyType" />
- <xsd:element name="Zeta" type="docEmptyType" />
- <xsd:element name="Eta" type="docEmptyType" />
- <xsd:element name="Theta" type="docEmptyType" />
- <xsd:element name="Iota" type="docEmptyType" />
- <xsd:element name="Kappa" type="docEmptyType" />
- <xsd:element name="Lambda" type="docEmptyType" />
- <xsd:element name="Mu" type="docEmptyType" />
- <xsd:element name="Nu" type="docEmptyType" />
- <xsd:element name="Xi" type="docEmptyType" />
- <xsd:element name="Omicron" type="docEmptyType" />
- <xsd:element name="Pi" type="docEmptyType" />
- <xsd:element name="Rho" type="docEmptyType" />
- <xsd:element name="Sigma" type="docEmptyType" />
- <xsd:element name="Tau" type="docEmptyType" />
- <xsd:element name="Upsilon" type="docEmptyType" />
- <xsd:element name="Phi" type="docEmptyType" />
- <xsd:element name="Chi" type="docEmptyType" />
- <xsd:element name="Psi" type="docEmptyType" />
- <xsd:element name="Omega" type="docEmptyType" />
- <xsd:element name="alpha" type="docEmptyType" />
- <xsd:element name="beta" type="docEmptyType" />
- <xsd:element name="gamma" type="docEmptyType" />
- <xsd:element name="delta" type="docEmptyType" />
- <xsd:element name="epsilon" type="docEmptyType" />
- <xsd:element name="zeta" type="docEmptyType" />
- <xsd:element name="eta" type="docEmptyType" />
- <xsd:element name="theta" type="docEmptyType" />
- <xsd:element name="iota" type="docEmptyType" />
- <xsd:element name="kappa" type="docEmptyType" />
- <xsd:element name="lambda" type="docEmptyType" />
- <xsd:element name="mu" type="docEmptyType" />
- <xsd:element name="nu" type="docEmptyType" />
- <xsd:element name="xi" type="docEmptyType" />
- <xsd:element name="omicron" type="docEmptyType" />
- <xsd:element name="pi" type="docEmptyType" />
- <xsd:element name="rho" type="docEmptyType" />
- <xsd:element name="sigmaf" type="docEmptyType" />
- <xsd:element name="sigma" type="docEmptyType" />
- <xsd:element name="tau" type="docEmptyType" />
- <xsd:element name="upsilon" type="docEmptyType" />
- <xsd:element name="phi" type="docEmptyType" />
- <xsd:element name="chi" type="docEmptyType" />
- <xsd:element name="psi" type="docEmptyType" />
- <xsd:element name="omega" type="docEmptyType" />
- <xsd:element name="thetasym" type="docEmptyType" />
- <xsd:element name="upsih" type="docEmptyType" />
- <xsd:element name="piv" type="docEmptyType" />
- <xsd:element name="bull" type="docEmptyType" />
- <xsd:element name="hellip" type="docEmptyType" />
- <xsd:element name="prime" type="docEmptyType" />
- <xsd:element name="Prime" type="docEmptyType" />
- <xsd:element name="oline" type="docEmptyType" />
- <xsd:element name="frasl" type="docEmptyType" />
- <xsd:element name="weierp" type="docEmptyType" />
- <xsd:element name="image" type="docEmptyType" />
- <xsd:element name="real" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- <xsd:element name="alefsym" type="docEmptyType" />
- <xsd:element name="larr" type="docEmptyType" />
- <xsd:element name="uarr" type="docEmptyType" />
- <xsd:element name="rarr" type="docEmptyType" />
- <xsd:element name="darr" type="docEmptyType" />
- <xsd:element name="harr" type="docEmptyType" />
- <xsd:element name="crarr" type="docEmptyType" />
- <xsd:element name="lArr" type="docEmptyType" />
- <xsd:element name="uArr" type="docEmptyType" />
- <xsd:element name="rArr" type="docEmptyType" />
- <xsd:element name="dArr" type="docEmptyType" />
- <xsd:element name="hArr" type="docEmptyType" />
- <xsd:element name="forall" type="docEmptyType" />
- <xsd:element name="part" type="docEmptyType" />
- <xsd:element name="exist" type="docEmptyType" />
- <xsd:element name="empty" type="docEmptyType" />
- <xsd:element name="nabla" type="docEmptyType" />
- <xsd:element name="isin" type="docEmptyType" />
- <xsd:element name="notin" type="docEmptyType" />
- <xsd:element name="ni" type="docEmptyType" />
- <xsd:element name="prod" type="docEmptyType" />
- <xsd:element name="sum" type="docEmptyType" />
- <xsd:element name="minus" type="docEmptyType" />
- <xsd:element name="lowast" type="docEmptyType" />
- <xsd:element name="radic" type="docEmptyType" />
- <xsd:element name="prop" type="docEmptyType" />
- <xsd:element name="infin" type="docEmptyType" />
- <xsd:element name="ang" type="docEmptyType" />
- <xsd:element name="and" type="docEmptyType" />
- <xsd:element name="or" type="docEmptyType" />
- <xsd:element name="cap" type="docEmptyType" />
- <xsd:element name="cup" type="docEmptyType" />
- <xsd:element name="int" type="docEmptyType" />
- <xsd:element name="there4" type="docEmptyType" />
- <xsd:element name="sim" type="docEmptyType" />
- <xsd:element name="cong" type="docEmptyType" />
- <xsd:element name="asymp" type="docEmptyType" />
- <xsd:element name="ne" type="docEmptyType" />
- <xsd:element name="equiv" type="docEmptyType" />
- <xsd:element name="le" type="docEmptyType" />
- <xsd:element name="ge" type="docEmptyType" />
- <xsd:element name="sub" type="docEmptyType" />
- <xsd:element name="sup" type="docEmptyType" />
- <xsd:element name="nsub" type="docEmptyType" />
- <xsd:element name="sube" type="docEmptyType" />
- <xsd:element name="supe" type="docEmptyType" />
- <xsd:element name="oplus" type="docEmptyType" />
- <xsd:element name="otimes" type="docEmptyType" />
- <xsd:element name="perp" type="docEmptyType" />
- <xsd:element name="sdot" type="docEmptyType" />
- <xsd:element name="lceil" type="docEmptyType" />
- <xsd:element name="rceil" type="docEmptyType" />
- <xsd:element name="lfloor" type="docEmptyType" />
- <xsd:element name="rfloor" type="docEmptyType" />
- <xsd:element name="lang" type="docEmptyType" />
- <xsd:element name="rang" type="docEmptyType" />
- <xsd:element name="loz" type="docEmptyType" />
- <xsd:element name="spades" type="docEmptyType" />
- <xsd:element name="clubs" type="docEmptyType" />
- <xsd:element name="hearts" type="docEmptyType" />
- <xsd:element name="diams" type="docEmptyType" />
- <xsd:element name="OElig" type="docEmptyType" />
- <xsd:element name="oelig" type="docEmptyType" />
- <xsd:element name="Scaron" type="docEmptyType" />
- <xsd:element name="scaron" type="docEmptyType" />
- <xsd:element name="Yumlaut" type="docEmptyType" />
- <xsd:element name="circ" type="docEmptyType" />
- <xsd:element name="tilde" type="docEmptyType" />
- <xsd:element name="ensp" type="docEmptyType" />
- <xsd:element name="emsp" type="docEmptyType" />
- <xsd:element name="thinsp" type="docEmptyType" />
- <xsd:element name="zwnj" type="docEmptyType" />
- <xsd:element name="zwj" type="docEmptyType" />
- <xsd:element name="lrm" type="docEmptyType" />
- <xsd:element name="rlm" type="docEmptyType" />
- <xsd:element name="ndash" type="docEmptyType" />
- <xsd:element name="mdash" type="docEmptyType" />
- <xsd:element name="lsquo" type="docEmptyType" />
- <xsd:element name="rsquo" type="docEmptyType" />
- <xsd:element name="sbquo" type="docEmptyType" />
- <xsd:element name="ldquo" type="docEmptyType" />
- <xsd:element name="rdquo" type="docEmptyType" />
- <xsd:element name="bdquo" type="docEmptyType" />
- <xsd:element name="dagger" type="docEmptyType" />
- <xsd:element name="Dagger" type="docEmptyType" />
- <xsd:element name="permil" type="docEmptyType" />
- <xsd:element name="lsaquo" type="docEmptyType" />
- <xsd:element name="rsaquo" type="docEmptyType" />
- <xsd:element name="euro" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docTitleType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:group name="docCmdGroup">
- <xsd:choice>
- <xsd:group ref="docTitleCmdGroup"/>
- <xsd:element name="linebreak" type="docEmptyType" />
- <xsd:element name="hruler" type="docEmptyType" />
- <xsd:element name="preformatted" type="docMarkupType" />
- <xsd:element name="programlisting" type="listingType" />
- <xsd:element name="verbatim" type="xsd:string" />
- <xsd:element name="indexentry" type="docIndexEntryType" />
- <xsd:element name="orderedlist" type="docListType" />
- <xsd:element name="itemizedlist" type="docListType" />
- <xsd:element name="simplesect" type="docSimpleSectType" />
- <xsd:element name="title" type="docTitleType" />
- <xsd:element name="variablelist" type="docVariableListType" />
- <xsd:element name="table" type="docTableType" />
- <xsd:element name="heading" type="docHeadingType" />
- <xsd:element name="image" type="docImageType" />
- <xsd:element name="dotfile" type="docFileType" />
- <xsd:element name="mscfile" type="docFileType" />
- <xsd:element name="diafile" type="docFileType" />
- <xsd:element name="toclist" type="docTocListType" />
- <xsd:element name="language" type="docLanguageType" />
- <xsd:element name="parameterlist" type="docParamListType" />
- <xsd:element name="xrefsect" type="docXRefSectType" />
- <xsd:element name="copydoc" type="docCopyType" />
- <xsd:element name="blockquote" type="docBlockQuoteType" />
- <xsd:element name="parblock" type="docParBlockType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docParaType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docMarkupType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docURLLink" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="url" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docAnchorType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFormulaType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docIndexEntryType">
- <xsd:sequence>
- <xsd:element name="primaryie" type="xsd:string" />
- <xsd:element name="secondaryie" type="xsd:string" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListType">
- <xsd:sequence>
- <xsd:element name="listitem" type="docListItemType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListItemType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docSimpleSectType">
- <xsd:sequence>
- <xsd:element name="title" type="docTitleType" minOccurs="0" />
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="para" type="docParaType" minOccurs="1" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSimpleSectKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docVarListEntryType">
- <xsd:sequence>
- <xsd:element name="term" type="docTitleType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docVariableListGroup">
- <xsd:sequence>
- <xsd:element name="varlistentry" type="docVarListEntryType" />
- <xsd:element name="listitem" type="docListItemType" />
- </xsd:sequence>
- </xsd:group>
-
- <xsd:complexType name="docVariableListType">
- <xsd:sequence>
- <xsd:group ref="docVariableListGroup" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docRefTextType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTableType">
- <xsd:sequence>
- <xsd:element name="row" type="docRowType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="caption" type="docCaptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="rows" type="xsd:integer" />
- <xsd:attribute name="cols" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docRowType">
- <xsd:sequence>
- <xsd:element name="entry" type="docEntryType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEntryType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="thead" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="docCaptionType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docHeadingType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="level" type="xsd:integer" /> <!-- todo: range 1-6 -->
- </xsd:complexType>
-
- <xsd:complexType name="docImageType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="type" type="DoxImageKind" />
- <xsd:attribute name="name" type="xsd:string" />
- <xsd:attribute name="width" type="xsd:string" />
- <xsd:attribute name="height" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFileType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="name" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocItemType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocListType">
- <xsd:sequence>
- <xsd:element name="tocitem" type="docTocItemType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docLanguageType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="langid" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListType">
- <xsd:sequence>
- <xsd:element name="parameteritem" type="docParamListItem" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxParamListKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListItem">
- <xsd:sequence>
- <xsd:element name="parameternamelist" type="docParamNameList" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parameterdescription" type="descriptionType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamNameList">
- <xsd:sequence>
- <xsd:element name="parametertype" type="docParamType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parametername" type="docParamName" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamName" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- <xsd:attribute name="direction" type="DoxParamDir" use="optional" />
- </xsd:complexType>
-
- <xsd:complexType name="docXRefSectType">
- <xsd:sequence>
- <xsd:element name="xreftitle" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="xrefdescription" type="descriptionType" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docCopyType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="link" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docBlockQuoteType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParBlockType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEmptyType"/>
-
- <!-- Simple types -->
-
- <xsd:simpleType name="DoxBool">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="yes" />
- <xsd:enumeration value="no" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxGraphRelation">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="include" />
- <xsd:enumeration value="usage" />
- <xsd:enumeration value="template-instance" />
- <xsd:enumeration value="public-inheritance" />
- <xsd:enumeration value="protected-inheritance" />
- <xsd:enumeration value="private-inheritance" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxRefKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="compound" />
- <xsd:enumeration value="member" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxMemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="variable" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="function" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="dcop" />
- <xsd:enumeration value="slot" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="service" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxProtectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="public" />
- <xsd:enumeration value="protected" />
- <xsd:enumeration value="private" />
- <xsd:enumeration value="package" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVirtualKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="non-virtual" />
- <xsd:enumeration value="virtual" />
- <xsd:enumeration value="pure-virtual" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class" />
- <xsd:enumeration value="struct" />
- <xsd:enumeration value="union" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="protocol" />
- <xsd:enumeration value="category" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="service" />
- <xsd:enumeration value="singleton" />
- <xsd:enumeration value="module" />
- <xsd:enumeration value="type" />
- <xsd:enumeration value="file" />
- <xsd:enumeration value="namespace" />
- <xsd:enumeration value="group" />
- <xsd:enumeration value="page" />
- <xsd:enumeration value="example" />
- <xsd:enumeration value="dir" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="user-defined" />
- <xsd:enumeration value="public-type" />
- <xsd:enumeration value="public-func" />
- <xsd:enumeration value="public-attrib" />
- <xsd:enumeration value="public-slot" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="dcop-func" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="public-static-func" />
- <xsd:enumeration value="public-static-attrib" />
- <xsd:enumeration value="protected-type" />
- <xsd:enumeration value="protected-func" />
- <xsd:enumeration value="protected-attrib" />
- <xsd:enumeration value="protected-slot" />
- <xsd:enumeration value="protected-static-func" />
- <xsd:enumeration value="protected-static-attrib" />
- <xsd:enumeration value="package-type" />
- <xsd:enumeration value="package-func" />
- <xsd:enumeration value="package-attrib" />
- <xsd:enumeration value="package-static-func" />
- <xsd:enumeration value="package-static-attrib" />
- <xsd:enumeration value="private-type" />
- <xsd:enumeration value="private-func" />
- <xsd:enumeration value="private-attrib" />
- <xsd:enumeration value="private-slot" />
- <xsd:enumeration value="private-static-func" />
- <xsd:enumeration value="private-static-attrib" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="related" />
- <xsd:enumeration value="define" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="func" />
- <xsd:enumeration value="var" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxHighlightClass">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="comment" />
- <xsd:enumeration value="normal" />
- <xsd:enumeration value="preprocessor" />
- <xsd:enumeration value="keyword" />
- <xsd:enumeration value="keywordtype" />
- <xsd:enumeration value="keywordflow" />
- <xsd:enumeration value="stringliteral" />
- <xsd:enumeration value="charliteral" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSimpleSectKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="see" />
- <xsd:enumeration value="return" />
- <xsd:enumeration value="author" />
- <xsd:enumeration value="authors" />
- <xsd:enumeration value="version" />
- <xsd:enumeration value="since" />
- <xsd:enumeration value="date" />
- <xsd:enumeration value="note" />
- <xsd:enumeration value="warning" />
- <xsd:enumeration value="pre" />
- <xsd:enumeration value="post" />
- <xsd:enumeration value="copyright" />
- <xsd:enumeration value="invariant" />
- <xsd:enumeration value="remark" />
- <xsd:enumeration value="attention" />
- <xsd:enumeration value="par" />
- <xsd:enumeration value="rcs" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVersionNumber">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="\d+\.\d+.*" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxImageKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="html" />
- <xsd:enumeration value="latex" />
- <xsd:enumeration value="rtf" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamListKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="param" />
- <xsd:enumeration value="retval" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="templateparam" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCharRange">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="[aeiouncAEIOUNC]" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamDir">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="in"/>
- <xsd:enumeration value="out"/>
- <xsd:enumeration value="inout"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxAccessor">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="retain"/>
- <xsd:enumeration value="copy"/>
- <xsd:enumeration value="assign"/>
- <xsd:enumeration value="weak"/>
- <xsd:enumeration value="strong"/>
- <xsd:enumeration value="unretained"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="dir_68267d1309a1af8e8297ef4c3efbcdba" kind="dir">
- <compoundname>src</compoundname>
- <innerdir refid="dir_b8e0663afee48cb679b74bbd21bdf843">src/org</innerdir>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="dir_8c35fc67c36f89d827afb23e8c52a418" kind="dir">
- <compoundname>src/org/example</compoundname>
- <innerdir refid="dir_ad5d6582648a7bbb3a301939a41e6c0b">src/org/example/foo</innerdir>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/example/"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="dir_ad5d6582648a7bbb3a301939a41e6c0b" kind="dir">
- <compoundname>src/org/example/foo</compoundname>
- <innerfile refid="_a_8java">A.java</innerfile>
- <innerfile refid="_b_8java">B.java</innerfile>
- <innerfile refid="_c_8java">C.java</innerfile>
- <innerfile refid="_empty_class_8java">EmptyClass.java</innerfile>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="dir_b8e0663afee48cb679b74bbd21bdf843" kind="dir">
- <compoundname>src/org</compoundname>
- <innerdir refid="dir_8c35fc67c36f89d827afb23e8c52a418">src/org/example</innerdir>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygenindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="index.xsd" version="1.8.8">
- <compound refid="classorg_1_1example_1_1foo_1_1_a" kind="class"><name>org::example::foo::A</name>
- <member refid="classorg_1_1example_1_1foo_1_1_a_1add415ae4129969055d678c7e7e048852" kind="function"><name>bar</name></member>
- </compound>
- <compound refid="classorg_1_1example_1_1foo_1_1_b" kind="class"><name>org::example::foo::B</name>
- <member refid="classorg_1_1example_1_1foo_1_1_b_1ac6b627949b10b9357eefc0cafcae1d87" kind="variable"><name>qux</name></member>
- <member refid="classorg_1_1example_1_1foo_1_1_b_1a11e157943665cc9e3a9be1502ebeb3b5" kind="function"><name>bar</name></member>
- <member refid="classorg_1_1example_1_1foo_1_1_b_1a733f4e076f29c7d0c41ed258199ea1d9" kind="function"><name>baz</name></member>
- </compound>
- <compound refid="interfaceorg_1_1example_1_1foo_1_1_c" kind="interface"><name>org::example::foo::C</name>
- <member refid="interfaceorg_1_1example_1_1foo_1_1_c_1a4e97061eb40b045e820de05b33c43d21" kind="variable"><name>THE_ANSWER</name></member>
- <member refid="interfaceorg_1_1example_1_1foo_1_1_c_1a28ac7ce349ebb3e4a7747a8dd951582b" kind="function"><name>baz</name></member>
- </compound>
- <compound refid="classorg_1_1example_1_1foo_1_1_empty_class" kind="class"><name>org::example::foo::EmptyClass</name>
- </compound>
- <compound refid="namespaceorg" kind="namespace"><name>org</name>
- </compound>
- <compound refid="namespaceorg_1_1example" kind="namespace"><name>org::example</name>
- </compound>
- <compound refid="namespaceorg_1_1example_1_1foo" kind="namespace"><name>org::example::foo</name>
- </compound>
- <compound refid="_a_8java" kind="file"><name>A.java</name>
- </compound>
- <compound refid="_b_8java" kind="file"><name>B.java</name>
- </compound>
- <compound refid="_c_8java" kind="file"><name>C.java</name>
- </compound>
- <compound refid="_empty_class_8java" kind="file"><name>EmptyClass.java</name>
- </compound>
- <compound refid="dir_8c35fc67c36f89d827afb23e8c52a418" kind="dir"><name>src/org/example</name>
- </compound>
- <compound refid="dir_ad5d6582648a7bbb3a301939a41e6c0b" kind="dir"><name>src/org/example/foo</name>
- </compound>
- <compound refid="dir_b8e0663afee48cb679b74bbd21bdf843" kind="dir"><name>src/org</name>
- </compound>
- <compound refid="dir_68267d1309a1af8e8297ef4c3efbcdba" kind="dir"><name>src</name>
- </compound>
-</doxygenindex>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygenindex" type="DoxygenType"/>
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence>
- <xsd:element name="compound" type="CompoundType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="version" type="xsd:string" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="CompoundType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- <xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="CompoundKind" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="MemberType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="MemberKind" use="required"/>
- </xsd:complexType>
-
- <xsd:simpleType name="CompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class"/>
- <xsd:enumeration value="struct"/>
- <xsd:enumeration value="union"/>
- <xsd:enumeration value="interface"/>
- <xsd:enumeration value="protocol"/>
- <xsd:enumeration value="category"/>
- <xsd:enumeration value="exception"/>
- <xsd:enumeration value="file"/>
- <xsd:enumeration value="namespace"/>
- <xsd:enumeration value="group"/>
- <xsd:enumeration value="page"/>
- <xsd:enumeration value="example"/>
- <xsd:enumeration value="dir"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="MemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define"/>
- <xsd:enumeration value="property"/>
- <xsd:enumeration value="event"/>
- <xsd:enumeration value="variable"/>
- <xsd:enumeration value="typedef"/>
- <xsd:enumeration value="enum"/>
- <xsd:enumeration value="enumvalue"/>
- <xsd:enumeration value="function"/>
- <xsd:enumeration value="signal"/>
- <xsd:enumeration value="prototype"/>
- <xsd:enumeration value="friend"/>
- <xsd:enumeration value="dcop"/>
- <xsd:enumeration value="slot"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="interfaceorg_1_1example_1_1foo_1_1_c" kind="interface" prot="public">
- <compoundname>org::example::foo::C</compoundname>
- <derivedcompoundref refid="classorg_1_1example_1_1foo_1_1_b" prot="public" virt="non-virtual">org.example.foo.B</derivedcompoundref>
- <sectiondef kind="public-static-attrib">
- <memberdef kind="variable" id="interfaceorg_1_1example_1_1foo_1_1_c_1a4e97061eb40b045e820de05b33c43d21" prot="public" static="yes" mutable="no">
- <type>final long</type>
- <definition>final long org.example.foo.C.THE_ANSWER</definition>
- <argsstring></argsstring>
- <name>THE_ANSWER</name>
- <initializer>= 42L</initializer>
- <briefdescription>
-<para>“Answer to the Ultimate Question of Life, the Universe, and Everything. </para> </briefdescription>
- <detaileddescription>
-<para>“ </para> </detaileddescription>
- <inbodydescription>
- </inbodydescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/C.java" line="25" column="1" bodyfile="%SOURCE_DIRECTORY%/org/example/foo/C.java" bodystart="25" bodyend="-1"/>
- </memberdef>
- </sectiondef>
- <sectiondef kind="public-func">
- <memberdef kind="function" id="interfaceorg_1_1example_1_1foo_1_1_c_1a28ac7ce349ebb3e4a7747a8dd951582b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
- <type>void</type>
- <definition>void org.example.foo.C.baz</definition>
- <argsstring>()</argsstring>
- <name>baz</name>
- <reimplementedby refid="classorg_1_1example_1_1foo_1_1_b_1a733f4e076f29c7d0c41ed258199ea1d9">baz</reimplementedby>
- <briefdescription>
-<para><ref refid="classorg_1_1example_1_1foo_1_1_a" kindref="compound">A</ref> function with implicit modifiers. </para> </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <inbodydescription>
- </inbodydescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/C.java" line="30" column="1"/>
- </memberdef>
- </sectiondef>
- <briefdescription>
-<para>An interface. </para> </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <inheritancegraph>
- <node id="10">
- <label>org.example.foo.B</label>
- <link refid="classorg_1_1example_1_1foo_1_1_b"/>
- <childnode refid="9" relation="public-inheritance">
- </childnode>
- </node>
- <node id="9">
- <label>org.example.foo.C</label>
- <link refid="interfaceorg_1_1example_1_1foo_1_1_c"/>
- </node>
- </inheritancegraph>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/C.java" line="21" column="1" bodyfile="%SOURCE_DIRECTORY%/org/example/foo/C.java" bodystart="21" bodyend="31"/>
- <listofallmembers>
- <member refid="interfaceorg_1_1example_1_1foo_1_1_c_1a28ac7ce349ebb3e4a7747a8dd951582b" prot="public" virt="non-virtual"><scope>org::example::foo::C</scope><name>baz</name></member>
- <member refid="interfaceorg_1_1example_1_1foo_1_1_c_1a4e97061eb40b045e820de05b33c43d21" prot="public" virt="non-virtual"><scope>org::example::foo::C</scope><name>THE_ANSWER</name></member>
- </listofallmembers>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="namespaceorg" kind="namespace">
- <compoundname>org</compoundname>
- <innernamespace refid="namespaceorg_1_1example">org::example</innernamespace>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="[generated]" line="1" column="1"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="namespaceorg_1_1example" kind="namespace">
- <compoundname>org::example</compoundname>
- <innernamespace refid="namespaceorg_1_1example_1_1foo">org::example::foo</innernamespace>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="[generated]" line="1" column="1"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="namespaceorg_1_1example_1_1foo" kind="namespace">
- <compoundname>org::example::foo</compoundname>
- <innerclass refid="classorg_1_1example_1_1foo_1_1_a" prot="public">org::example::foo::A</innerclass>
- <innerclass refid="classorg_1_1example_1_1foo_1_1_b" prot="public">org::example::foo::B</innerclass>
- <innerclass refid="interfaceorg_1_1example_1_1foo_1_1_c" prot="public">org::example::foo::C</innerclass>
- <innerclass refid="classorg_1_1example_1_1foo_1_1_empty_class" prot="package">org::example::foo::EmptyClass</innerclass>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/org/example/foo/A.java" line="16" column="1"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-# Doxyfile 1.8.8
-
-# 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 = "Test Project"
-
-# 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 =
-
-# 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 =
-
-# With the PROJECT_LOGO tag one can specify a logo or an 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
-
-# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
-# characters to appear in the names of generated files. If set to NO, non-ASCII
-# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
-# U+3044.
-# The default value is: NO.
-
-ALLOW_UNICODE_NAMES = 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 = YES
-
-# 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
-
-# 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 =
-
-# 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 (fixed format Fortran:
-# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
-# Fortran. In the later case the parser tries to guess whether the code is fixed
-# or free formatted code, this is the default for Fortran type files), 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 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. If 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 = NO
-
-# 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 = YES
-
-# 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 =
-
-# 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. 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 = src
-
-# 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 =
-
-# 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 =
-
-# 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 =
-
-# 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 = *
-
-# 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 =
-
-# 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 =
-
-#---------------------------------------------------------------------------
-# 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 = NO
-
-# 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 additional user-defined
-# cascading style sheets that are 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 therefore more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
-# Note: The order of the extra stylesheet files is of importance (e.g. the last
-# stylesheet in the list overrules the setting of the previous ones in the
-# list). 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. Furthermore it
-# enables the Previous and Next buttons.
-# 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
-
-# If 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 pre-rendered 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 flavors 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,
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# string, for the replacement values of the other commands the user is referred
-# to HTML_HEADER.
-# 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. See
-# LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the 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 USE_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
-
-# The MAN_SUBDIR tag determines the name of the directory created within
-# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
-# MAN_EXTENSION with the initial . removed.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_SUBDIR =
-
-# 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
-
-# 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 = NO
-
-#---------------------------------------------------------------------------
-# 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
-
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
-#---------------------------------------------------------------------------
-# 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 include 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 references 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 a 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 = YES
-
-# 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 = NO
-
-# 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 in 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 = YES
-
-# 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 = NO
-
-# 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 = NO
-
-# 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 =
-
-# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
-# path where java can find the plantuml.jar file. If left blank, it is assumed
-# PlantUML is not used or called during a preprocessing step. Doxygen will
-# generate a warning when it encounters a \startuml command in this case and
-# will not generate output for the diagram.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-PLANTUML_JAR_PATH =
-
-# 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 to 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
+++ /dev/null
-This directory contains a dummy Python project for testing purposes.
-
-To regenerate the XML output located in `xml`, run `make`. If the `Makefile`
-does not exists, you can regenerate it by running `make bootstrap` in the parent
-directory.
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-## A `bar` function in the `foo` namespace.
-def bar:
- """By default, Doxygen recognizes anything in the docstrings as verbatim
- detailed description."""
- pass
+++ /dev/null
-<!-- XSLT script to combine the generated output into a single file.
- If you have xsltproc you could use:
- xsltproc combine.xslt index.xml >all.xml
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
- <xsl:output method="xml" version="1.0" indent="no" standalone="yes" />
- <xsl:template match="/">
- <doxygen version="{doxygenindex/@version}">
- <!-- Load all doxgen generated xml files -->
- <xsl:for-each select="doxygenindex/compound">
- <xsl:copy-of select="document( concat( @refid, '.xml' ) )/doxygen/*" />
- </xsl:for-each>
- </doxygen>
- </xsl:template>
-</xsl:stylesheet>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygen" type="DoxygenType"/>
-
- <!-- Complex types -->
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="compounddef" type="compounddefType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="version" type="DoxVersionNumber" use="required" />
- </xsd:complexType>
-
- <xsd:complexType name="compounddefType">
- <xsd:sequence>
- <xsd:element name="compoundname" type="xsd:string"/>
- <xsd:element name="title" type="xsd:string" minOccurs="0" />
- <xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="incdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inheritancegraph" type="graphType" minOccurs="0" />
- <xsd:element name="collaborationgraph" type="graphType" minOccurs="0" />
- <xsd:element name="programlisting" type="listingType" minOccurs="0" />
- <xsd:element name="location" type="locationType" minOccurs="0" />
- <xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="kind" type="DoxCompoundKind" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="abstract" type="DoxBool" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listofallmembersType">
- <xsd:sequence>
- <xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="memberRefType">
- <xsd:sequence>
- <xsd:element name="scope" />
- <xsd:element name="name" />
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- <xsd:attribute name="ambiguityscope" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="compoundRefType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" use="optional" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="reimplementType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="incType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="local" type="DoxBool" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refTextType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- <xsd:attribute name="tooltip" type="xsd:string" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="sectiondefType">
- <xsd:sequence>
- <xsd:element name="header" type="xsd:string" minOccurs="0" />
- <xsd:element name="description" type="descriptionType" minOccurs="0" />
- <xsd:element name="memberdef" type="memberdefType" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="memberdefType">
- <xsd:sequence>
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="definition" minOccurs="0" />
- <xsd:element name="argsstring" minOccurs="0" />
- <xsd:element name="name" />
- <xsd:element name="read" minOccurs="0" />
- <xsd:element name="write" minOccurs="0" />
- <xsd:element name="bitfield" minOccurs="0" />
- <xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="exceptions" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="location" type="locationType" />
- <xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxMemberKind" />
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="static" type="DoxBool" />
- <xsd:attribute name="const" type="DoxBool" use="optional"/>
- <xsd:attribute name="explicit" type="DoxBool" use="optional"/>
- <xsd:attribute name="inline" type="DoxBool" use="optional"/>
- <xsd:attribute name="virt" type="DoxVirtualKind" use="optional"/>
- <xsd:attribute name="volatile" type="DoxBool" use="optional"/>
- <xsd:attribute name="mutable" type="DoxBool" use="optional"/>
- <!-- Qt property -->
- <xsd:attribute name="readable" type="DoxBool" use="optional"/>
- <xsd:attribute name="writable" type="DoxBool" use="optional"/>
- <!-- C++/CLI variable -->
- <xsd:attribute name="initonly" type="DoxBool" use="optional"/>
- <!-- C++/CLI and C# property -->
- <xsd:attribute name="settable" type="DoxBool" use="optional"/>
- <xsd:attribute name="gettable" type="DoxBool" use="optional"/>
- <!-- C++/CLI function -->
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="new" type="DoxBool" use="optional"/>
- <!-- C++/CLI event -->
- <xsd:attribute name="add" type="DoxBool" use="optional"/>
- <xsd:attribute name="remove" type="DoxBool" use="optional"/>
- <xsd:attribute name="raise" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 protocol method -->
- <xsd:attribute name="optional" type="DoxBool" use="optional"/>
- <xsd:attribute name="required" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 property accessor -->
- <xsd:attribute name="accessor" type="DoxAccessor" use="optional"/>
- <!-- UNO IDL -->
- <xsd:attribute name="attribute" type="DoxBool" use="optional"/>
- <xsd:attribute name="property" type="DoxBool" use="optional"/>
- <xsd:attribute name="readonly" type="DoxBool" use="optional"/>
- <xsd:attribute name="bound" type="DoxBool" use="optional"/>
- <xsd:attribute name="removable" type="DoxBool" use="optional"/>
- <xsd:attribute name="contrained" type="DoxBool" use="optional"/>
- <xsd:attribute name="transient" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybevoid" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybedefault" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybeambiguous" type="DoxBool" use="optional"/>
-
- </xsd:complexType>
-
- <xsd:complexType name="descriptionType" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" minOccurs="0"/>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="enumvalueType" mixed="true">
- <xsd:sequence>
- <xsd:element name="name" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="templateparamlistType">
- <xsd:sequence>
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="paramType">
- <xsd:sequence>
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="declname" minOccurs="0" />
- <xsd:element name="defname" minOccurs="0" />
- <xsd:element name="array" minOccurs="0" />
- <xsd:element name="defval" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="linkedTextType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="graphType">
- <xsd:sequence>
- <xsd:element name="node" type="nodeType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="nodeType">
- <xsd:sequence>
- <xsd:element name="label" />
- <xsd:element name="link" type="linkType" minOccurs="0" />
- <xsd:element name="childnode" type="childnodeType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="childnodeType">
- <xsd:sequence>
- <xsd:element name="edgelabel" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="relation" type="DoxGraphRelation" />
- </xsd:complexType>
-
- <xsd:complexType name="linkType">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listingType">
- <xsd:sequence>
- <xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="codelineType">
- <xsd:sequence>
- <xsd:element name="highlight" type="highlightType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="lineno" type="xsd:integer" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="refkind" type="DoxRefKind" />
- <xsd:attribute name="external" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="highlightType" mixed="true">
- <xsd:choice minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="sp" />
- <xsd:element name="ref" type="refTextType" />
- </xsd:choice>
- <xsd:attribute name="class" type="DoxHighlightClass" />
- </xsd:complexType>
-
- <xsd:complexType name="referenceType" mixed="true">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="compoundref" type="xsd:string" use="optional" />
- <xsd:attribute name="startline" type="xsd:integer" />
- <xsd:attribute name="endline" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="locationType">
- <xsd:attribute name="file" type="xsd:string" />
- <xsd:attribute name="line" type="xsd:integer" />
- <xsd:attribute name="column" type="xsd:integer" use="optional"/>
- <xsd:attribute name="bodyfile" type="xsd:string" />
- <xsd:attribute name="bodystart" type="xsd:integer" />
- <xsd:attribute name="bodyend" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS1Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS2Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect4" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS3Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS4Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docInternalType" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docTitleCmdGroup">
- <xsd:choice>
- <xsd:element name="ulink" type="docURLLink" />
- <xsd:element name="bold" type="docMarkupType" />
- <xsd:element name="emphasis" type="docMarkupType" />
- <xsd:element name="computeroutput" type="docMarkupType" />
- <xsd:element name="subscript" type="docMarkupType" />
- <xsd:element name="superscript" type="docMarkupType" />
- <xsd:element name="center" type="docMarkupType" />
- <xsd:element name="small" type="docMarkupType" />
- <xsd:element name="htmlonly" type="xsd:string" />
- <xsd:element name="manonly" type="xsd:string" />
- <xsd:element name="xmlonly" type="xsd:string" />
- <xsd:element name="rtfonly" type="xsd:string" />
- <xsd:element name="latexonly" type="xsd:string" />
- <xsd:element name="dot" type="xsd:string" />
- <xsd:element name="plantuml" type="xsd:string" />
- <xsd:element name="anchor" type="docAnchorType" />
- <xsd:element name="formula" type="docFormulaType" />
- <xsd:element name="ref" type="docRefTextType" />
- <xsd:element name="nonbreakablespace" type="docEmptyType" />
- <xsd:element name="iexcl" type="docEmptyType" />
- <xsd:element name="cent" type="docEmptyType" />
- <xsd:element name="pound" type="docEmptyType" />
- <xsd:element name="curren" type="docEmptyType" />
- <xsd:element name="yen" type="docEmptyType" />
- <xsd:element name="brvbar" type="docEmptyType" />
- <xsd:element name="sect" type="docEmptyType" />
- <xsd:element name="umlaut" type="docEmptyType" />
- <xsd:element name="copy" type="docEmptyType" />
- <xsd:element name="ordf" type="docEmptyType" />
- <xsd:element name="laquo" type="docEmptyType" />
- <xsd:element name="not" type="docEmptyType" />
- <xsd:element name="shy" type="docEmptyType" />
- <xsd:element name="registered" type="docEmptyType" />
- <xsd:element name="macr" type="docEmptyType" />
- <xsd:element name="deg" type="docEmptyType" />
- <xsd:element name="plusmn" type="docEmptyType" />
- <xsd:element name="sup2" type="docEmptyType" />
- <xsd:element name="sup3" type="docEmptyType" />
- <xsd:element name="acute" type="docEmptyType" />
- <xsd:element name="micro" type="docEmptyType" />
- <xsd:element name="para" type="docEmptyType" />
- <xsd:element name="middot" type="docEmptyType" />
- <xsd:element name="cedil" type="docEmptyType" />
- <xsd:element name="sup1" type="docEmptyType" />
- <xsd:element name="ordm" type="docEmptyType" />
- <xsd:element name="raquo" type="docEmptyType" />
- <xsd:element name="frac14" type="docEmptyType" />
- <xsd:element name="frac12" type="docEmptyType" />
- <xsd:element name="frac34" type="docEmptyType" />
- <xsd:element name="iquest" type="docEmptyType" />
- <xsd:element name="Agrave" type="docEmptyType" />
- <xsd:element name="Aacute" type="docEmptyType" />
- <xsd:element name="Acirc" type="docEmptyType" />
- <xsd:element name="Atilde" type="docEmptyType" />
- <xsd:element name="Aumlaut" type="docEmptyType" />
- <xsd:element name="Aring" type="docEmptyType" />
- <xsd:element name="AElig" type="docEmptyType" />
- <xsd:element name="Ccedil" type="docEmptyType" />
- <xsd:element name="Egrave" type="docEmptyType" />
- <xsd:element name="Eacute" type="docEmptyType" />
- <xsd:element name="Ecirc" type="docEmptyType" />
- <xsd:element name="Eumlaut" type="docEmptyType" />
- <xsd:element name="Igrave" type="docEmptyType" />
- <xsd:element name="Iacute" type="docEmptyType" />
- <xsd:element name="Icirc" type="docEmptyType" />
- <xsd:element name="Iumlaut" type="docEmptyType" />
- <xsd:element name="ETH" type="docEmptyType" />
- <xsd:element name="Ntilde" type="docEmptyType" />
- <xsd:element name="Ograve" type="docEmptyType" />
- <xsd:element name="Oacute" type="docEmptyType" />
- <xsd:element name="Ocirc" type="docEmptyType" />
- <xsd:element name="Otilde" type="docEmptyType" />
- <xsd:element name="Oumlaut" type="docEmptyType" />
- <xsd:element name="times" type="docEmptyType" />
- <xsd:element name="Oslash" type="docEmptyType" />
- <xsd:element name="Ugrave" type="docEmptyType" />
- <xsd:element name="Uacute" type="docEmptyType" />
- <xsd:element name="Ucirc" type="docEmptyType" />
- <xsd:element name="Uumlaut" type="docEmptyType" />
- <xsd:element name="Yacute" type="docEmptyType" />
- <xsd:element name="THORN" type="docEmptyType" />
- <xsd:element name="szlig" type="docEmptyType" />
- <xsd:element name="agrave" type="docEmptyType" />
- <xsd:element name="aacute" type="docEmptyType" />
- <xsd:element name="acirc" type="docEmptyType" />
- <xsd:element name="atilde" type="docEmptyType" />
- <xsd:element name="aumlaut" type="docEmptyType" />
- <xsd:element name="aring" type="docEmptyType" />
- <xsd:element name="aelig" type="docEmptyType" />
- <xsd:element name="ccedil" type="docEmptyType" />
- <xsd:element name="egrave" type="docEmptyType" />
- <xsd:element name="eacute" type="docEmptyType" />
- <xsd:element name="ecirc" type="docEmptyType" />
- <xsd:element name="eumlaut" type="docEmptyType" />
- <xsd:element name="igrave" type="docEmptyType" />
- <xsd:element name="iacute" type="docEmptyType" />
- <xsd:element name="icirc" type="docEmptyType" />
- <xsd:element name="iumlaut" type="docEmptyType" />
- <xsd:element name="eth" type="docEmptyType" />
- <xsd:element name="ntilde" type="docEmptyType" />
- <xsd:element name="ograve" type="docEmptyType" />
- <xsd:element name="oacute" type="docEmptyType" />
- <xsd:element name="ocirc" type="docEmptyType" />
- <xsd:element name="otilde" type="docEmptyType" />
- <xsd:element name="oumlaut" type="docEmptyType" />
- <xsd:element name="divide" type="docEmptyType" />
- <xsd:element name="oslash" type="docEmptyType" />
- <xsd:element name="ugrave" type="docEmptyType" />
- <xsd:element name="uacute" type="docEmptyType" />
- <xsd:element name="ucirc" type="docEmptyType" />
- <xsd:element name="uumlaut" type="docEmptyType" />
- <xsd:element name="yacute" type="docEmptyType" />
- <xsd:element name="thorn" type="docEmptyType" />
- <xsd:element name="yumlaut" type="docEmptyType" />
- <xsd:element name="fnof" type="docEmptyType" />
- <xsd:element name="Alpha" type="docEmptyType" />
- <xsd:element name="Beta" type="docEmptyType" />
- <xsd:element name="Gamma" type="docEmptyType" />
- <xsd:element name="Delta" type="docEmptyType" />
- <xsd:element name="Epsilon" type="docEmptyType" />
- <xsd:element name="Zeta" type="docEmptyType" />
- <xsd:element name="Eta" type="docEmptyType" />
- <xsd:element name="Theta" type="docEmptyType" />
- <xsd:element name="Iota" type="docEmptyType" />
- <xsd:element name="Kappa" type="docEmptyType" />
- <xsd:element name="Lambda" type="docEmptyType" />
- <xsd:element name="Mu" type="docEmptyType" />
- <xsd:element name="Nu" type="docEmptyType" />
- <xsd:element name="Xi" type="docEmptyType" />
- <xsd:element name="Omicron" type="docEmptyType" />
- <xsd:element name="Pi" type="docEmptyType" />
- <xsd:element name="Rho" type="docEmptyType" />
- <xsd:element name="Sigma" type="docEmptyType" />
- <xsd:element name="Tau" type="docEmptyType" />
- <xsd:element name="Upsilon" type="docEmptyType" />
- <xsd:element name="Phi" type="docEmptyType" />
- <xsd:element name="Chi" type="docEmptyType" />
- <xsd:element name="Psi" type="docEmptyType" />
- <xsd:element name="Omega" type="docEmptyType" />
- <xsd:element name="alpha" type="docEmptyType" />
- <xsd:element name="beta" type="docEmptyType" />
- <xsd:element name="gamma" type="docEmptyType" />
- <xsd:element name="delta" type="docEmptyType" />
- <xsd:element name="epsilon" type="docEmptyType" />
- <xsd:element name="zeta" type="docEmptyType" />
- <xsd:element name="eta" type="docEmptyType" />
- <xsd:element name="theta" type="docEmptyType" />
- <xsd:element name="iota" type="docEmptyType" />
- <xsd:element name="kappa" type="docEmptyType" />
- <xsd:element name="lambda" type="docEmptyType" />
- <xsd:element name="mu" type="docEmptyType" />
- <xsd:element name="nu" type="docEmptyType" />
- <xsd:element name="xi" type="docEmptyType" />
- <xsd:element name="omicron" type="docEmptyType" />
- <xsd:element name="pi" type="docEmptyType" />
- <xsd:element name="rho" type="docEmptyType" />
- <xsd:element name="sigmaf" type="docEmptyType" />
- <xsd:element name="sigma" type="docEmptyType" />
- <xsd:element name="tau" type="docEmptyType" />
- <xsd:element name="upsilon" type="docEmptyType" />
- <xsd:element name="phi" type="docEmptyType" />
- <xsd:element name="chi" type="docEmptyType" />
- <xsd:element name="psi" type="docEmptyType" />
- <xsd:element name="omega" type="docEmptyType" />
- <xsd:element name="thetasym" type="docEmptyType" />
- <xsd:element name="upsih" type="docEmptyType" />
- <xsd:element name="piv" type="docEmptyType" />
- <xsd:element name="bull" type="docEmptyType" />
- <xsd:element name="hellip" type="docEmptyType" />
- <xsd:element name="prime" type="docEmptyType" />
- <xsd:element name="Prime" type="docEmptyType" />
- <xsd:element name="oline" type="docEmptyType" />
- <xsd:element name="frasl" type="docEmptyType" />
- <xsd:element name="weierp" type="docEmptyType" />
- <xsd:element name="image" type="docEmptyType" />
- <xsd:element name="real" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- <xsd:element name="alefsym" type="docEmptyType" />
- <xsd:element name="larr" type="docEmptyType" />
- <xsd:element name="uarr" type="docEmptyType" />
- <xsd:element name="rarr" type="docEmptyType" />
- <xsd:element name="darr" type="docEmptyType" />
- <xsd:element name="harr" type="docEmptyType" />
- <xsd:element name="crarr" type="docEmptyType" />
- <xsd:element name="lArr" type="docEmptyType" />
- <xsd:element name="uArr" type="docEmptyType" />
- <xsd:element name="rArr" type="docEmptyType" />
- <xsd:element name="dArr" type="docEmptyType" />
- <xsd:element name="hArr" type="docEmptyType" />
- <xsd:element name="forall" type="docEmptyType" />
- <xsd:element name="part" type="docEmptyType" />
- <xsd:element name="exist" type="docEmptyType" />
- <xsd:element name="empty" type="docEmptyType" />
- <xsd:element name="nabla" type="docEmptyType" />
- <xsd:element name="isin" type="docEmptyType" />
- <xsd:element name="notin" type="docEmptyType" />
- <xsd:element name="ni" type="docEmptyType" />
- <xsd:element name="prod" type="docEmptyType" />
- <xsd:element name="sum" type="docEmptyType" />
- <xsd:element name="minus" type="docEmptyType" />
- <xsd:element name="lowast" type="docEmptyType" />
- <xsd:element name="radic" type="docEmptyType" />
- <xsd:element name="prop" type="docEmptyType" />
- <xsd:element name="infin" type="docEmptyType" />
- <xsd:element name="ang" type="docEmptyType" />
- <xsd:element name="and" type="docEmptyType" />
- <xsd:element name="or" type="docEmptyType" />
- <xsd:element name="cap" type="docEmptyType" />
- <xsd:element name="cup" type="docEmptyType" />
- <xsd:element name="int" type="docEmptyType" />
- <xsd:element name="there4" type="docEmptyType" />
- <xsd:element name="sim" type="docEmptyType" />
- <xsd:element name="cong" type="docEmptyType" />
- <xsd:element name="asymp" type="docEmptyType" />
- <xsd:element name="ne" type="docEmptyType" />
- <xsd:element name="equiv" type="docEmptyType" />
- <xsd:element name="le" type="docEmptyType" />
- <xsd:element name="ge" type="docEmptyType" />
- <xsd:element name="sub" type="docEmptyType" />
- <xsd:element name="sup" type="docEmptyType" />
- <xsd:element name="nsub" type="docEmptyType" />
- <xsd:element name="sube" type="docEmptyType" />
- <xsd:element name="supe" type="docEmptyType" />
- <xsd:element name="oplus" type="docEmptyType" />
- <xsd:element name="otimes" type="docEmptyType" />
- <xsd:element name="perp" type="docEmptyType" />
- <xsd:element name="sdot" type="docEmptyType" />
- <xsd:element name="lceil" type="docEmptyType" />
- <xsd:element name="rceil" type="docEmptyType" />
- <xsd:element name="lfloor" type="docEmptyType" />
- <xsd:element name="rfloor" type="docEmptyType" />
- <xsd:element name="lang" type="docEmptyType" />
- <xsd:element name="rang" type="docEmptyType" />
- <xsd:element name="loz" type="docEmptyType" />
- <xsd:element name="spades" type="docEmptyType" />
- <xsd:element name="clubs" type="docEmptyType" />
- <xsd:element name="hearts" type="docEmptyType" />
- <xsd:element name="diams" type="docEmptyType" />
- <xsd:element name="OElig" type="docEmptyType" />
- <xsd:element name="oelig" type="docEmptyType" />
- <xsd:element name="Scaron" type="docEmptyType" />
- <xsd:element name="scaron" type="docEmptyType" />
- <xsd:element name="Yumlaut" type="docEmptyType" />
- <xsd:element name="circ" type="docEmptyType" />
- <xsd:element name="tilde" type="docEmptyType" />
- <xsd:element name="ensp" type="docEmptyType" />
- <xsd:element name="emsp" type="docEmptyType" />
- <xsd:element name="thinsp" type="docEmptyType" />
- <xsd:element name="zwnj" type="docEmptyType" />
- <xsd:element name="zwj" type="docEmptyType" />
- <xsd:element name="lrm" type="docEmptyType" />
- <xsd:element name="rlm" type="docEmptyType" />
- <xsd:element name="ndash" type="docEmptyType" />
- <xsd:element name="mdash" type="docEmptyType" />
- <xsd:element name="lsquo" type="docEmptyType" />
- <xsd:element name="rsquo" type="docEmptyType" />
- <xsd:element name="sbquo" type="docEmptyType" />
- <xsd:element name="ldquo" type="docEmptyType" />
- <xsd:element name="rdquo" type="docEmptyType" />
- <xsd:element name="bdquo" type="docEmptyType" />
- <xsd:element name="dagger" type="docEmptyType" />
- <xsd:element name="Dagger" type="docEmptyType" />
- <xsd:element name="permil" type="docEmptyType" />
- <xsd:element name="lsaquo" type="docEmptyType" />
- <xsd:element name="rsaquo" type="docEmptyType" />
- <xsd:element name="euro" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docTitleType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:group name="docCmdGroup">
- <xsd:choice>
- <xsd:group ref="docTitleCmdGroup"/>
- <xsd:element name="linebreak" type="docEmptyType" />
- <xsd:element name="hruler" type="docEmptyType" />
- <xsd:element name="preformatted" type="docMarkupType" />
- <xsd:element name="programlisting" type="listingType" />
- <xsd:element name="verbatim" type="xsd:string" />
- <xsd:element name="indexentry" type="docIndexEntryType" />
- <xsd:element name="orderedlist" type="docListType" />
- <xsd:element name="itemizedlist" type="docListType" />
- <xsd:element name="simplesect" type="docSimpleSectType" />
- <xsd:element name="title" type="docTitleType" />
- <xsd:element name="variablelist" type="docVariableListType" />
- <xsd:element name="table" type="docTableType" />
- <xsd:element name="heading" type="docHeadingType" />
- <xsd:element name="image" type="docImageType" />
- <xsd:element name="dotfile" type="docFileType" />
- <xsd:element name="mscfile" type="docFileType" />
- <xsd:element name="diafile" type="docFileType" />
- <xsd:element name="toclist" type="docTocListType" />
- <xsd:element name="language" type="docLanguageType" />
- <xsd:element name="parameterlist" type="docParamListType" />
- <xsd:element name="xrefsect" type="docXRefSectType" />
- <xsd:element name="copydoc" type="docCopyType" />
- <xsd:element name="blockquote" type="docBlockQuoteType" />
- <xsd:element name="parblock" type="docParBlockType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docParaType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docMarkupType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docURLLink" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="url" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docAnchorType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFormulaType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docIndexEntryType">
- <xsd:sequence>
- <xsd:element name="primaryie" type="xsd:string" />
- <xsd:element name="secondaryie" type="xsd:string" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListType">
- <xsd:sequence>
- <xsd:element name="listitem" type="docListItemType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListItemType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docSimpleSectType">
- <xsd:sequence>
- <xsd:element name="title" type="docTitleType" minOccurs="0" />
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="para" type="docParaType" minOccurs="1" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSimpleSectKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docVarListEntryType">
- <xsd:sequence>
- <xsd:element name="term" type="docTitleType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docVariableListGroup">
- <xsd:sequence>
- <xsd:element name="varlistentry" type="docVarListEntryType" />
- <xsd:element name="listitem" type="docListItemType" />
- </xsd:sequence>
- </xsd:group>
-
- <xsd:complexType name="docVariableListType">
- <xsd:sequence>
- <xsd:group ref="docVariableListGroup" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docRefTextType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTableType">
- <xsd:sequence>
- <xsd:element name="row" type="docRowType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="caption" type="docCaptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="rows" type="xsd:integer" />
- <xsd:attribute name="cols" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docRowType">
- <xsd:sequence>
- <xsd:element name="entry" type="docEntryType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEntryType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="thead" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="docCaptionType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docHeadingType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="level" type="xsd:integer" /> <!-- todo: range 1-6 -->
- </xsd:complexType>
-
- <xsd:complexType name="docImageType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="type" type="DoxImageKind" />
- <xsd:attribute name="name" type="xsd:string" />
- <xsd:attribute name="width" type="xsd:string" />
- <xsd:attribute name="height" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFileType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="name" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocItemType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocListType">
- <xsd:sequence>
- <xsd:element name="tocitem" type="docTocItemType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docLanguageType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="langid" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListType">
- <xsd:sequence>
- <xsd:element name="parameteritem" type="docParamListItem" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxParamListKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListItem">
- <xsd:sequence>
- <xsd:element name="parameternamelist" type="docParamNameList" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parameterdescription" type="descriptionType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamNameList">
- <xsd:sequence>
- <xsd:element name="parametertype" type="docParamType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parametername" type="docParamName" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamName" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- <xsd:attribute name="direction" type="DoxParamDir" use="optional" />
- </xsd:complexType>
-
- <xsd:complexType name="docXRefSectType">
- <xsd:sequence>
- <xsd:element name="xreftitle" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="xrefdescription" type="descriptionType" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docCopyType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="link" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docBlockQuoteType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParBlockType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEmptyType"/>
-
- <!-- Simple types -->
-
- <xsd:simpleType name="DoxBool">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="yes" />
- <xsd:enumeration value="no" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxGraphRelation">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="include" />
- <xsd:enumeration value="usage" />
- <xsd:enumeration value="template-instance" />
- <xsd:enumeration value="public-inheritance" />
- <xsd:enumeration value="protected-inheritance" />
- <xsd:enumeration value="private-inheritance" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxRefKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="compound" />
- <xsd:enumeration value="member" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxMemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="variable" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="function" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="dcop" />
- <xsd:enumeration value="slot" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="service" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxProtectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="public" />
- <xsd:enumeration value="protected" />
- <xsd:enumeration value="private" />
- <xsd:enumeration value="package" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVirtualKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="non-virtual" />
- <xsd:enumeration value="virtual" />
- <xsd:enumeration value="pure-virtual" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class" />
- <xsd:enumeration value="struct" />
- <xsd:enumeration value="union" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="protocol" />
- <xsd:enumeration value="category" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="service" />
- <xsd:enumeration value="singleton" />
- <xsd:enumeration value="module" />
- <xsd:enumeration value="type" />
- <xsd:enumeration value="file" />
- <xsd:enumeration value="namespace" />
- <xsd:enumeration value="group" />
- <xsd:enumeration value="page" />
- <xsd:enumeration value="example" />
- <xsd:enumeration value="dir" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="user-defined" />
- <xsd:enumeration value="public-type" />
- <xsd:enumeration value="public-func" />
- <xsd:enumeration value="public-attrib" />
- <xsd:enumeration value="public-slot" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="dcop-func" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="public-static-func" />
- <xsd:enumeration value="public-static-attrib" />
- <xsd:enumeration value="protected-type" />
- <xsd:enumeration value="protected-func" />
- <xsd:enumeration value="protected-attrib" />
- <xsd:enumeration value="protected-slot" />
- <xsd:enumeration value="protected-static-func" />
- <xsd:enumeration value="protected-static-attrib" />
- <xsd:enumeration value="package-type" />
- <xsd:enumeration value="package-func" />
- <xsd:enumeration value="package-attrib" />
- <xsd:enumeration value="package-static-func" />
- <xsd:enumeration value="package-static-attrib" />
- <xsd:enumeration value="private-type" />
- <xsd:enumeration value="private-func" />
- <xsd:enumeration value="private-attrib" />
- <xsd:enumeration value="private-slot" />
- <xsd:enumeration value="private-static-func" />
- <xsd:enumeration value="private-static-attrib" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="related" />
- <xsd:enumeration value="define" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="func" />
- <xsd:enumeration value="var" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxHighlightClass">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="comment" />
- <xsd:enumeration value="normal" />
- <xsd:enumeration value="preprocessor" />
- <xsd:enumeration value="keyword" />
- <xsd:enumeration value="keywordtype" />
- <xsd:enumeration value="keywordflow" />
- <xsd:enumeration value="stringliteral" />
- <xsd:enumeration value="charliteral" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSimpleSectKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="see" />
- <xsd:enumeration value="return" />
- <xsd:enumeration value="author" />
- <xsd:enumeration value="authors" />
- <xsd:enumeration value="version" />
- <xsd:enumeration value="since" />
- <xsd:enumeration value="date" />
- <xsd:enumeration value="note" />
- <xsd:enumeration value="warning" />
- <xsd:enumeration value="pre" />
- <xsd:enumeration value="post" />
- <xsd:enumeration value="copyright" />
- <xsd:enumeration value="invariant" />
- <xsd:enumeration value="remark" />
- <xsd:enumeration value="attention" />
- <xsd:enumeration value="par" />
- <xsd:enumeration value="rcs" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVersionNumber">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="\d+\.\d+.*" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxImageKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="html" />
- <xsd:enumeration value="latex" />
- <xsd:enumeration value="rtf" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamListKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="param" />
- <xsd:enumeration value="retval" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="templateparam" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCharRange">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="[aeiouncAEIOUNC]" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamDir">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="in"/>
- <xsd:enumeration value="out"/>
- <xsd:enumeration value="inout"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxAccessor">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="retain"/>
- <xsd:enumeration value="copy"/>
- <xsd:enumeration value="assign"/>
- <xsd:enumeration value="weak"/>
- <xsd:enumeration value="strong"/>
- <xsd:enumeration value="unretained"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="dir_68267d1309a1af8e8297ef4c3efbcdba" kind="dir">
- <compoundname>src</compoundname>
- <innerfile refid="foo_8py">foo.py</innerfile>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="foo_8py" kind="file">
- <compoundname>foo.py</compoundname>
- <innernamespace refid="namespacefoo">foo</innernamespace>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/foo.py"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygenindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="index.xsd" version="1.8.8">
- <compound refid="namespacefoo" kind="namespace"><name>foo</name>
- <member refid="namespacefoo_1aab1e88a2212b202c20f3c9bd799a1ad4" kind="function"><name>bar</name></member>
- </compound>
- <compound refid="foo_8py" kind="file"><name>foo.py</name>
- </compound>
- <compound refid="dir_68267d1309a1af8e8297ef4c3efbcdba" kind="dir"><name>src</name>
- </compound>
-</doxygenindex>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygenindex" type="DoxygenType"/>
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence>
- <xsd:element name="compound" type="CompoundType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="version" type="xsd:string" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="CompoundType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- <xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="CompoundKind" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="MemberType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="MemberKind" use="required"/>
- </xsd:complexType>
-
- <xsd:simpleType name="CompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class"/>
- <xsd:enumeration value="struct"/>
- <xsd:enumeration value="union"/>
- <xsd:enumeration value="interface"/>
- <xsd:enumeration value="protocol"/>
- <xsd:enumeration value="category"/>
- <xsd:enumeration value="exception"/>
- <xsd:enumeration value="file"/>
- <xsd:enumeration value="namespace"/>
- <xsd:enumeration value="group"/>
- <xsd:enumeration value="page"/>
- <xsd:enumeration value="example"/>
- <xsd:enumeration value="dir"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="MemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define"/>
- <xsd:enumeration value="property"/>
- <xsd:enumeration value="event"/>
- <xsd:enumeration value="variable"/>
- <xsd:enumeration value="typedef"/>
- <xsd:enumeration value="enum"/>
- <xsd:enumeration value="enumvalue"/>
- <xsd:enumeration value="function"/>
- <xsd:enumeration value="signal"/>
- <xsd:enumeration value="prototype"/>
- <xsd:enumeration value="friend"/>
- <xsd:enumeration value="dcop"/>
- <xsd:enumeration value="slot"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="namespacefoo" kind="namespace">
- <compoundname>foo</compoundname>
- <sectiondef kind="func">
- <memberdef kind="function" id="namespacefoo_1aab1e88a2212b202c20f3c9bd799a1ad4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
- <type>def</type>
- <definition>def foo.bar</definition>
- <argsstring></argsstring>
- <name>bar</name>
- <briefdescription>
-<para>A <computeroutput>bar</computeroutput> function in the <computeroutput>foo</computeroutput> namespace. </para> </briefdescription>
- <detaileddescription>
-<para><verbatim>By default, Doxygen recognizes anything in the docstrings as verbatim
-detailed description.</verbatim> </para> </detaileddescription>
- <inbodydescription>
- </inbodydescription>
- <location file="%SOURCE_DIRECTORY%/foo.py" line="16" column="1" bodyfile="%SOURCE_DIRECTORY%/foo.py" bodystart="16" bodyend="20"/>
- </memberdef>
- </sectiondef>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/foo.py" line="1" column="1"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-# Doxyfile 1.8.8
-
-# 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 = "Test Project"
-
-# 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 =
-
-# 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 =
-
-# With the PROJECT_LOGO tag one can specify a logo or an 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
-
-# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
-# characters to appear in the names of generated files. If set to NO, non-ASCII
-# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
-# U+3044.
-# The default value is: NO.
-
-ALLOW_UNICODE_NAMES = 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 = YES
-
-# 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
-
-# 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 = YES
-
-# 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 =
-
-# 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 (fixed format Fortran:
-# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
-# Fortran. In the later case the parser tries to guess whether the code is fixed
-# or free formatted code, this is the default for Fortran type files), 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 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. If 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 = NO
-
-# 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 = YES
-
-# 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 =
-
-# 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. 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 = src
-
-# 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 =
-
-# 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 =
-
-# 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 =
-
-# 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 = *
-
-# 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 =
-
-# 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 =
-
-#---------------------------------------------------------------------------
-# 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 = NO
-
-# 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 additional user-defined
-# cascading style sheets that are 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 therefore more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
-# Note: The order of the extra stylesheet files is of importance (e.g. the last
-# stylesheet in the list overrules the setting of the previous ones in the
-# list). 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. Furthermore it
-# enables the Previous and Next buttons.
-# 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
-
-# If 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 pre-rendered 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 flavors 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,
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# string, for the replacement values of the other commands the user is referred
-# to HTML_HEADER.
-# 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. See
-# LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the 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 USE_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
-
-# The MAN_SUBDIR tag determines the name of the directory created within
-# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
-# MAN_EXTENSION with the initial . removed.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_SUBDIR =
-
-# 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
-
-# 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 = NO
-
-#---------------------------------------------------------------------------
-# 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
-
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
-#---------------------------------------------------------------------------
-# 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 include 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 references 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 a 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 = YES
-
-# 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 = NO
-
-# 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 in 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 = YES
-
-# 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 = NO
-
-# 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 = NO
-
-# 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 =
-
-# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
-# path where java can find the plantuml.jar file. If left blank, it is assumed
-# PlantUML is not used or called during a preprocessing step. Doxygen will
-# generate a warning when it encounters a \startuml command in this case and
-# will not generate output for the diagram.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-PLANTUML_JAR_PATH =
-
-# 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 to 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
+++ /dev/null
-This directory contains a dummy Java project for testing purposes.
-
-To regenerate the XML output located in `xml`, run `make`. If the `Makefile`
-does not exists, you can regenerate it by running `make bootstrap` in the parent
-directory.
+++ /dev/null
-/* This file is part of NIT ( http://www.nitlanguage.org ).
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * A class in the root namespace
- */
-class Foo {}
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="_foo_8java" kind="file">
- <compoundname>Foo.java</compoundname>
- <innerclass refid="class_foo" prot="package">Foo</innerclass>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/Foo.java"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="class_foo" kind="class" prot="package">
- <compoundname>Foo</compoundname>
- <briefdescription>
-<para>A class in the root namespace. </para> </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/Foo.java" line="19" column="1" bodyfile="%SOURCE_DIRECTORY%/Foo.java" bodystart="19" bodyend="19"/>
- <listofallmembers>
- </listofallmembers>
- </compounddef>
-</doxygen>
+++ /dev/null
-<!-- XSLT script to combine the generated output into a single file.
- If you have xsltproc you could use:
- xsltproc combine.xslt index.xml >all.xml
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
- <xsl:output method="xml" version="1.0" indent="no" standalone="yes" />
- <xsl:template match="/">
- <doxygen version="{doxygenindex/@version}">
- <!-- Load all doxgen generated xml files -->
- <xsl:for-each select="doxygenindex/compound">
- <xsl:copy-of select="document( concat( @refid, '.xml' ) )/doxygen/*" />
- </xsl:for-each>
- </doxygen>
- </xsl:template>
-</xsl:stylesheet>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygen" type="DoxygenType"/>
-
- <!-- Complex types -->
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="compounddef" type="compounddefType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="version" type="DoxVersionNumber" use="required" />
- </xsd:complexType>
-
- <xsd:complexType name="compounddefType">
- <xsd:sequence>
- <xsd:element name="compoundname" type="xsd:string"/>
- <xsd:element name="title" type="xsd:string" minOccurs="0" />
- <xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="incdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
- <xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inheritancegraph" type="graphType" minOccurs="0" />
- <xsd:element name="collaborationgraph" type="graphType" minOccurs="0" />
- <xsd:element name="programlisting" type="listingType" minOccurs="0" />
- <xsd:element name="location" type="locationType" minOccurs="0" />
- <xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="kind" type="DoxCompoundKind" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="abstract" type="DoxBool" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listofallmembersType">
- <xsd:sequence>
- <xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="memberRefType">
- <xsd:sequence>
- <xsd:element name="scope" />
- <xsd:element name="name" />
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- <xsd:attribute name="ambiguityscope" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="compoundRefType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" use="optional" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="virt" type="DoxVirtualKind" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="reimplementType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="incType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="local" type="DoxBool" />
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="refTextType">
- <xsd:simpleContent>
- <xsd:extension base="xsd:string">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- <xsd:attribute name="tooltip" type="xsd:string" use="optional"/>
- </xsd:extension>
- </xsd:simpleContent>
- </xsd:complexType>
-
- <xsd:complexType name="sectiondefType">
- <xsd:sequence>
- <xsd:element name="header" type="xsd:string" minOccurs="0" />
- <xsd:element name="description" type="descriptionType" minOccurs="0" />
- <xsd:element name="memberdef" type="memberdefType" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="memberdefType">
- <xsd:sequence>
- <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="definition" minOccurs="0" />
- <xsd:element name="argsstring" minOccurs="0" />
- <xsd:element name="name" />
- <xsd:element name="read" minOccurs="0" />
- <xsd:element name="write" minOccurs="0" />
- <xsd:element name="bitfield" minOccurs="0" />
- <xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="exceptions" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="location" type="locationType" />
- <xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxMemberKind" />
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- <xsd:attribute name="static" type="DoxBool" />
- <xsd:attribute name="const" type="DoxBool" use="optional"/>
- <xsd:attribute name="explicit" type="DoxBool" use="optional"/>
- <xsd:attribute name="inline" type="DoxBool" use="optional"/>
- <xsd:attribute name="virt" type="DoxVirtualKind" use="optional"/>
- <xsd:attribute name="volatile" type="DoxBool" use="optional"/>
- <xsd:attribute name="mutable" type="DoxBool" use="optional"/>
- <!-- Qt property -->
- <xsd:attribute name="readable" type="DoxBool" use="optional"/>
- <xsd:attribute name="writable" type="DoxBool" use="optional"/>
- <!-- C++/CLI variable -->
- <xsd:attribute name="initonly" type="DoxBool" use="optional"/>
- <!-- C++/CLI and C# property -->
- <xsd:attribute name="settable" type="DoxBool" use="optional"/>
- <xsd:attribute name="gettable" type="DoxBool" use="optional"/>
- <!-- C++/CLI function -->
- <xsd:attribute name="final" type="DoxBool" use="optional"/>
- <xsd:attribute name="sealed" type="DoxBool" use="optional"/>
- <xsd:attribute name="new" type="DoxBool" use="optional"/>
- <!-- C++/CLI event -->
- <xsd:attribute name="add" type="DoxBool" use="optional"/>
- <xsd:attribute name="remove" type="DoxBool" use="optional"/>
- <xsd:attribute name="raise" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 protocol method -->
- <xsd:attribute name="optional" type="DoxBool" use="optional"/>
- <xsd:attribute name="required" type="DoxBool" use="optional"/>
- <!-- Objective-C 2.0 property accessor -->
- <xsd:attribute name="accessor" type="DoxAccessor" use="optional"/>
- <!-- UNO IDL -->
- <xsd:attribute name="attribute" type="DoxBool" use="optional"/>
- <xsd:attribute name="property" type="DoxBool" use="optional"/>
- <xsd:attribute name="readonly" type="DoxBool" use="optional"/>
- <xsd:attribute name="bound" type="DoxBool" use="optional"/>
- <xsd:attribute name="removable" type="DoxBool" use="optional"/>
- <xsd:attribute name="contrained" type="DoxBool" use="optional"/>
- <xsd:attribute name="transient" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybevoid" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybedefault" type="DoxBool" use="optional"/>
- <xsd:attribute name="maybeambiguous" type="DoxBool" use="optional"/>
-
- </xsd:complexType>
-
- <xsd:complexType name="descriptionType" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" minOccurs="0"/>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="enumvalueType" mixed="true">
- <xsd:sequence>
- <xsd:element name="name" />
- <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- <xsd:attribute name="prot" type="DoxProtectionKind" />
- </xsd:complexType>
-
- <xsd:complexType name="templateparamlistType">
- <xsd:sequence>
- <xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="paramType">
- <xsd:sequence>
- <xsd:element name="type" type="linkedTextType" minOccurs="0" />
- <xsd:element name="declname" minOccurs="0" />
- <xsd:element name="defname" minOccurs="0" />
- <xsd:element name="array" minOccurs="0" />
- <xsd:element name="defval" type="linkedTextType" minOccurs="0" />
- <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="linkedTextType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="graphType">
- <xsd:sequence>
- <xsd:element name="node" type="nodeType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="nodeType">
- <xsd:sequence>
- <xsd:element name="label" />
- <xsd:element name="link" type="linkType" minOccurs="0" />
- <xsd:element name="childnode" type="childnodeType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="childnodeType">
- <xsd:sequence>
- <xsd:element name="edgelabel" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="relation" type="DoxGraphRelation" />
- </xsd:complexType>
-
- <xsd:complexType name="linkType">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="external" type="xsd:string" use="optional"/>
- </xsd:complexType>
-
- <xsd:complexType name="listingType">
- <xsd:sequence>
- <xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="codelineType">
- <xsd:sequence>
- <xsd:element name="highlight" type="highlightType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="lineno" type="xsd:integer" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="refkind" type="DoxRefKind" />
- <xsd:attribute name="external" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="highlightType" mixed="true">
- <xsd:choice minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="sp" />
- <xsd:element name="ref" type="refTextType" />
- </xsd:choice>
- <xsd:attribute name="class" type="DoxHighlightClass" />
- </xsd:complexType>
-
- <xsd:complexType name="referenceType" mixed="true">
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="compoundref" type="xsd:string" use="optional" />
- <xsd:attribute name="startline" type="xsd:integer" />
- <xsd:attribute name="endline" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="locationType">
- <xsd:attribute name="file" type="xsd:string" />
- <xsd:attribute name="line" type="xsd:integer" />
- <xsd:attribute name="column" type="xsd:integer" use="optional"/>
- <xsd:attribute name="bodyfile" type="xsd:string" />
- <xsd:attribute name="bodystart" type="xsd:integer" />
- <xsd:attribute name="bodyend" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS1Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS2Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect4" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS3Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docSect4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="title" type="xsd:string" />
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalS4Type" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docInternalType" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS1Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS2Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS3Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect3" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docInternalS4Type" mixed="true">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docTitleCmdGroup">
- <xsd:choice>
- <xsd:element name="ulink" type="docURLLink" />
- <xsd:element name="bold" type="docMarkupType" />
- <xsd:element name="emphasis" type="docMarkupType" />
- <xsd:element name="computeroutput" type="docMarkupType" />
- <xsd:element name="subscript" type="docMarkupType" />
- <xsd:element name="superscript" type="docMarkupType" />
- <xsd:element name="center" type="docMarkupType" />
- <xsd:element name="small" type="docMarkupType" />
- <xsd:element name="htmlonly" type="xsd:string" />
- <xsd:element name="manonly" type="xsd:string" />
- <xsd:element name="xmlonly" type="xsd:string" />
- <xsd:element name="rtfonly" type="xsd:string" />
- <xsd:element name="latexonly" type="xsd:string" />
- <xsd:element name="dot" type="xsd:string" />
- <xsd:element name="plantuml" type="xsd:string" />
- <xsd:element name="anchor" type="docAnchorType" />
- <xsd:element name="formula" type="docFormulaType" />
- <xsd:element name="ref" type="docRefTextType" />
- <xsd:element name="nonbreakablespace" type="docEmptyType" />
- <xsd:element name="iexcl" type="docEmptyType" />
- <xsd:element name="cent" type="docEmptyType" />
- <xsd:element name="pound" type="docEmptyType" />
- <xsd:element name="curren" type="docEmptyType" />
- <xsd:element name="yen" type="docEmptyType" />
- <xsd:element name="brvbar" type="docEmptyType" />
- <xsd:element name="sect" type="docEmptyType" />
- <xsd:element name="umlaut" type="docEmptyType" />
- <xsd:element name="copy" type="docEmptyType" />
- <xsd:element name="ordf" type="docEmptyType" />
- <xsd:element name="laquo" type="docEmptyType" />
- <xsd:element name="not" type="docEmptyType" />
- <xsd:element name="shy" type="docEmptyType" />
- <xsd:element name="registered" type="docEmptyType" />
- <xsd:element name="macr" type="docEmptyType" />
- <xsd:element name="deg" type="docEmptyType" />
- <xsd:element name="plusmn" type="docEmptyType" />
- <xsd:element name="sup2" type="docEmptyType" />
- <xsd:element name="sup3" type="docEmptyType" />
- <xsd:element name="acute" type="docEmptyType" />
- <xsd:element name="micro" type="docEmptyType" />
- <xsd:element name="para" type="docEmptyType" />
- <xsd:element name="middot" type="docEmptyType" />
- <xsd:element name="cedil" type="docEmptyType" />
- <xsd:element name="sup1" type="docEmptyType" />
- <xsd:element name="ordm" type="docEmptyType" />
- <xsd:element name="raquo" type="docEmptyType" />
- <xsd:element name="frac14" type="docEmptyType" />
- <xsd:element name="frac12" type="docEmptyType" />
- <xsd:element name="frac34" type="docEmptyType" />
- <xsd:element name="iquest" type="docEmptyType" />
- <xsd:element name="Agrave" type="docEmptyType" />
- <xsd:element name="Aacute" type="docEmptyType" />
- <xsd:element name="Acirc" type="docEmptyType" />
- <xsd:element name="Atilde" type="docEmptyType" />
- <xsd:element name="Aumlaut" type="docEmptyType" />
- <xsd:element name="Aring" type="docEmptyType" />
- <xsd:element name="AElig" type="docEmptyType" />
- <xsd:element name="Ccedil" type="docEmptyType" />
- <xsd:element name="Egrave" type="docEmptyType" />
- <xsd:element name="Eacute" type="docEmptyType" />
- <xsd:element name="Ecirc" type="docEmptyType" />
- <xsd:element name="Eumlaut" type="docEmptyType" />
- <xsd:element name="Igrave" type="docEmptyType" />
- <xsd:element name="Iacute" type="docEmptyType" />
- <xsd:element name="Icirc" type="docEmptyType" />
- <xsd:element name="Iumlaut" type="docEmptyType" />
- <xsd:element name="ETH" type="docEmptyType" />
- <xsd:element name="Ntilde" type="docEmptyType" />
- <xsd:element name="Ograve" type="docEmptyType" />
- <xsd:element name="Oacute" type="docEmptyType" />
- <xsd:element name="Ocirc" type="docEmptyType" />
- <xsd:element name="Otilde" type="docEmptyType" />
- <xsd:element name="Oumlaut" type="docEmptyType" />
- <xsd:element name="times" type="docEmptyType" />
- <xsd:element name="Oslash" type="docEmptyType" />
- <xsd:element name="Ugrave" type="docEmptyType" />
- <xsd:element name="Uacute" type="docEmptyType" />
- <xsd:element name="Ucirc" type="docEmptyType" />
- <xsd:element name="Uumlaut" type="docEmptyType" />
- <xsd:element name="Yacute" type="docEmptyType" />
- <xsd:element name="THORN" type="docEmptyType" />
- <xsd:element name="szlig" type="docEmptyType" />
- <xsd:element name="agrave" type="docEmptyType" />
- <xsd:element name="aacute" type="docEmptyType" />
- <xsd:element name="acirc" type="docEmptyType" />
- <xsd:element name="atilde" type="docEmptyType" />
- <xsd:element name="aumlaut" type="docEmptyType" />
- <xsd:element name="aring" type="docEmptyType" />
- <xsd:element name="aelig" type="docEmptyType" />
- <xsd:element name="ccedil" type="docEmptyType" />
- <xsd:element name="egrave" type="docEmptyType" />
- <xsd:element name="eacute" type="docEmptyType" />
- <xsd:element name="ecirc" type="docEmptyType" />
- <xsd:element name="eumlaut" type="docEmptyType" />
- <xsd:element name="igrave" type="docEmptyType" />
- <xsd:element name="iacute" type="docEmptyType" />
- <xsd:element name="icirc" type="docEmptyType" />
- <xsd:element name="iumlaut" type="docEmptyType" />
- <xsd:element name="eth" type="docEmptyType" />
- <xsd:element name="ntilde" type="docEmptyType" />
- <xsd:element name="ograve" type="docEmptyType" />
- <xsd:element name="oacute" type="docEmptyType" />
- <xsd:element name="ocirc" type="docEmptyType" />
- <xsd:element name="otilde" type="docEmptyType" />
- <xsd:element name="oumlaut" type="docEmptyType" />
- <xsd:element name="divide" type="docEmptyType" />
- <xsd:element name="oslash" type="docEmptyType" />
- <xsd:element name="ugrave" type="docEmptyType" />
- <xsd:element name="uacute" type="docEmptyType" />
- <xsd:element name="ucirc" type="docEmptyType" />
- <xsd:element name="uumlaut" type="docEmptyType" />
- <xsd:element name="yacute" type="docEmptyType" />
- <xsd:element name="thorn" type="docEmptyType" />
- <xsd:element name="yumlaut" type="docEmptyType" />
- <xsd:element name="fnof" type="docEmptyType" />
- <xsd:element name="Alpha" type="docEmptyType" />
- <xsd:element name="Beta" type="docEmptyType" />
- <xsd:element name="Gamma" type="docEmptyType" />
- <xsd:element name="Delta" type="docEmptyType" />
- <xsd:element name="Epsilon" type="docEmptyType" />
- <xsd:element name="Zeta" type="docEmptyType" />
- <xsd:element name="Eta" type="docEmptyType" />
- <xsd:element name="Theta" type="docEmptyType" />
- <xsd:element name="Iota" type="docEmptyType" />
- <xsd:element name="Kappa" type="docEmptyType" />
- <xsd:element name="Lambda" type="docEmptyType" />
- <xsd:element name="Mu" type="docEmptyType" />
- <xsd:element name="Nu" type="docEmptyType" />
- <xsd:element name="Xi" type="docEmptyType" />
- <xsd:element name="Omicron" type="docEmptyType" />
- <xsd:element name="Pi" type="docEmptyType" />
- <xsd:element name="Rho" type="docEmptyType" />
- <xsd:element name="Sigma" type="docEmptyType" />
- <xsd:element name="Tau" type="docEmptyType" />
- <xsd:element name="Upsilon" type="docEmptyType" />
- <xsd:element name="Phi" type="docEmptyType" />
- <xsd:element name="Chi" type="docEmptyType" />
- <xsd:element name="Psi" type="docEmptyType" />
- <xsd:element name="Omega" type="docEmptyType" />
- <xsd:element name="alpha" type="docEmptyType" />
- <xsd:element name="beta" type="docEmptyType" />
- <xsd:element name="gamma" type="docEmptyType" />
- <xsd:element name="delta" type="docEmptyType" />
- <xsd:element name="epsilon" type="docEmptyType" />
- <xsd:element name="zeta" type="docEmptyType" />
- <xsd:element name="eta" type="docEmptyType" />
- <xsd:element name="theta" type="docEmptyType" />
- <xsd:element name="iota" type="docEmptyType" />
- <xsd:element name="kappa" type="docEmptyType" />
- <xsd:element name="lambda" type="docEmptyType" />
- <xsd:element name="mu" type="docEmptyType" />
- <xsd:element name="nu" type="docEmptyType" />
- <xsd:element name="xi" type="docEmptyType" />
- <xsd:element name="omicron" type="docEmptyType" />
- <xsd:element name="pi" type="docEmptyType" />
- <xsd:element name="rho" type="docEmptyType" />
- <xsd:element name="sigmaf" type="docEmptyType" />
- <xsd:element name="sigma" type="docEmptyType" />
- <xsd:element name="tau" type="docEmptyType" />
- <xsd:element name="upsilon" type="docEmptyType" />
- <xsd:element name="phi" type="docEmptyType" />
- <xsd:element name="chi" type="docEmptyType" />
- <xsd:element name="psi" type="docEmptyType" />
- <xsd:element name="omega" type="docEmptyType" />
- <xsd:element name="thetasym" type="docEmptyType" />
- <xsd:element name="upsih" type="docEmptyType" />
- <xsd:element name="piv" type="docEmptyType" />
- <xsd:element name="bull" type="docEmptyType" />
- <xsd:element name="hellip" type="docEmptyType" />
- <xsd:element name="prime" type="docEmptyType" />
- <xsd:element name="Prime" type="docEmptyType" />
- <xsd:element name="oline" type="docEmptyType" />
- <xsd:element name="frasl" type="docEmptyType" />
- <xsd:element name="weierp" type="docEmptyType" />
- <xsd:element name="image" type="docEmptyType" />
- <xsd:element name="real" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- <xsd:element name="alefsym" type="docEmptyType" />
- <xsd:element name="larr" type="docEmptyType" />
- <xsd:element name="uarr" type="docEmptyType" />
- <xsd:element name="rarr" type="docEmptyType" />
- <xsd:element name="darr" type="docEmptyType" />
- <xsd:element name="harr" type="docEmptyType" />
- <xsd:element name="crarr" type="docEmptyType" />
- <xsd:element name="lArr" type="docEmptyType" />
- <xsd:element name="uArr" type="docEmptyType" />
- <xsd:element name="rArr" type="docEmptyType" />
- <xsd:element name="dArr" type="docEmptyType" />
- <xsd:element name="hArr" type="docEmptyType" />
- <xsd:element name="forall" type="docEmptyType" />
- <xsd:element name="part" type="docEmptyType" />
- <xsd:element name="exist" type="docEmptyType" />
- <xsd:element name="empty" type="docEmptyType" />
- <xsd:element name="nabla" type="docEmptyType" />
- <xsd:element name="isin" type="docEmptyType" />
- <xsd:element name="notin" type="docEmptyType" />
- <xsd:element name="ni" type="docEmptyType" />
- <xsd:element name="prod" type="docEmptyType" />
- <xsd:element name="sum" type="docEmptyType" />
- <xsd:element name="minus" type="docEmptyType" />
- <xsd:element name="lowast" type="docEmptyType" />
- <xsd:element name="radic" type="docEmptyType" />
- <xsd:element name="prop" type="docEmptyType" />
- <xsd:element name="infin" type="docEmptyType" />
- <xsd:element name="ang" type="docEmptyType" />
- <xsd:element name="and" type="docEmptyType" />
- <xsd:element name="or" type="docEmptyType" />
- <xsd:element name="cap" type="docEmptyType" />
- <xsd:element name="cup" type="docEmptyType" />
- <xsd:element name="int" type="docEmptyType" />
- <xsd:element name="there4" type="docEmptyType" />
- <xsd:element name="sim" type="docEmptyType" />
- <xsd:element name="cong" type="docEmptyType" />
- <xsd:element name="asymp" type="docEmptyType" />
- <xsd:element name="ne" type="docEmptyType" />
- <xsd:element name="equiv" type="docEmptyType" />
- <xsd:element name="le" type="docEmptyType" />
- <xsd:element name="ge" type="docEmptyType" />
- <xsd:element name="sub" type="docEmptyType" />
- <xsd:element name="sup" type="docEmptyType" />
- <xsd:element name="nsub" type="docEmptyType" />
- <xsd:element name="sube" type="docEmptyType" />
- <xsd:element name="supe" type="docEmptyType" />
- <xsd:element name="oplus" type="docEmptyType" />
- <xsd:element name="otimes" type="docEmptyType" />
- <xsd:element name="perp" type="docEmptyType" />
- <xsd:element name="sdot" type="docEmptyType" />
- <xsd:element name="lceil" type="docEmptyType" />
- <xsd:element name="rceil" type="docEmptyType" />
- <xsd:element name="lfloor" type="docEmptyType" />
- <xsd:element name="rfloor" type="docEmptyType" />
- <xsd:element name="lang" type="docEmptyType" />
- <xsd:element name="rang" type="docEmptyType" />
- <xsd:element name="loz" type="docEmptyType" />
- <xsd:element name="spades" type="docEmptyType" />
- <xsd:element name="clubs" type="docEmptyType" />
- <xsd:element name="hearts" type="docEmptyType" />
- <xsd:element name="diams" type="docEmptyType" />
- <xsd:element name="OElig" type="docEmptyType" />
- <xsd:element name="oelig" type="docEmptyType" />
- <xsd:element name="Scaron" type="docEmptyType" />
- <xsd:element name="scaron" type="docEmptyType" />
- <xsd:element name="Yumlaut" type="docEmptyType" />
- <xsd:element name="circ" type="docEmptyType" />
- <xsd:element name="tilde" type="docEmptyType" />
- <xsd:element name="ensp" type="docEmptyType" />
- <xsd:element name="emsp" type="docEmptyType" />
- <xsd:element name="thinsp" type="docEmptyType" />
- <xsd:element name="zwnj" type="docEmptyType" />
- <xsd:element name="zwj" type="docEmptyType" />
- <xsd:element name="lrm" type="docEmptyType" />
- <xsd:element name="rlm" type="docEmptyType" />
- <xsd:element name="ndash" type="docEmptyType" />
- <xsd:element name="mdash" type="docEmptyType" />
- <xsd:element name="lsquo" type="docEmptyType" />
- <xsd:element name="rsquo" type="docEmptyType" />
- <xsd:element name="sbquo" type="docEmptyType" />
- <xsd:element name="ldquo" type="docEmptyType" />
- <xsd:element name="rdquo" type="docEmptyType" />
- <xsd:element name="bdquo" type="docEmptyType" />
- <xsd:element name="dagger" type="docEmptyType" />
- <xsd:element name="Dagger" type="docEmptyType" />
- <xsd:element name="permil" type="docEmptyType" />
- <xsd:element name="lsaquo" type="docEmptyType" />
- <xsd:element name="rsaquo" type="docEmptyType" />
- <xsd:element name="euro" type="docEmptyType" />
- <xsd:element name="trademark" type="docEmptyType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docTitleType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:group name="docCmdGroup">
- <xsd:choice>
- <xsd:group ref="docTitleCmdGroup"/>
- <xsd:element name="linebreak" type="docEmptyType" />
- <xsd:element name="hruler" type="docEmptyType" />
- <xsd:element name="preformatted" type="docMarkupType" />
- <xsd:element name="programlisting" type="listingType" />
- <xsd:element name="verbatim" type="xsd:string" />
- <xsd:element name="indexentry" type="docIndexEntryType" />
- <xsd:element name="orderedlist" type="docListType" />
- <xsd:element name="itemizedlist" type="docListType" />
- <xsd:element name="simplesect" type="docSimpleSectType" />
- <xsd:element name="title" type="docTitleType" />
- <xsd:element name="variablelist" type="docVariableListType" />
- <xsd:element name="table" type="docTableType" />
- <xsd:element name="heading" type="docHeadingType" />
- <xsd:element name="image" type="docImageType" />
- <xsd:element name="dotfile" type="docFileType" />
- <xsd:element name="mscfile" type="docFileType" />
- <xsd:element name="diafile" type="docFileType" />
- <xsd:element name="toclist" type="docTocListType" />
- <xsd:element name="language" type="docLanguageType" />
- <xsd:element name="parameterlist" type="docParamListType" />
- <xsd:element name="xrefsect" type="docXRefSectType" />
- <xsd:element name="copydoc" type="docCopyType" />
- <xsd:element name="blockquote" type="docBlockQuoteType" />
- <xsd:element name="parblock" type="docParBlockType" />
- </xsd:choice>
- </xsd:group>
-
- <xsd:complexType name="docParaType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docMarkupType" mixed="true">
- <xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docURLLink" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="url" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docAnchorType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFormulaType" mixed="true">
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docIndexEntryType">
- <xsd:sequence>
- <xsd:element name="primaryie" type="xsd:string" />
- <xsd:element name="secondaryie" type="xsd:string" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListType">
- <xsd:sequence>
- <xsd:element name="listitem" type="docListItemType" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docListItemType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docSimpleSectType">
- <xsd:sequence>
- <xsd:element name="title" type="docTitleType" minOccurs="0" />
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element name="para" type="docParaType" minOccurs="1" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxSimpleSectKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docVarListEntryType">
- <xsd:sequence>
- <xsd:element name="term" type="docTitleType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:group name="docVariableListGroup">
- <xsd:sequence>
- <xsd:element name="varlistentry" type="docVarListEntryType" />
- <xsd:element name="listitem" type="docListItemType" />
- </xsd:sequence>
- </xsd:group>
-
- <xsd:complexType name="docVariableListType">
- <xsd:sequence>
- <xsd:group ref="docVariableListGroup" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docRefTextType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="refid" type="xsd:string" />
- <xsd:attribute name="kindref" type="DoxRefKind" />
- <xsd:attribute name="external" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTableType">
- <xsd:sequence>
- <xsd:element name="row" type="docRowType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="caption" type="docCaptionType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="rows" type="xsd:integer" />
- <xsd:attribute name="cols" type="xsd:integer" />
- </xsd:complexType>
-
- <xsd:complexType name="docRowType">
- <xsd:sequence>
- <xsd:element name="entry" type="docEntryType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEntryType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="thead" type="DoxBool" />
- </xsd:complexType>
-
- <xsd:complexType name="docCaptionType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- </xsd:complexType>
-
- <xsd:complexType name="docHeadingType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="level" type="xsd:integer" /> <!-- todo: range 1-6 -->
- </xsd:complexType>
-
- <xsd:complexType name="docImageType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="type" type="DoxImageKind" />
- <xsd:attribute name="name" type="xsd:string" />
- <xsd:attribute name="width" type="xsd:string" />
- <xsd:attribute name="height" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docFileType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="name" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocItemType" mixed="true">
- <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docTocListType">
- <xsd:sequence>
- <xsd:element name="tocitem" type="docTocItemType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docLanguageType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="langid" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListType">
- <xsd:sequence>
- <xsd:element name="parameteritem" type="docParamListItem" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- <xsd:attribute name="kind" type="DoxParamListKind" />
- </xsd:complexType>
-
- <xsd:complexType name="docParamListItem">
- <xsd:sequence>
- <xsd:element name="parameternamelist" type="docParamNameList" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parameterdescription" type="descriptionType" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamNameList">
- <xsd:sequence>
- <xsd:element name="parametertype" type="docParamType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="parametername" type="docParamName" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamType" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParamName" mixed="true">
- <xsd:sequence>
- <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
- </xsd:sequence>
- <xsd:attribute name="direction" type="DoxParamDir" use="optional" />
- </xsd:complexType>
-
- <xsd:complexType name="docXRefSectType">
- <xsd:sequence>
- <xsd:element name="xreftitle" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="xrefdescription" type="descriptionType" />
- </xsd:sequence>
- <xsd:attribute name="id" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docCopyType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
- <xsd:element name="internal" type="docInternalType" minOccurs="0" />
- </xsd:sequence>
- <xsd:attribute name="link" type="xsd:string" />
- </xsd:complexType>
-
- <xsd:complexType name="docBlockQuoteType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docParBlockType">
- <xsd:sequence>
- <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
- </xsd:sequence>
- </xsd:complexType>
-
- <xsd:complexType name="docEmptyType"/>
-
- <!-- Simple types -->
-
- <xsd:simpleType name="DoxBool">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="yes" />
- <xsd:enumeration value="no" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxGraphRelation">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="include" />
- <xsd:enumeration value="usage" />
- <xsd:enumeration value="template-instance" />
- <xsd:enumeration value="public-inheritance" />
- <xsd:enumeration value="protected-inheritance" />
- <xsd:enumeration value="private-inheritance" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxRefKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="compound" />
- <xsd:enumeration value="member" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxMemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="variable" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="function" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="dcop" />
- <xsd:enumeration value="slot" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="service" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxProtectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="public" />
- <xsd:enumeration value="protected" />
- <xsd:enumeration value="private" />
- <xsd:enumeration value="package" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVirtualKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="non-virtual" />
- <xsd:enumeration value="virtual" />
- <xsd:enumeration value="pure-virtual" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class" />
- <xsd:enumeration value="struct" />
- <xsd:enumeration value="union" />
- <xsd:enumeration value="interface" />
- <xsd:enumeration value="protocol" />
- <xsd:enumeration value="category" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="service" />
- <xsd:enumeration value="singleton" />
- <xsd:enumeration value="module" />
- <xsd:enumeration value="type" />
- <xsd:enumeration value="file" />
- <xsd:enumeration value="namespace" />
- <xsd:enumeration value="group" />
- <xsd:enumeration value="page" />
- <xsd:enumeration value="example" />
- <xsd:enumeration value="dir" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSectionKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="user-defined" />
- <xsd:enumeration value="public-type" />
- <xsd:enumeration value="public-func" />
- <xsd:enumeration value="public-attrib" />
- <xsd:enumeration value="public-slot" />
- <xsd:enumeration value="signal" />
- <xsd:enumeration value="dcop-func" />
- <xsd:enumeration value="property" />
- <xsd:enumeration value="event" />
- <xsd:enumeration value="public-static-func" />
- <xsd:enumeration value="public-static-attrib" />
- <xsd:enumeration value="protected-type" />
- <xsd:enumeration value="protected-func" />
- <xsd:enumeration value="protected-attrib" />
- <xsd:enumeration value="protected-slot" />
- <xsd:enumeration value="protected-static-func" />
- <xsd:enumeration value="protected-static-attrib" />
- <xsd:enumeration value="package-type" />
- <xsd:enumeration value="package-func" />
- <xsd:enumeration value="package-attrib" />
- <xsd:enumeration value="package-static-func" />
- <xsd:enumeration value="package-static-attrib" />
- <xsd:enumeration value="private-type" />
- <xsd:enumeration value="private-func" />
- <xsd:enumeration value="private-attrib" />
- <xsd:enumeration value="private-slot" />
- <xsd:enumeration value="private-static-func" />
- <xsd:enumeration value="private-static-attrib" />
- <xsd:enumeration value="friend" />
- <xsd:enumeration value="related" />
- <xsd:enumeration value="define" />
- <xsd:enumeration value="prototype" />
- <xsd:enumeration value="typedef" />
- <xsd:enumeration value="enum" />
- <xsd:enumeration value="func" />
- <xsd:enumeration value="var" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxHighlightClass">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="comment" />
- <xsd:enumeration value="normal" />
- <xsd:enumeration value="preprocessor" />
- <xsd:enumeration value="keyword" />
- <xsd:enumeration value="keywordtype" />
- <xsd:enumeration value="keywordflow" />
- <xsd:enumeration value="stringliteral" />
- <xsd:enumeration value="charliteral" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxSimpleSectKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="see" />
- <xsd:enumeration value="return" />
- <xsd:enumeration value="author" />
- <xsd:enumeration value="authors" />
- <xsd:enumeration value="version" />
- <xsd:enumeration value="since" />
- <xsd:enumeration value="date" />
- <xsd:enumeration value="note" />
- <xsd:enumeration value="warning" />
- <xsd:enumeration value="pre" />
- <xsd:enumeration value="post" />
- <xsd:enumeration value="copyright" />
- <xsd:enumeration value="invariant" />
- <xsd:enumeration value="remark" />
- <xsd:enumeration value="attention" />
- <xsd:enumeration value="par" />
- <xsd:enumeration value="rcs" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxVersionNumber">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="\d+\.\d+.*" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxImageKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="html" />
- <xsd:enumeration value="latex" />
- <xsd:enumeration value="rtf" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamListKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="param" />
- <xsd:enumeration value="retval" />
- <xsd:enumeration value="exception" />
- <xsd:enumeration value="templateparam" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxCharRange">
- <xsd:restriction base="xsd:string">
- <xsd:pattern value="[aeiouncAEIOUNC]" />
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxParamDir">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="in"/>
- <xsd:enumeration value="out"/>
- <xsd:enumeration value="inout"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="DoxAccessor">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="retain"/>
- <xsd:enumeration value="copy"/>
- <xsd:enumeration value="assign"/>
- <xsd:enumeration value="weak"/>
- <xsd:enumeration value="strong"/>
- <xsd:enumeration value="unretained"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.8">
- <compounddef id="dir_68267d1309a1af8e8297ef4c3efbcdba" kind="dir">
- <compoundname>src</compoundname>
- <innerfile refid="_foo_8java">Foo.java</innerfile>
- <briefdescription>
- </briefdescription>
- <detaileddescription>
- </detaileddescription>
- <location file="%SOURCE_DIRECTORY%/"/>
- </compounddef>
-</doxygen>
+++ /dev/null
-<?xml version='1.0' encoding='UTF-8' standalone='no'?>
-<doxygenindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="index.xsd" version="1.8.8">
- <compound refid="class_foo" kind="class"><name>Foo</name>
- </compound>
- <compound refid="_foo_8java" kind="file"><name>Foo.java</name>
- </compound>
- <compound refid="dir_68267d1309a1af8e8297ef4c3efbcdba" kind="dir"><name>src</name>
- </compound>
-</doxygenindex>
+++ /dev/null
-<?xml version='1.0' encoding='utf-8' ?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <xsd:element name="doxygenindex" type="DoxygenType"/>
-
- <xsd:complexType name="DoxygenType">
- <xsd:sequence>
- <xsd:element name="compound" type="CompoundType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="version" type="xsd:string" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="CompoundType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- <xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="CompoundKind" use="required"/>
- </xsd:complexType>
-
- <xsd:complexType name="MemberType">
- <xsd:sequence>
- <xsd:element name="name" type="xsd:string"/>
- </xsd:sequence>
- <xsd:attribute name="refid" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="MemberKind" use="required"/>
- </xsd:complexType>
-
- <xsd:simpleType name="CompoundKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="class"/>
- <xsd:enumeration value="struct"/>
- <xsd:enumeration value="union"/>
- <xsd:enumeration value="interface"/>
- <xsd:enumeration value="protocol"/>
- <xsd:enumeration value="category"/>
- <xsd:enumeration value="exception"/>
- <xsd:enumeration value="file"/>
- <xsd:enumeration value="namespace"/>
- <xsd:enumeration value="group"/>
- <xsd:enumeration value="page"/>
- <xsd:enumeration value="example"/>
- <xsd:enumeration value="dir"/>
- </xsd:restriction>
- </xsd:simpleType>
-
- <xsd:simpleType name="MemberKind">
- <xsd:restriction base="xsd:string">
- <xsd:enumeration value="define"/>
- <xsd:enumeration value="property"/>
- <xsd:enumeration value="event"/>
- <xsd:enumeration value="variable"/>
- <xsd:enumeration value="typedef"/>
- <xsd:enumeration value="enum"/>
- <xsd:enumeration value="enumvalue"/>
- <xsd:enumeration value="function"/>
- <xsd:enumeration value="signal"/>
- <xsd:enumeration value="prototype"/>
- <xsd:enumeration value="friend"/>
- <xsd:enumeration value="dcop"/>
- <xsd:enumeration value="slot"/>
- </xsd:restriction>
- </xsd:simpleType>
-
-</xsd:schema>
-
+++ /dev/null
-bin/
-tests/out/
-stats.json
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-NITC ?= nitc
-NITLS ?= nitls
-NITUNIT ?= nitunit
-NITDOC ?= nitdoc
-
-.PHONY: all
-all: bin/refund
-
-bin/refund: $(shell $(NITLS) -M src/refund.nit)
- mkdir -p bin/
- $(NITC) src/refund.nit -o bin/refund
-
-.PHONY: check
-check: bin/refund
- $(NITUNIT) .
- cd tests; make
-
-.PHONY: doc
-doc:
- $(NITDOC) . -o doc/
-
-.PHONY: clean
-clean:
- rm -rf bin/
- rm -rf doc/
- cd tests; make clean
+++ /dev/null
-[package]
-name=refund
-tags=example,cli
-maintainer=Alexandre Terrasa <alexandre@moz-code.org>
-license=Apache-2.0
-desc=Insurance refunds calculation tool
-[upstream]
-browse=https://github.com/nitlang/nit/tree/master/contrib/refund/
-git=https://github.com/nitlang/nit.git
-git.directory=contrib/refund/
-homepage=http://nitlanguage.org
-issues=https://github.com/nitlang/nit/issues
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Copyright 2015 Alexandre Terrasa <alexandre@moz-code.org>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Insurance refunds calculation tool.
-#
-# `refund` computes automatically the allowed refund for a reclamation according
-# to an insurrance policy.
-#
-# Usage:
-#
-# ~~~sh
-# > refund (<input_file> <output_file> | [OPTIONS])
-# ~~~
-#
-# Input file:
-#
-# `refund` expects a JSON input file on the form:
-#
-# ~~~json
-# {
-# "dossier": "A100323",
-# "mois": "2015-01",
-# "reclamations": [
-# {
-# "soin": 100,
-# "date": "2015-01-11",
-# "montant": "234.00$"
-# }, {
-# "soin": 200,
-# "date": "2015-01-13",
-# "montant": "128.00$"
-# }, {
-# "soin": 334,
-# "date": "2015-01-23",
-# "montant": "50.00$"
-# }
-# ]
-# }
-# ~~~
-#
-# Output file:
-#
-# You have to specify the path where `refund` should output the result file.
-#
-# Results are formatted as JSON:
-#
-# ~~~json
-# {
-# "client": "100323",
-# "mois": "2015-01",
-# "remboursements": [
-# {
-# "soin": 100,
-# "date": "2015-01-11",
-# "montant": "58.50$"
-# }, {
-# "soin": 200,
-# "date": "2015-01-13",
-# "montant": "22.50$"
-# }, {
-# "soin": 334,
-# "date": "2015-01-23",
-# "montant": "0.00$"
-# }
-# ]
-# }
-# ~~~
-#
-# Options:
-#
-# `refund` can generate statistics about reclamations and refunds computed.
-#
-# * `-S`: display statistics
-# * `-SR`: reset statistics
-#
-# Error handling:
-#
-# In case of error, a JSON object is generated in place of the output file:
-#
-# ~~~json
-# { "message": "Invalid input data" }
-# ~~~
-module refund
-
-
-import refund_json
-
-# Display usage in console then leave.
-fun usage do
- print ""
- print "Usage:"
- print "refund <input.json> <output.json>"
- print ""
- print "options"
- print " -S\tShow stats in console"
- print " -RS\tClear stats"
- exit 1
-end
-
-var proc = new RefundProcessor
-
-if args.length == 1 then
- var flag = args.first
- if flag == "-RS" then
- proc.clear_stats
- exit 0
- else if flag == "-S" then
- proc.show_stats
- exit 0
- else
- print "Error: Unknown flag {flag}."
- usage
- end
-else if args.length != 2 then
- print "Error: Incorrect number of arguments. Got {args.length}, expected 2."
- usage
-end
-
-proc.process(args[0], args[1])
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Copyright 2015 Alexandre Terrasa <alexandre@moz-code.org>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Insurance refunds calculation base classes.
-module refund_base
-
-import counter
-
-# `RefundProcessor` manages the calculation of the refunds.
-#
-# See `process`.
-class RefundProcessor
-
- # Where to generate output file.
- var output_file: String is noinit, writable
-
- # Where to save usage statistics.
- var stats_file = "stats.json"
-
- # Processes the `input_file` and write the output in `output_file`.
- #
- # Steps:
- #
- # 1. Parses the input_file and check json validity (see `load_input`).
- # 2. Instantiates and checks the reclamation sheet against client rules
- # (see `ReclamationSheet.from_json`).
- # 3. Processes refunds (see `proces_refunds`).
- # 4. Writes the output file (see `write_output`).
- fun process(input_file, output_file: String) is abstract
-
- # Refunds allowed for the current reclamation sheet.
- var current_refunds = new HashMap[Care, Dollar]
-
- # Computes allowed refunds for a given `Reclamation` found in a `ReclamationSheet`.
- fun process_refund(sheet: ReclamationSheet, recl: Reclamation): Dollar is abstract
-
- # Shows stats values in console
- fun show_stats do print load_stats
-
- # Loads stats from file as a RefundStats instance.
- fun load_stats: RefundStats is abstract
-
- # Saves stats in file.
- fun save_stats(stats: RefundStats) is abstract
-
- # Outputs error object then exit.
- fun die(msg: String) is abstract
-
- # Clears stats.
- #
- # Basically delete the stats file.
- fun clear_stats do if stats_file.file_exists then stats_file.file_delete
-end
-
-# Stats representation using a `Counter`.
-class RefundStats
- super Counter[String]
-end
-
-# A `Client` can ask for refunds from the insurance company.
-class Client
-
- # Client number.
- var number: String
-
- redef fun to_s do return "#{number}"
-end
-
-# A `ReclamationSheet` is filled by the `Client` to obtain a `RefundSheet`.
-class ReclamationSheet
-
- # File used for this refund.
- var file: ReclFile is writable
-
- # Month concerned by the refund.
- var month: ReclMonth is writable
-
- # Array of reclamations.
- var recls = new Array[Reclamation] is writable
-
- redef fun to_s do
- return "Refund (file: {file}, month: {month}, recls: {recls.length})"
- end
-end
-
-# A File found in a `ReclamationSheet`.
-#
-# A File points to a `Contract` and a `Client`.
-#
-# Allowed format is: `X12345` where `X` is the contract kind and `12345` is the
-# client number.
-class ReclFile
-
- # File string id.
- var id: String is writable
-
- # Contract instance linked to this file.
- var contract: Contract is noinit, writable
-
- # Client instance linked to this file.
- var client: Client is noinit, writable
-
- # Returns the contract instance corresponding to `kind`.
- fun contract_factory(proc: RefundProcessor, kind: String): Contract do
- if kind == "A" then return new ContractA
- if kind == "B" then return new ContractB
- if kind == "C" then return new ContractC
- if kind == "D" then return new ContractD
- if kind == "E" then return new ContractE
- proc.die("Unknown contract {kind}")
- abort
- end
-
- redef fun to_s do return "{contract.kind}{client.number}"
-end
-
-# Month date formatted for contracts.
-#
-# Mainly used to factorize treatments on date calculation.
-class ReclMonth
-
- # Internal date used to store the month.
- var date: ReclDate is writable
-
- # Is `date` in this month?
- fun has(date: ReclDate): Bool do return self.date.month == date.month
-
- redef fun to_s do
- if date.month < 10 then
- return "{date.year}-0{date.month}"
- end
- return "{date.year}-0{date.month}"
- end
-end
-
-# The date on which a `Care` occured.
-class ReclDate
- # Year of the month.
- var year: Int is writable
-
- # Month number (`1` is January).
- var month: Int is writable
-
- # Day number.
- var day: Int is writable
-
- redef fun to_s do
- var res = new FlatBuffer
- res.append "{year}-"
- if month < 10 then
- res.append "0{month}-"
- else
- res.append "{month}-"
- end
- if day < 10 then
- res.append "0{day}"
- else
- res.append day.to_s
- end
- return res.write_to_string
- end
-end
-
-# `RefundRecl` are parts of the `RefundReclamation`.
-class Reclamation
- # `Care` id concerned by this reclamation.
- var care_id: Int is writable
-
- # Date this care was applied.
- var date: ReclDate is writable
-
- # Amount of money given by the `Client` in exchange of this care.
- var fees: Dollar is writable
-
- redef fun to_s do return "Entry (care: {care_id}, date: {date}, fees: {fees})"
-end
-
-# A `Contract` specifies the refund applicable on care.
-class Contract
-
- # Kind of the contract (specified by a letter).
- var kind: String is noinit, writable
-
- # Covered cares for this kind of contract.
- var cares = new Array[Care] is writable
-
- # Adds a care to this contract.
- fun add_care(care: Care) do cares.add care
-
- # Gets a `Care` instance by its id.
- #
- # Returns `null` if no `Care` found.
- fun care_by_id(id: Int): nullable Care do
- for care in cares do
- if care.match_id(id) then return care
- end
- return null
- end
-
- redef fun to_s do return "{kind} ({cares.length} cares)"
-end
-
-# Contracts
-# FIXME move contracts to a JSON configuration file.
-
-private class ContractA
- super Contract
-
- init do
- kind = "A"
- add_care(new UniqCare.with_vals(0, 25.0, null, null))
- add_care(new UniqCare.with_vals(100, 35.0, null, 250.0.to_dollar))
- add_care(new UniqCare.with_vals(150, 0.0, null, null))
- add_care(new UniqCare.with_vals(175, 50.0, null, 200.0.to_dollar))
- add_care(new UniqCare.with_vals(200, 25.0, null, 250.0.to_dollar))
- add_care(new RangeCare.with_vals([300..399], 0.0, null, null))
- add_care(new UniqCare.with_vals(400, 0.0, null, null))
- add_care(new UniqCare.with_vals(500, 25.0, null, 150.0.to_dollar))
- add_care(new UniqCare.with_vals(600, 40.0, null, 300.0.to_dollar))
- add_care(new UniqCare.with_vals(700, 0.0, null, null))
- end
-end
-
-private class ContractB
- super Contract
-
- init do
- kind = "B"
- add_care(new UniqCare.with_vals(0, 50.0, 40.0.to_dollar, null))
- add_care(new UniqCare.with_vals(100, 50.0, 50.0.to_dollar, 250.0.to_dollar))
- add_care(new UniqCare.with_vals(150, 0.0, null, null))
- add_care(new UniqCare.with_vals(175, 75.0, null, 200.0.to_dollar))
- add_care(new UniqCare.with_vals(200, 100.0,null, 250.0.to_dollar))
- add_care(new RangeCare.with_vals([300..399], 50.0, null, null))
- add_care(new UniqCare.with_vals(400, 0.0, null, null))
- add_care(new UniqCare.with_vals(500, 50.0, 50.0.to_dollar, 150.0.to_dollar))
- add_care(new UniqCare.with_vals(600, 100.0,null, 300.0.to_dollar))
- add_care(new UniqCare.with_vals(700, 70.0, null, null))
- end
-end
-
-private class ContractC
- super Contract
-
- init do
- kind = "C"
- add_care(new UniqCare.with_vals(0, 90.0, null, null))
- add_care(new UniqCare.with_vals(100, 95.0, null, 250.0.to_dollar))
- add_care(new UniqCare.with_vals(150, 85.0, null, null))
- add_care(new UniqCare.with_vals(175, 90.0, null, 200.0.to_dollar))
- add_care(new UniqCare.with_vals(200, 90.0, null, 250.0.to_dollar))
- add_care(new RangeCare.with_vals([300..399], 90.0, null, null))
- add_care(new UniqCare.with_vals(400, 90.0, null, null))
- add_care(new UniqCare.with_vals(500, 90.0, null, 150.0.to_dollar))
- add_care(new UniqCare.with_vals(600, 75.0, null, 300.0.to_dollar))
- add_care(new UniqCare.with_vals(700, 90.0, null, null))
- end
-end
-
-private class ContractD
- super Contract
-
- init do
- kind = "D"
- add_care(new UniqCare.with_vals(0, 100.0, 85.0.to_dollar, null))
- add_care(new UniqCare.with_vals(100, 100.0, 75.0.to_dollar, 250.0.to_dollar))
- add_care(new UniqCare.with_vals(150, 100.0, 150.0.to_dollar, null))
- add_care(new UniqCare.with_vals(175, 95.0, null, 200.0.to_dollar))
- add_care(new UniqCare.with_vals(200, 100.0, 100.0.to_dollar, 250.0.to_dollar))
- add_care(new RangeCare.with_vals([300..399],100.0, null, null))
- add_care(new UniqCare.with_vals(400, 100.0, 65.0.to_dollar, null))
- add_care(new UniqCare.with_vals(500, 100.0, null, 150.0.to_dollar))
- add_care(new UniqCare.with_vals(600, 100.0, 100.0.to_dollar, 300.0.to_dollar))
- add_care(new UniqCare.with_vals(700, 100.0, 90.0.to_dollar, null))
- end
-end
-
-private class ContractE
- super Contract
-
- init do
- kind = "E"
- add_care(new UniqCare.with_vals(0, 15.0, null, null))
- add_care(new UniqCare.with_vals(100, 25.0, null, 250.0.to_dollar))
- add_care(new UniqCare.with_vals(150, 15.0, null, null))
- add_care(new UniqCare.with_vals(175, 25.0, 20.0.to_dollar, 200.0.to_dollar))
- add_care(new UniqCare.with_vals(200, 12.0, null, 250.0.to_dollar))
- add_care(new RangeCare.with_vals([300..399], 60.0, null, null))
- add_care(new UniqCare.with_vals(400, 25.0, 15.0.to_dollar, null))
- add_care(new UniqCare.with_vals(500, 30.0, 20.0.to_dollar, 150.0.to_dollar))
- add_care(new UniqCare.with_vals(600, 15.0, null, 300.0.to_dollar))
- add_care(new UniqCare.with_vals(700, 22.0, null, null))
- end
-end
-
-# A `Care` is payed by the `Client` and can raises a `Refund`.
-interface Care
-
- # Does `id` is acceptable for this care?
- fun match_id(id: Int): Bool is abstract
-
- # Percent covered for this kind of care.
- fun cover: Float is abstract
-
- # Max amount covered for this kind of care by reclamation.
- fun max: nullable Dollar is abstract
-
- # Max amount covered for this kind of care by month.
- fun month_max: nullable Dollar is abstract
-
- # Computes the refund for this care.
- fun process_refund(fees: Dollar): Dollar do
- var max = self.max
- var val = ((fees.value.to_f * (cover / 100.0)) / 100.0).to_dollar
- if max != null and val > max then val = max
- return val
- end
-end
-
-# A `UniqCare` refers to one and only one kind of `Care`.
-#
-# For example, the care `Ostéopathie` as the uniq id `200`.
-class UniqCare
- super Care
-
- # Care id.
- var id: Int
-
- redef fun match_id(id) do return self.id == id
-
- redef var cover = 0.0
- redef var max = null
- redef var month_max = null
-
- # Inits this `Care` with values.
- #
- # * `id`: the `Care` id.
- # * `cover`: refund percentage covered for this `Care`.
- # * `max`: max amount refunded for this `Care` in a reclamation sheet.
- # * `month_max`: max amount refunded by month.
- init with_vals(id: Int, cover: Float, max, month_max: nullable Dollar) do
- init(id)
- self.cover = cover
- self.max = max
- self.month_max = month_max
- end
-
- redef fun to_s do return id.to_s
-end
-
-# A `RangeCare` refers to a set of id corresponding to the same `Care`.
-#
-# For example, the care `Soins Dentaires` is refered by the ids 300 to 399.
-class RangeCare
- super Care
-
- # Care id range.
- var id: Range[Int]
-
- redef fun match_id(id) do return self.id.has(id)
- redef var cover = 0.0
- redef var max = null
- redef var month_max = null
-
- # Inits this `Care` with values.
- #
- # * `id`: the `Care` id.
- # * `cover`: refund percentage covered for this `Care`.
- # * `max`: max amount refunded for this `Care` in a reclamation sheet.
- # * `month_max`: max amount refunded by month.
- init with_vals(id: Range[Int], cover: Float, max, month_max: nullable Dollar) do
- init(id)
- self.cover = cover
- self.max = max
- self.month_max = month_max
- end
-
- redef fun to_s do return id.first.to_s
-end
-
-# Used to represent currencies values.
-class Dollar
- super Comparable
-
- redef type OTHER: Dollar
-
- # Amount of cents.
- var value: Int
-
- # Inits `self` from a float `value`.
- init from_float(value: Float) do
- init((value * 100.0).to_i)
- end
-
- redef fun to_s do return "{value / 100}.{value % 100}$"
- redef fun <(o) do return value < o.value
-
- # Dollars addition.
- fun +(o: Dollar): Dollar do return new Dollar(value + o.value)
-
- # Dollars substraction.
- fun -(o: Dollar): Dollar do return new Dollar(value - o.value)
-end
-
-redef class Float
- # Returns `self` as a Dollar instance.
- fun to_dollar: Dollar do return new Dollar.from_float(self)
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Copyright 2015 Alexandre Terrasa <alexandre@moz-code.org>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# JSON handling for `refund`.
-module refund_json
-
-import refund_base
-import json::static
-import json
-
-redef class RefundProcessor
-
- redef fun process(input_file, output_file) do
- self.output_file = output_file
- var json = load_input(input_file)
- var sheet = new ReclamationSheet.from_json(self, json)
- var res = process_refunds(sheet)
- write_output(res.to_pretty_json, output_file)
- end
-
- # Computes allowed refunds for a given `ReclamationSheet`.
- fun process_refunds(sheet: ReclamationSheet): JsonObject do
- # update stats
- var stats = load_stats
- stats.inc("total_treatments")
- # compute refunds
- current_refunds.clear
- var json = new JsonObject
- json["dossier"] = sheet.file.to_s
- json["mois"] = sheet.month.to_s
- var arr = new JsonArray
- var sum = 0.0.to_dollar
- for recl in sheet.recls do
- var refund = process_refund(sheet, recl)
- var obj = new JsonObject
- obj["soin"] = recl.care_id
- obj["date"] = recl.date.to_s
- obj["montant"] = refund.to_s
- arr.add obj
- sum += refund
- # update stats for care
- stats.inc("total_{recl.care_id}")
- end
- save_stats(stats)
- json["remboursements"] = arr
- json["total"] = sum.to_s
- return json
- end
-
- # Loads the input string and returns its content as a JsonObject.
- #
- # Dies if the file cannot be read or does not contain a valid JSONObject.
- fun load_input(file: String): JsonObject do
- if not file.file_exists then
- die("File `{file}` not found.")
- abort
- end
- var ptr = new FileReader.open(file)
- var json = ptr.read_all.parse_json
- if json isa JsonParseError then
- die("Wrong input file ({json.message})")
- abort
- else if json == null then
- die("Unable to parse input file as json (got null)")
- abort
- else if not json isa JsonObject then
- die("Wrong input type (expected JsonObject got {json.class_name})")
- abort
- end
- ptr.close
- return json
- end
-
- # Writes `str` in path specified by `file`.
- #
- # Used to produce output and stats.
- fun write_output(str: String, file: String) do
- var ofs = new FileWriter.open(file)
- ofs.write(str)
- ofs.write("\n")
- ofs.close
- end
-
- # UTILS
-
- # Does `json` contains `key`? Dies otherwise.
- private fun check_key(json: JsonObject, key: String) do
- if json.has_key(key) then return
- die("Malformed input (missing key {key})")
- end
-
- # Does `str` match the regex `re`.
- private fun check_format(str, re: String): Bool do
- return str.has(re.to_re)
- end
-
- redef fun die(msg) do
- # save error
- var obj = new JsonObject
- obj["message"] = msg
- write_output(obj.to_pretty_json, output_file)
- # update stats
- var stats = load_stats
- stats.inc("total_reject")
- save_stats(stats)
- # leave
- exit 1
- end
-
- redef fun show_stats do print load_stats.to_json_object.to_pretty_json
-
- redef fun load_stats do
- # If no stats found, return a new object
- if not stats_file.file_exists then return new RefundStats
- # Try to read from file
- var ifs = new FileReader.open(stats_file)
- var content = ifs.read_all.parse_json
- ifs.close
- # If file is corrupted, return a new object
- if not content isa JsonObject then return new RefundStats
- # Return file contained stats
- return new RefundStats.from_json(content)
- end
-
- redef fun save_stats(stats) do
- write_output(stats.to_json_object.to_pretty_json, stats_file)
- end
-end
-
-redef class RefundStats
-
- # Inits `self` from the content of a JsonObject
- init from_json(json: JsonObject) do
- for k, v in json do self[k] = v.as(Int)
- end
-
- # Outputs `self` as a JSON string.
- fun to_json_object: JsonObject do
- var obj = new JsonObject
- for k, v in self do obj[k] = v
- return obj
- end
-end
-
-redef class ReclamationSheet
-
- # Inits `self` from the content of a `JsonObject`.
- init from_json(proc: RefundProcessor, json: JsonObject) do
- file = new ReclFile.from_json(proc, json)
- month = new ReclMonth.from_json(proc, json)
- recls = parse_recls(proc, json)
- init(file, month)
- end
-
- # Parses and checks the given `json` then returns an array of `Reclamation` instances.
- private fun parse_recls(proc: RefundProcessor, json: JsonObject): Array[Reclamation] do
- proc.check_key(json, "reclamations")
- var res = new Array[Reclamation]
- var recls = json["reclamations"]
- if recls == null then
- proc.die("Wrong type for `number` (expected JsonArray got null)")
- abort
- else if not recls isa JsonArray then
- proc.die("Wrong type for `number` (expected JsonArray got {recls.class_name})")
- abort
- end
- var i = 0
- for obj in recls do
- if obj == null then
- proc.die("Wrong type for `reclamations#{i}` (expected JsonObject got null)")
- abort
- else if not obj isa JsonObject then
- proc.die("Wrong type for `reclamations#{i}` " +
- "(expected JsonObject got {obj.class_name})")
- abort
- end
- var recl = new Reclamation.from_json(proc, obj)
- if not month.has(recl.date) then
- proc.die("Wrong `mois` for `soin` with id `{recl.care_id}`")
- abort
- end
- if file.contract.care_by_id(recl.care_id) == null then
- proc.die("Unknown `soin` with id `{recl.care_id}`")
- abort
- end
- res.add recl
- i += 1
- end
- return res
- end
-end
-
-redef class ReclFile
- # Inits `self` from the content of a JsonObject.
- init from_json(proc: RefundProcessor, json: JsonObject) do
- proc.check_key(json, "dossier")
- var id = json["dossier"]
- if id == null then
- proc.die("Wrong type for `dossier` (expected String got null)")
- abort
- else if not id isa String then
- proc.die("Wrong type for `dossier` (expected String got {id.class_name})")
- abort
- end
- # Check format
- parse_contract(proc, id)
- parse_client(proc, id)
- init(id)
- end
-
- # Tries to parse the contract from `file_id` string.
- private fun parse_contract(proc: RefundProcessor, file_id: String) do
- var kind = file_id.first.to_s
- if not proc.check_format(kind, "^[A-E]\{1\}$") then
- proc.die("Wrong contract (expected A, B, C, D or E got {kind})")
- end
- contract = contract_factory(proc, kind)
- end
-
- # Tries to parse the client number from the `file_id` string.
- private fun parse_client(proc: RefundProcessor, file_id: String) do
- var num = file_id.substring_from(1)
- if not proc.check_format(num, "^[0-9]\{6\}$") then
- proc.die("Wrong format for `number` (expected XXXXXX got {num})")
- abort
- end
- client = new Client(num)
- end
-end
-
-redef class ReclMonth
- # Inits `self` from a `JsonObject`.
- init from_json(proc: RefundProcessor, json: JsonObject) do
- proc.check_key(json, "mois")
- var month = json["mois"]
- if month == null then
- proc.die("Wrong type for `mois` (expected String got null)")
- return
- else if not month isa String then
- proc.die("Wrong type for `mois` (expected String got {month.class_name})")
- return
- end
- if not proc.check_format(month, "^[0-9]\{4\}-[0-9]\{2\}$") then
- proc.die("Wrong format for `mois` (expected AAAA-MM got {month})")
- return
- end
- from_string(proc, month)
- end
-
- # Inits `self` from a string representation formatted as `AAAA-MM`.
- init from_string(proc: RefundProcessor, str: String) do
- var parts = str.split("-")
- var year = parts[0].to_i
- var month = parts[1].to_i
- if month < 1 or month > 12 then
- proc.die("Wrong format for `mois` (expected AAAA-MM got {str})")
- return
- end
- date = new ReclDate(year, month, 1)
- init(date)
- end
-end
-
-redef class ReclDate
- # Inits `self` from a `JsonObject`.
- #
- # Dies if the `json` input is invalid.
- init from_json(proc: RefundProcessor, json: JsonObject) do
- proc.check_key(json, "date")
- var date = json["date"]
- if date == null then
- proc.die("Wrong type for `date` (expected String got null)")
- abort
- else if not date isa String then
- proc.die("Wrong type for `date` (expected String got {date.class_name})")
- abort
- end
- if not proc.check_format(date, "^[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}$") then
- proc.die("Wrong format for `date` (expected AAAA-MM-DD got {date})")
- abort
- end
- from_string(proc, date)
- end
-
- # Inits `self` from its string representation formatted as `AAAA-MM`.
- init from_string(proc: RefundProcessor, str: String) do
- var parts = str.split("-")
- year = parts[0].to_i
- month = parts[1].to_i
- day = parts[2].to_i
- if month < 1 or month > 12 or day < 1 or day > 31 then
- proc.die("Wrong format for `mois` (expected AAAA-MM got {str})")
- abort
- end
- init(year, month, day)
- end
-end
-
-redef class Reclamation
- # Inits `self` from a `JsonObject`.
- init from_json(proc: RefundProcessor, json: JsonObject) do
- care_id = parse_care_id(proc, json)
- date = new ReclDate.from_json(proc, json)
- fees = parse_fees(proc, json)
- init(care_id, date, fees)
- end
-
- # Inits `self` from its string representation formatted as `Int`.
- private fun parse_care_id(proc: RefundProcessor, json: JsonObject): Int do
- proc.check_key(json, "soin")
- var id = json["soin"]
- if id == null then
- proc.die("Wrong type for `soin` (expected Int got null)")
- abort
- else if not id isa Int then
- proc.die("Wrong type for `soin` (expected Int got {id.class_name})")
- abort
- end
- return id
- end
-
- # Inits `self` from its string representation formatted as `0.00$`.
- private fun parse_fees(proc: RefundProcessor, json: JsonObject): Dollar do
- proc.check_key(json, "montant")
- var fees = json["montant"]
- if fees == null then
- proc.die("Wrong type for `fees` (expected String got null)")
- abort
- else if not fees isa String then
- proc.die("Wrong type for `fees` (expected String got {fees.class_name})")
- abort
- end
- if not proc.check_format(fees, "^[0-9]+((\\.|\\,)[0-9]+)?\\$$") then
- proc.die("Wrong format for `montant` (expected XX.XX$ got {fees})")
- abort
- end
- return new Dollar.from_float(fees.basename("$").to_f)
- end
-end
+++ /dev/null
-# Copyright 2013 Alexandre Terrasa <alexandre@moz-code.org>.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-all: tests
-
-tests: clean
- ./tests.sh
-
-clean:
- rm -rf out/
+++ /dev/null
-{
- "dossier": "A",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A1003233",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A10032A",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": 1003233,
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 0,
- "date": "2015-01-11",
- "montant": "200.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- },
- {
- "soin": 600,
- "date": "2015-01-13",
- "montant": "90.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 150,
- "date": "2015-01-11",
- "montant": "200.00$"
- },
- {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "200.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 150,
- "date": "2015-01-11",
- "montant": "200,00$"
- },
- {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "200.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "130.00$"
- },
- {
- "soin": 175,
- "date": "2015-01-14",
- "montant": "130.00$"
- },
- {
- "soin": 175,
- "date": "2015-01-15",
- "montant": "130.00$"
- },
- {
- "soin": 175,
- "date": "2015-01-17",
- "montant": "130.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "400.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 200,
- "date": "2015-01-11",
- "montant": "69.00$"
- },
- {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "400.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 150,
- "date": "2015-01-11",
- "montant": "200.00$"
- },
- {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "200.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 150,
- "date": "2015-01-11",
- "montant": "200,00$"
- },
- {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "200,00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "400,00$"
- },
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "400,00$"
- },
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "400,00$"
- },
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "400,00$"
- },
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "400,00$"
- },
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "400,00$"
- },
- {
- "soin": 600,
- "date": "2015-01-11",
- "montant": "1400,00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "C100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "100.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-13",
- "montant": "200.00$"
- },
- {
- "soin": 399,
- "date": "2015-01-23",
- "montant": "400.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "C100323",
- "mois": "2015-01",
- "reclamations": []
-}
+++ /dev/null
-{
- "dossier": "C100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 150,
- "date": "2015-01-11",
- "montant": "200.00$"
- },
- {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "200.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "D100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-13",
- "montant": "900.00$"
- },
- {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "100.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "D100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 200,
- "date": "2015-01-11",
- "montant": "69.00$"
- },
- {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "400.00$"
- },
- {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "0.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "D100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 200,
- "date": "2015-01-11",
- "montant": "69.00$"
- },
- {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "400.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "D100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 150,
- "date": "2015-01-11",
- "montant": "200.00$"
- },
- {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "200.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "E100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-13",
- "montant": "900.00$"
- },
- {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "100.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "E100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 200,
- "date": "2015-01-11",
- "montant": "69.00$"
- },
- {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "400.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "E100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 200,
- "date": "2015-01-11",
- "montant": "69.00$"
- },
- {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 500,
- "date": "2015-01-23",
- "montant": "400.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "E100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 150,
- "date": "2015-01-11",
- "montant": "200.00$"
- },
- {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "200.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "a100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "Z100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "100100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": 10,
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015/01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-23",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015/01/11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-13-32",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-02-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01"
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": {
- "1": {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- "2": {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- "3": {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- }
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [1, 2, 3]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {},
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "ABCD"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "234.00"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": "200",
- "date": "2015-01-11",
- "montant": "234.00$"
- },
- {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.00$"
- },
- {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "125.00$"
- }
- ]
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "reclamations": [
- {
- "soin": 900,
- "date": "2015-01-11",
- "montant": "234.00$"
- }
- ]
-}
+++ /dev/null
-{
- "message": "Wrong format for `number` (expected XXXXXX got )"
-}
+++ /dev/null
-{
- "message": "Wrong format for `number` (expected XXXXXX got 1003233)"
-}
+++ /dev/null
-{
- "message": "Wrong format for `number` (expected XXXXXX got 10032A)"
-}
+++ /dev/null
-{
- "message": "Wrong type for `dossier` (expected String got Int)"
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 100,
- "date": "2015-01-11",
- "montant": "81.89$"
- }, {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "22.50$"
- }, {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "0.0$"
- }],
- "total": "104.39$"
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 0,
- "date": "2015-01-11",
- "montant": "50.0$"
- }, {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "0.0$"
- }, {
- "soin": 600,
- "date": "2015-01-13",
- "montant": "36.0$"
- }],
- "total": "86.0$"
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 150,
- "date": "2015-01-11",
- "montant": "0.0$"
- }, {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "100.0$"
- }],
- "total": "100.0$"
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 150,
- "date": "2015-01-11",
- "montant": "0.0$"
- }, {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "100.0$"
- }],
- "total": "100.0$"
-}
+++ /dev/null
-{
- "dossier": "A100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 175,
- "date": "2015-01-11",
- "montant": "65.0$"
- }, {
- "soin": 175,
- "date": "2015-01-14",
- "montant": "65.0$"
- }, {
- "soin": 175,
- "date": "2015-01-15",
- "montant": "65.0$"
- }, {
- "soin": 175,
- "date": "2015-01-17",
- "montant": "5.0$"
- }],
- "total": "200.0$"
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 100,
- "date": "2015-01-11",
- "montant": "50.0$"
- }, {
- "soin": 200,
- "date": "2015-01-13",
- "montant": "90.0$"
- }, {
- "soin": 334,
- "date": "2015-01-23",
- "montant": "200.0$"
- }],
- "total": "340.0$"
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 200,
- "date": "2015-01-11",
- "montant": "69.0$"
- }, {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "0.0$"
- }, {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "300.0$"
- }],
- "total": "369.0$"
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 150,
- "date": "2015-01-11",
- "montant": "0.0$"
- }, {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "150.0$"
- }],
- "total": "150.0$"
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 150,
- "date": "2015-01-11",
- "montant": "0.0$"
- }, {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "150.0$"
- }],
- "total": "150.0$"
-}
+++ /dev/null
-{
- "dossier": "B100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 100,
- "date": "2015-01-11",
- "montant": "50.0$"
- }, {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "50.0$"
- }, {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "50.0$"
- }, {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "50.0$"
- }, {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "50.0$"
- }, {
- "soin": 100,
- "date": "2015-01-11",
- "montant": "0.0$"
- }, {
- "soin": 600,
- "date": "2015-01-11",
- "montant": "300.0$"
- }],
- "total": "550.0$"
-}
+++ /dev/null
-{
- "dossier": "C100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 100,
- "date": "2015-01-11",
- "montant": "95.0$"
- }, {
- "soin": 334,
- "date": "2015-01-13",
- "montant": "180.0$"
- }, {
- "soin": 399,
- "date": "2015-01-23",
- "montant": "360.0$"
- }],
- "total": "635.0$"
-}
+++ /dev/null
-{
- "dossier": "C100323",
- "mois": "2015-01",
- "remboursements": [],
- "total": "0.0$"
-}
+++ /dev/null
-{
- "dossier": "C100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 150,
- "date": "2015-01-11",
- "montant": "170.0$"
- }, {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "180.0$"
- }],
- "total": "350.0$"
-}
+++ /dev/null
-{
- "dossier": "D100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 100,
- "date": "2015-01-11",
- "montant": "75.0$"
- }, {
- "soin": 334,
- "date": "2015-01-13",
- "montant": "900.0$"
- }, {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "100.0$"
- }],
- "total": "1075.0$"
-}
+++ /dev/null
-{
- "dossier": "D100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 200,
- "date": "2015-01-11",
- "montant": "69.0$"
- }, {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "65.0$"
- }, {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "100.0$"
- }, {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "0.0$"
- }],
- "total": "234.0$"
-}
+++ /dev/null
-{
- "dossier": "D100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 200,
- "date": "2015-01-11",
- "montant": "69.0$"
- }, {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "65.0$"
- }, {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "100.0$"
- }],
- "total": "234.0$"
-}
+++ /dev/null
-{
- "dossier": "D100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 150,
- "date": "2015-01-11",
- "montant": "150.0$"
- }, {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "190.0$"
- }],
- "total": "340.0$"
-}
+++ /dev/null
-{
- "dossier": "E100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 100,
- "date": "2015-01-11",
- "montant": "58.50$"
- }, {
- "soin": 334,
- "date": "2015-01-13",
- "montant": "540.0$"
- }, {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "15.0$"
- }],
- "total": "613.50$"
-}
+++ /dev/null
-{
- "dossier": "E100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 200,
- "date": "2015-01-11",
- "montant": "8.27$"
- }, {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "15.0$"
- }, {
- "soin": 600,
- "date": "2015-01-23",
- "montant": "60.0$"
- }],
- "total": "83.27$"
-}
+++ /dev/null
-{
- "dossier": "E100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 200,
- "date": "2015-01-11",
- "montant": "8.27$"
- }, {
- "soin": 400,
- "date": "2015-01-13",
- "montant": "15.0$"
- }, {
- "soin": 500,
- "date": "2015-01-23",
- "montant": "20.0$"
- }],
- "total": "43.27$"
-}
+++ /dev/null
-{
- "dossier": "E100323",
- "mois": "2015-01",
- "remboursements": [{
- "soin": 150,
- "date": "2015-01-11",
- "montant": "30.0$"
- }, {
- "soin": 175,
- "date": "2015-01-11",
- "montant": "20.0$"
- }],
- "total": "50.0$"
-}
+++ /dev/null
-{
- "message": "Wrong contract (expected A, B, C, D or E got 1)"
-}
+++ /dev/null
-{
- "message": "Wrong contract (expected A, B, C, D or E got a)"
-}
+++ /dev/null
-{
- "message": "Wrong contract (expected A, B, C, D or E got Z)"
-}
+++ /dev/null
-{
- "message": "Wrong contract (expected A, B, C, D or E got 1)"
-}
+++ /dev/null
-{
- "message": "Malformed input (missing key dossier)"
-}
+++ /dev/null
-{
- "message": "Wrong input file (Empty JSON)"
-}
+++ /dev/null
-{
- "message": "Wrong input type (expected JsonObject got JsonArray)"
-}
+++ /dev/null
-{
- "message": "Wrong input file (Malformed JSON object)"
-}
+++ /dev/null
-{
- "message": "Malformed input (missing key mois)"
-}
+++ /dev/null
-{
- "message": "Wrong type for `mois` (expected String got Int)"
-}
+++ /dev/null
-{
- "message": "Wrong format for `mois` (expected AAAA-MM got 2015/01)"
-}
+++ /dev/null
-{
- "message": "Wrong format for `mois` (expected AAAA-MM got 2015-23)"
-}
+++ /dev/null
-{
- "message": "Malformed input (missing key date)"
-}
+++ /dev/null
-{
- "message": "Wrong format for `date` (expected AAAA-MM-DD got 2015/01/11)"
-}
+++ /dev/null
-{
- "message": "Wrong format for `mois` (expected AAAA-MM got 2015-13-32)"
-}
+++ /dev/null
-{
- "message": "Wrong `mois` for `soin` with id `100`"
-}
+++ /dev/null
-{
- "message": "Malformed input (missing key reclamations)"
-}
+++ /dev/null
-{
- "message": "Wrong type for `number` (expected JsonArray got JsonObject)"
-}
+++ /dev/null
-{
- "message": "Wrong type for `reclamations#0` (expected JsonObject got Int)"
-}
+++ /dev/null
-{
- "message": "Malformed input (missing key soin)"
-}
+++ /dev/null
-{
- "message": "Malformed input (missing key montant)"
-}
+++ /dev/null
-{
- "message": "Wrong format for `montant` (expected XX.XX$ got ABCD)"
-}
+++ /dev/null
-{
- "message": "Wrong format for `montant` (expected XX.XX$ got 234)"
-}
+++ /dev/null
-{
- "message": "Wrong format for `montant` (expected XX.XX$ got 234.00)"
-}
+++ /dev/null
-{
- "message": "Malformed input (missing key soin)"
-}
+++ /dev/null
-{
- "message": "Wrong type for `soin` (expected Int got ASCIIFlatString)"
-}
+++ /dev/null
-{
- "message": "Unknown `soin` with id `900`"
-}
+++ /dev/null
-#!/bin/bash
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Copyright 2015 Alexandre Terrasa <alexandre@moz-code.org>.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-BIN=../bin
-OUT=out
-RES=res
-
-# Execute test with name $1.
-run_test()
-{
- local test="$1"
- $BIN/refund $test.json $OUT/$test.res > $OUT/$test.out 2> $OUT/$test.err
- diff $OUT/$test.res $RES/$test.res > $OUT/$test.diff 2> /dev/null
-}
-
-# Return
-# 0 if the sav not exists
-# 1 if the file does match
-# 2 if the file does not match
-check_result() {
- local test="$1"
-
- if [ ! -r "$RES/$test.res" ]; then
- return 0
- elif [ ! -s $OUT/$test.diff ]; then
- return 1
- else
- return 2
- fi
-}
-
-echo "Testing..."
-echo ""
-
-rm -rf $OUT 2>/dev/null
-mkdir $OUT 2>/dev/null
-
-all=0
-ok=0
-ko=0
-sk=0
-
-for file in `ls *.json`; do
- ((all++))
- test="${file%.*}"
- echo -n "* $test: "
-
- run_test $test
- check_result $test
-
- case "$?" in
- 0)
- echo "skip ($test.res not found)"
- ((sk++))
- continue;;
- 1)
- echo "success"
- ((ok++))
- ;;
- 2)
- echo "error (diff $OUT/$test.res $RES/$test.res)"
- ((ko++))
- ;;
- esac
-done
-
-# clear tmp stats file.
-rm stats.json
-
-echo ""
-echo "==> success $ok/$all ($ko tests failed, $sk skipped)"
-
-# return result
-test "$ok" == "$all"
+++ /dev/null
-# wiringPi nit wrapper
-
-## Installation
-
-You need to install the [wiringPi library](http://wiringpi.com/). Refer to [download and install](http://wiringpi.com/download-and-install/) manual.
-
-## Compiling
-
-Link to the library must be passed to nit compiler:
-
- nitc myprogram.nit --cc-lib-name wiringPi
-
-## Usage
-
-You first need to initialize the wiringPi library using a setup methods.
-
-Setup methods are:
-
-* `wiringPi_setup`: This initialises wiringPi and assumes that the calling program is going to be using the wiringPi pin numbering scheme;
-* `wiringPi_setup_gpio`: Same as wiringPi_setup, however it allows the calling programs to use the Broadcom GPIO pin numbers directly with no re-mapping;
-* `wiringPi_setup_phys`: Identical to wiringPi_setup, however it allows the calling programs to use the physical pin numbers on the P1 connector only;
-* `wiringPi_setup_sys`: This initialises wiringPi but uses the /sys/class/gpio interface rather than accessing the hardware directly;
-
-For example:
-
- # init wiringPi lib with gpio output
- wiringPi_set_gpio
-
-Then you can refer to a GPIO Pin using its id:
-
- var pin = new RPIPin(23)
-
-Before read or write a value on a pin you need to set its mode.
-
-Modes are:
-
-* INPUT
-* OUTPUT
-* PWM_OUTPUT
-* GPIO_CLOCK
-
-Note that only wiringPi pin 1 (BCM\_GPIO 18) supports PWM output and only wiringPi pin 7 (BCM\_GPIO 4) supports CLOCK output modes.
-
- pin.mode(new RPIPinMode.output_mode)
-
-You can then `write` or `read` a value from the pin:
-
- pin.write(true)
- pin.read
-
-## Copyrigth
-
-The wiringPi library is released under [GNU LGPLv3](http://www.gnu.org/copyleft/lesser.html) licence.
-
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Copyright 2013 Alexandre Terrasa <alexandre@moz-code.org>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module blink is example
-
-import wiringPi
-
-if args.length != 1 then
- print "usage: blink pin_id"
- exit(1)
-end
-
-# init wiringPi lib
-wiringPi_setup
-
-# init the pin
-var id = args.first.to_i
-var pin = new RPiPin(id)
-pin.mode(new RPiPinMode.output_mode)
-
-# blink
-loop
- pin.write(true)
- nanosleep(1, 0)
- pin.write(false)
- nanosleep(1, 0)
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Copyright 2013 Alexandre Terrasa <alexandre@moz-code.org>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module read is example
-
-import wiringPi
-
-if args.length != 1 then
- print "usage: blink pin_id"
- exit(1)
-end
-
-# init wiringPi lib
-wiringPi_setup
-
-# init the pin
-var id = args.first.to_i
-var pin = new RPiPin(id)
-pin.mode(new RPiPinMode.input_mode)
-
-# listen
-loop
- print pin.read
- nanosleep(1, 0)
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Copyright 2013 Alexandre Terrasa <alexandre@moz-code.org>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module shift is example
-
-import wiringPi
-
-if args.is_empty or args.length > 2 then
- print "usage:"
- print "\tshift <register> <state>"
- print "\tshift clear"
- print "\tshift all"
- exit(1)
-end
-
-# init wiringPi lib
-wiringPi_setup
-
-# register layout and pin numbering
-var nb_pins = 8
-var ser_pin = 7
-var rclk_pin = 6
-var srclk_pin = 5
-var sr = new SR595(nb_pins, ser_pin, rclk_pin, srclk_pin)
-
-# set all registers to 0
-if args.first == "clear" then
- sr.clear_registers
-# set all registers to 1
-else if args.first == "all" then
- var regs = new Array[Bool].filled_with(true, nb_pins)
- sr.clear_registers
- sr.write_all(regs)
-# set specified register to specified value
-else
- if args[1].to_i == 0 then
- sr.write(args.first.to_i, false)
- else
- sr.write(args.first.to_i, true)
- end
-end
+++ /dev/null
-# This file is part of NIT ( http://www.nitlanguage.org ).
-#
-# Copyright 2013 Alexandre Terrasa <alexandre@moz-code.org>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Nit wrapping of the wiringPi library [http://wiringpi.com/]
-# WiringPi is an Arduino wiring-like library written in C
-# and released under the GNU LGPLv3 license which is usable
-# from C and C++ and many other languages with suitable wrappers
-module wiringPi
-
-in "C Header" `{
- #include <wiringPi.h>
-
- typedef struct {
- int id;
- } CRPiPin;
-`}
-
-
-# Initializes wiringPi.
-# Assumes that the calling program is going to be using the wiringPi pin numbering scheme.
-fun wiringPi_setup `{ wiringPiSetup(); `}
-
-# Same as wiringPi_setup, but with GPIO.
-# It allows the calling programs to use the Broadcom GPIO pin numbers directly with no re-mapping.
-fun wiringPi_setup_gpio `{ wiringPiSetupGpio(); `}
-
-# Same as to wiringPi_setup, but with physical pin numbers.
-# It allows the calling programs to use the physical pin numbers on the P1 connector only.
-fun wiringPi_setup_phys `{ wiringPiSetupPhys(); `}
-
-# This initializes wiringPi, but with the /sys/class/gpio interface.
-# Use `/sys/class/gpio` rather than accessing the hardware directly.
-fun wiringPi_setup_sys `{ wiringPiSetupSys(); `}
-
-# A Raspberry Pi GPIO Pin
-extern class RPiPin `{ CRPiPin *`}
- new (id: Int) `{
- CRPiPin *pin = malloc( sizeof(CRPiPin) );
- pin->id = id;
- return pin;
- `}
-
- # The pin `id` depends on wiringPi setup used
- fun id: Int `{ return self->id; `}
-
- # Sets the mode of the pin
- fun mode(mode: RPiPinMode) `{ pinMode(self->id, mode); `}
-
- # This sets the pull-up or pull-down resistor mode on the given pin,
- # which should be set as an input.
- fun pullup_dncontrol(pud: PUDControl) `{ pullUpDnControl(self->id, pud); `}
-
- # Writes the value HIGH or LOW (true or false) to the given pin which must
- # have been previously set as an output.
- fun write(high: Bool) `{ digitalWrite(self->id, high? HIGH: LOW); `}
-
- # Writes the value to the PWM register for the given pin.
- # The Raspberry Pi has one on-board PWM pin, pin 1 (BMC_GPIO 18, Phys 12)
- # and the range is 0-1024.
- # Other PWM devices may have other PWM ranges.
- fun pwm_write(value: Int) `{ pwmWrite(self->id, value); `}
-
- # This function returns the value read at the given pin.
- # It will be HIGH or LOW (true or false) depending on the logic level at the pin.
- fun read: Bool `{ return digitalRead(self->id) == HIGH? true: false; `}
-end
-
-# RPI Pin modes
-# Modes are:
-# * INPUT
-# * OUTPUT
-# * PWM_OUTPUT
-# * GPIO_CLOCK
-# Note that only wiringPi pin 1 (BCM_GPIO 18) supports PWM output
-# and only wiringPi pin 7 (BCM_GPIO 4) supports CLOCK output modes.
-extern class RPiPinMode `{ int `}
- new input_mode `{ return INPUT; `}
- new output_mode `{ return OUTPUT; `}
- new pwm_mode `{ return PWM_OUTPUT; `}
- new clock_mode `{ return GPIO_CLOCK; `}
-end
-
-# The BCM2835 has both pull-up an down internal resistors.
-# The parameter pud should be:
-# * PUD_OFF, (no pull up/down)
-# * PUD_DOWN (pull to ground)
-# * PUD_UP (pull to 3.3v)
-# The internal pull up/down resistors have a value of approximately
-# 50Kohms on the Raspberry Pi.
-extern class PUDControl `{ int `}
- new off `{ return PUD_OFF; `}
- new down `{ return PUD_DOWN; `}
- new up `{ return PUD_UP; `}
-end
-
-# Abstraction a daisy chain of 74×595 shift registers
-class SR595
- private var registers: Array[Bool]
- private var nb_pins: Int
- private var ser: RPiPin
- private var rclk: RPiPin
- private var srclk: RPiPin
-
- # Initialize a new shift register chain
- # `nb_pins`: number of pins available
- # `ser_pin`: SER (serial) pin id
- # `rclk_pin`: RCLK (register clock) pin id
- # `srclk_pin`: SRCLK (serial clock) pin id
- init(nb_pins, ser_pin, rclk_pin, srclk_pin: Int) do
- # configure pin layout
- self.nb_pins = nb_pins
- self.ser = new RPiPin(7)
- self.rclk = new RPiPin(6)
- self.srclk = new RPiPin(5)
- clear_registers
- # enable output mode on shift register output
- ser.mode(new RPiPinMode.output_mode)
- rclk.mode(new RPiPinMode.output_mode)
- srclk.mode(new RPiPinMode.output_mode)
- end
-
- # write 'state' on register 'reg'
- fun write(reg: Int, state: Bool) do
- registers[reg] = state
- write_registers
- end
-
- # write all registers
- fun write_all(regs: Array[Bool]) do
- assert regs.length == nb_pins
- registers = regs
- write_registers
- end
-
- # clear all registers
- fun clear_registers do
- registers = new Array[Bool].filled_with(false, nb_pins)
- write_registers
- end
-
- private fun write_registers do
- rclk.write(false)
- var i = registers.length - 1
- while i >= 0 do
- var reg = registers[i]
- srclk.write(false)
- ser.write(reg)
- srclk.write(true)
- i -= 1
- end
- rclk.write(true)
- end
-end
-
+++ /dev/null
-[package]
-name=wiringPi
-tags=embedded,wrapper
-maintainer=Alexandre Terrasa <alexandre@moz-code.org>
-license=Apache-2.0
-desc=wiringPi nit wrapper
-[upstream]
-browse=https://github.com/nitlang/nit/tree/master/contrib/wiringPi/
-git=https://github.com/nitlang/nit.git
-git.directory=contrib/wiringPi/
-homepage=http://nitlanguage.org
-issues=https://github.com/nitlang/nit/issues
nitlanguage / nit.git / commitdiff