diff --git a/.gitignore b/.gitignore index 0d2c1ec..e0c41c4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,8 @@ build +_build/ dist test-output *.egg-info +_doxygen/ +__pycache__/ +/venv/ diff --git a/README.md b/README.md index 254587e..759715c 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,106 @@ -sphinx-csharp [![Build Status](https://travis-ci.org/djungelorm/sphinx-csharp.svg?branch=master)](https://travis-ci.org/djungelorm/sphinx-csharp) -============= +# sphinx-csharp -C# domain for Sphinx. +C# Domain for Sphinx with Breathe integration. Used to create ReadTheDocs style C# documentation. -Note: Work-in-progress. Only a subset of C# is currently supported. +See [vr-modeling example](https://vr-modeling.readthedocs.io/Assets/Scripts/Libigl/index.html) end-product. -Usage ------ +**Idea:** +1. Generate Doxygen xml +1. Convert this to Sphinx using breathe + sphinx-csharp +1. Apply ReadTheDocs theme +1. Write rst using the `cs` domain + +## Usage Install using pip: ``` -pip install sphinx-csharp +pip install git+https://github.com/rogerbarton/sphinx-csharp.git ``` To enable the extension, add the following to your conf.py: -```python -extensions = ['sphinx_csharp.csharp'] +```py +extensions = ['sphinx_csharp'] ``` -See [this example](https://raw.githubusercontent.com/djungelorm/sphinx-csharp/master/test/index.rst) of how to document C# code. +See https://github.com/djungelorm/sphinx-csharp/pull/8 for usage/changes from upstream and also [this rst example](https://raw.githubusercontent.com/rogerbarton/sphinx-csharp/master/test/index.rst). + +### `conf.py` Options +Various options can be set in the sphinx `conf.py`. See [`__init__.py:setup()`](https://github.com/rogerbarton/sphinx-csharp/blob/master/sphinx_csharp/__init__.py) for available options. Defaults for external references are indicated or in [`extrefs_data.py`](https://github.com/rogerbarton/sphinx-csharp/blob/master/sphinx_csharp/extrefs_data.py). +See also [`csharp.py:apply_config(cls, config: Config)`](https://github.com/rogerbarton/sphinx-csharp/blob/master/sphinx_csharp/csharp.py) for exact defaults. + +Here are the default values for all available options: + +```py +# Are other languages used in the sphinx project, if yes add language (domain) prefix to reference labels +sphinx_csharp_multi_language = False + +# Should generated external links be tested for validity +sphinx_csharp_test_links = False + +# Remove these common prefixes from labels +sphinx_csharp_shorten_type_prefixes = [ + 'System.', + 'System.IO', + ... +] + +# Do not create cross references for these standard/build-in types +sphinx_csharp_ignore_xref = [ + 'string', + 'Vector2', + ... +] + +# How to generate external doc links, replace %s with type. Use the format +# 'package name': ('direct link to %s', 'alternate backup link or search page') +sphinx_csharp_ext_search_pages = { + 'upm.xrit': ('https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@0.9/api/%s.html', + 'https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@0.9/?%s'), + ... +} + +# Types that are in an external package. Use the format +# 'package name': { +# 'Namespace1': ['Type1', 'Type2'], +sphinx_csharp_ext_type_map = { + 'unity': { + '': ['MonoBehaviour', 'ScriptableObject'], + 'XR': ['InputDevice', 'InputDeviceCharacteristics'], + ... + }, + ... +} + +# [Advanced] Rename type before generating external link. Commonly used for generic types +sphinx_csharp_external_type_rename = { + 'List': 'List-1', + 'NativeArray': 'NativeArray_1', + ... +} + +# Debug options, these enable various verbose logging features. +sphinx_csharp_debug = False # enables all debug options +sphinx_csharp_debug_parse = False # enables all parsing options +sphinx_csharp_debug_parse_func = False +sphinx_csharp_debug_parse_var = False +sphinx_csharp_debug_parse_prop = False +sphinx_csharp_debug_parse_attr = False +sphinx_csharp_debug_parse_idxr = False +sphinx_csharp_debug_parse_type = False +sphinx_csharp_debug_xref = False +sphinx_csharp_debug_ext_links = False +``` + +See also [this example](https://github.com/rogerbarton/vr-modeling/blob/69885cd454935e3c5b54ef5a6b9a94da73575b20/conf.py). + +### Examples and Tests + +See build scripts in `test`. This is quite incomplete at the moment. The [vr-modeling example](https://vr-modeling.readthedocs.io/Assets/Scripts/Libigl/index.html) will likely be most useful as a reference. + + +## Common Bug Sources +- Newer C# syntax that is not supported yet, see regexes at beginning of `csharp.py` for parsing +- Incorrect xml reconstruction in breathe, see `def visit_*` in breathe `render/sphinxrenderer.py` + - e.g. `visit_variable` will create the signature that is given to `csharp.py` \ No newline at end of file diff --git a/setup.py b/setup.py index 066b449..69bc0bc 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ setup( name = 'sphinx-csharp', - version = '0.1.8', + version = '0.1.12', author = 'djungelorm', author_email = 'djungelorm@users.noreply.github.com', packages = ['sphinx_csharp'], diff --git a/sphinx_csharp/__init__.py b/sphinx_csharp/__init__.py index 8b13789..a7da157 100644 --- a/sphinx_csharp/__init__.py +++ b/sphinx_csharp/__init__.py @@ -1 +1,22 @@ +from .csharp import CSharpDomain +from .debug import CSDebug +from sphinx.application import Sphinx + +def setup(app: Sphinx) -> None: + """ Setup called by sphinx when the module is added to the extensions list in conf.py """ + + # Register domain + app.add_domain(CSharpDomain) + app.connect('config-inited', CSharpDomain.apply_config) + + # Add variables available in conf.py + app.add_config_value('sphinx_csharp_test_links', False, 'env') + app.add_config_value('sphinx_csharp_multi_language', False, 'env') + app.add_config_value('sphinx_csharp_shorten_type_prefixes', None, 'env') + app.add_config_value('sphinx_csharp_ignore_xref', None, 'env') + app.add_config_value('sphinx_csharp_ext_type_map', None, 'env') + app.add_config_value('sphinx_csharp_external_type_rename', None, 'env') + app.add_config_value('sphinx_csharp_ext_search_pages', None, 'env') + + CSDebug.add_config_values(app) diff --git a/sphinx_csharp/csharp.py b/sphinx_csharp/csharp.py index db2b36c..33f5892 100644 --- a/sphinx_csharp/csharp.py +++ b/sphinx_csharp/csharp.py @@ -2,39 +2,78 @@ import re from collections import namedtuple +from typing import List + from docutils import nodes from docutils.parsers.rst import Directive from sphinx import addnodes +from sphinx.application import Sphinx +from sphinx.config import Config +from sphinx.directives import ObjectDescription from sphinx.domains import Domain, ObjType +# noinspection PyProtectedMember from sphinx.locale import _ -from sphinx.directives import ObjectDescription from sphinx.roles import XRefRole +from sphinx.util import logging from sphinx.util.nodes import make_refnode -MODIFIERS_RE = '|'.join(['public', 'private', 'internal', 'protected', - 'abstract', 'async', 'const', 'event', - 'extern', 'new', 'override', 'partial', - 'readonly', 'sealed', 'static', 'unsafe', - 'virtual', 'volatile']) -PARAM_MODIFIERS_RE = '|'.join(['ref', 'out', 'params']) +from .debug import CSDebug +from .extrefs import ExternalRefs + +MODIFIERS_RE_SIMPLE = '|'.join(['public', 'private', 'internal', 'protected', + 'abstract', 'async', 'const', 'event', 'delegate', + 'extern', 'new', 'override', 'partial', + 'readonly', 'sealed', 'static', 'unsafe', + 'virtual', 'volatile', 'ref']) + +PARAM_MODIFIERS_RE_SIMPLE = '|'.join(['this', 'ref', 'in', 'out', 'params']) + +MODIFIERS_RE = re.compile(r'\s*(?:(?P(?:\s*(?:' + MODIFIERS_RE_SIMPLE + r'))*)\s+)?') +# Exactly the same but with param modifiers +PARAM_MODIFIERS_RE = re.compile(r'\s*(?:(?P(?:\s*(?:' + PARAM_MODIFIERS_RE_SIMPLE + r'))*)\s+)?\s*') + + +TYPE_RE = re.compile(r'(?:template(?P<\s*.+\s*>))?\s*' + r'(?P(?P[^\s<\[{*&?]+)\s*(?P<\s*.+\s*>)?\s*' + r'(?P(\[,*\])*)?\s*(?P[*&?])?)\??') + +TYPE_OPTIONAL_RE = re.compile(r'(?:template(?P<\s*.+\s*>))?\s*' + r'(?:(?P(?P[^\s<\[{*&?]+)\s*(?P<\s*.+\s*>)?\s*' + r'(?P(\[,*\])*)?\s*(?P[*&?])?)\s+)?\??') METH_SIG_RE = re.compile( - r'^((?:(?:' + MODIFIERS_RE + - r')\s+)*)([^\s]+\s+)*([^\s<]+)\s*(<[^\(]+>)?\s*\((.*)\)$') + r'^' + MODIFIERS_RE.pattern + TYPE_OPTIONAL_RE.pattern + + r'(?P[^\s<(]+)\s*' + r'(?P<[^(]+>)?\s*' + r'\((?P.*)?\)$') + +VAR_SIG_RE = re.compile( + r'^' + MODIFIERS_RE.pattern + TYPE_RE.pattern + r'\s+(?P[^\s<{(=]+)\s*(?:=\s*(?P.+))?$') +VAR_PARAM_SIG_RE = re.compile( + r'^' + PARAM_MODIFIERS_RE.pattern + TYPE_RE.pattern + r'\s+(?P[^\s<{=]+)\s*(?:=\s*(?P.+))?$') + PROP_SIG_RE = re.compile( - r'^([^\s]+\s+)*([^\s]+)\s+([^\s]+)\s*\{\s*(get;)?\s*(set;)?\s*\}$') + r'^([^\s]+\s+)*([^\s]+)\s+([^\s]+)\s*{\s*(get;)?\s*(set;)?\s*}\s*=?\s*(.+)?\s*$') + IDXR_SIG_RE = re.compile( - r'^((?:(?:' + MODIFIERS_RE + + r'^((?:(?:' + MODIFIERS_RE_SIMPLE + r')\s+)*)([^\s]+)\s*this\s*\[\s*((?:[^\s]+)\s+(?:[^\s]+)' + r'(?:\s*,\s*(?:[^\s]+)\s+(?:[^\s]+))*)\s*\]\s*' + - r'\{\s*(get;)?\s*(set;)?\s*\}$') -PARAM_SIG_RE = re.compile( - r'^((?:(?:' + PARAM_MODIFIERS_RE + - r')\s+)*)([^\s]+)\s+([^\s]+)\s*(=\s*(.+))?$') -TYPE_SIG_RE = re.compile(r'^([^\s<\[]+)\s*(<.+>)?\s*(\[\])?$') + r'{\s*(get;)?\s*(set;)?\s*}$') +# +# PARAM_SIG_RE = re.compile( +# r'^((?:(?:' + PARAM_MODIFIERS_RE + +# r')\s+)*)(.+)\s+([^\s]+)\s*(=\s*(.+))?$') + +INHERITS_RE = re.compile(r'(?:\s*:\s*(?P.*))?') +CLASS_SIG_RE = re.compile(r'^' + MODIFIERS_RE.pattern + TYPE_RE.pattern + INHERITS_RE.pattern + r'$') + ATTR_SIG_RE = re.compile(r'^([^\s]+)(\s+\((.*)\))?$') + ParamTuple = namedtuple('ParamTuple', ['name', 'typ', 'default', 'modifiers']) +logger = logging.getLogger(__name__) + def split_sig(params): """ @@ -56,159 +95,199 @@ def split_sig(params): if char != ',' or level > 0: current += char elif char == ',' and level == 0: - result.append(current) + result.append(current.strip()) current = '' if current.strip() != '': - result.append(current) + result.append(current.strip()) return result -def parse_method_signature(sig): +def parse_method_signature(sig: str, location): """ Parse a method signature of the form: modifier* type name (params) """ match = METH_SIG_RE.match(sig.strip()) if not match: - raise RuntimeError('Method signature invalid: ' + sig) - modifiers, return_type, name, generic_types, params = match.groups() + logger.warning(f'Method signature invalid: {sig}', location=location) + return sig, None, None, None, None, None + + groups = match.groupdict() + modifiers = groups['modifiers'] + return_type = groups['fulltype'] + name = groups['fname'] + generic_params = groups['genericparams'] + params = groups['params'] + + if not modifiers: + modifiers = [] + else: + modifiers = modifiers.split() + + if return_type: + return_type = return_type.strip() + + if not generic_params: + generic_params = [] + else: + # Remove outermost < > brackets + generic_params = split_sig(generic_params[1:-1]) + # TODO: create ref target with namespace+function name when parsing + if params.strip() != '': params = split_sig(params) - params = [parse_param_signature(x) for x in params] + params = [parse_param_signature(x, location) for x in params] else: params = [] - return (modifiers.split(), return_type, name, generic_types, params) + if CSDebug.parse_func: + logger.info(f"parsed func: {modifiers, return_type, name, generic_params, params}") + return modifiers, return_type, name, generic_params, params + + +def parse_variable_signature(sig: str, location, is_param=False): + """ + Parse a variable signature of the form: + modifier* type name = value + is_param: interpret as parameter? uses parameter modifiers + """ + match = (VAR_PARAM_SIG_RE if is_param else VAR_SIG_RE).match(sig.strip()) + if not match: + logger.warning(('Parameter' if is_param else 'Variable') + f' signature invalid: {sig}', location=location) + return sig, None, None, None, None, None + + groups = match.groupdict() + modifiers = groups['modifiers'] + fulltype = groups['fulltype'].strip() + typ = groups['type'] + generics = groups['generics'] + if not generics: + generics = groups['templates'] # Doxygen compatibility + name = groups['name'] + default_value = groups['value'] + + if not modifiers: + modifiers = [] + else: + modifiers = modifiers.split() + + if not generics: + generics = [] + else: + # Remove outermost < > brackets + generics = split_sig(generics[1:-1]) -def parse_property_signature(sig): + if CSDebug.parse_var: + logger.info(f"parsed var: {modifiers, fulltype, typ, generics, name, default_value}") + return modifiers, fulltype, typ, generics, name, default_value + + +def parse_property_signature(sig: str, location): """ Parse a property signature of the form: modifier* type name { (get;)? (set;)? } """ match = PROP_SIG_RE.match(sig.strip()) if not match: - raise RuntimeError('Property signature invalid: ' + sig) + if CSDebug.parse_prop: + logger.info(f'Property signature not valid, falling back to variable: {sig}', location=location) + modifiers, fulltype, typ, generics, name, value = parse_variable_signature(sig, location) + return modifiers, fulltype, name, False, False + groups = match.groups() if groups[0] is not None: - modifiers = [x.strip() for x in groups[:-4]] - groups = groups[-4:] + modifiers = [x.strip() for x in groups[:-5]] + groups = groups[-5:] else: modifiers = [] groups = groups[1:] - typ, name, getter, setter = groups - return (modifiers, typ, name, getter is not None, setter is not None) + typ, name, getter, setter, default_val = groups + + if CSDebug.parse_prop: + logger.info(f"parsed prop: {modifiers, typ, name, getter is not None, setter is not None}") + return modifiers, typ, name, getter is not None, setter is not None, default_val -def parse_indexer_signature(sig): +def parse_indexer_signature(sig: str, location): """ Parse a indexer signature of the form: modifier* type this[params] { (get;)? (set;)? } """ match = IDXR_SIG_RE.match(sig.strip()) if not match: - raise RuntimeError('Indexer signature invalid: ' + sig) + logger.warning(f'Indexer signature invalid: {sig}', location=location) + # TODO: return a better default value? + return sig, None, None, False, False + modifiers, return_type, params, getter, setter = match.groups() params = split_sig(params) - params = [parse_param_signature(x) for x in params] - return (modifiers.split(), return_type, params, - getter is not None, setter is not None) + params = [parse_param_signature(x, location) for x in params] + if CSDebug.parse_idxr: + logger.info(f"parsed idxr: {modifiers.split(), return_type, params, getter is not None, setter is not None}") + return modifiers.split(), return_type, params, getter is not None, setter is not None -def parse_param_signature(sig): - """ Parse a parameter signature of the form: type name (= default)? """ - match = PARAM_SIG_RE.match(sig.strip()) - if not match: - raise RuntimeError('Parameter signature invalid, got ' + sig) - groups = match.groups() - modifiers = groups[0].split() - typ, name, _, default = groups[-4:] - return ParamTuple(name=name, typ=typ, - default=default, modifiers=modifiers) + +def parse_param_signature(sig: str, location): + """ Parse a parameter signature of the form: modifier type name (= default)? + Interprets as a variable with different modifiers """ + modifiers, fulltype, typ, generics, name, default_value = parse_variable_signature(sig, location, True) + if not fulltype: + logger.warning(f'Parameter signature invalid: {sig}', location=location) + return ParamTuple(sig, None, None, None) + + return ParamTuple(name=name, typ=fulltype, default=default_value, modifiers=modifiers) -def parse_type_signature(sig): - """ Parse a type signature """ - match = TYPE_SIG_RE.match(sig.strip()) +def parse_type_signature(sig: str, location): + """ Parse a type declaration or usage signature """ + match = CLASS_SIG_RE.match(sig.strip()) if not match: - raise RuntimeError('Type signature invalid, got ' + sig) - groups = match.groups() - typ = groups[0] - generic_types = groups[1] - if not generic_types: - generic_types = [] + logger.warning(f'Type signature invalid: {sig}', location=location) + return sig, None, None, None, None + + groups = match.groupdict() + + modifiers = groups['modifiers'] + typ = groups['type'] + generics = groups['generics'] + if not generics: + # In case where input is from doxygen, it is in C++ style + generics = groups['templates'] + inherited_types = groups['inherits'] + array = groups['array'] + ptr = groups['ptr'] + + if not modifiers: + modifiers = [] + else: + modifiers = modifiers.split() + + if not generics: + generics = [] else: - generic_types = split_sig(generic_types[1:-1]) - is_array = (groups[2] is not None) - return typ, generic_types, is_array + # Remove outermost < > brackets + generics = split_sig(generics[1:-1]) + + if not inherited_types: + inherited_types = [] + else: + inherited_types = split_sig(inherited_types) + + if CSDebug.parse_type: + logger.info(f"parsed type: {typ, modifiers, generics, inherited_types, array}") + return typ, modifiers, generics, inherited_types, array, ptr -def parse_attr_signature(sig): +def parse_attr_signature(sig: str, location): """ Parse an attribute signature """ match = ATTR_SIG_RE.match(sig.strip()) if not match: - raise RuntimeError('Attribute signature invalid, got ' + sig) + logger.warning(f'Attribute signature invalid: {sig}', location=location) + return sig, None name, _, params = match.groups() if params is not None and params.strip() != '': params = split_sig(params) - params = [parse_param_signature(x) for x in params] + params = [parse_param_signature(x, location) for x in params] else: params = [] - return (name, params) - - -MSDN_VALUE_TYPES = { - 'string': 'System.String', - 'int': 'System.Int32', - 'long': 'System.Int64', - 'uint': 'System.UInt32', - 'ulong': 'System.UInt64', - 'float': 'System.Single', - 'double': 'System.Double', - 'byte': 'System.Byte', - 'bool': 'System.Boolean' -} - - -MSDN_LINK_MAP = { - 'System.Collections.Generic.List': 'https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1', # noqa # pylint: disable=line-too-long - 'System.Collections.Generic.Dictionary': 'https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2', # noqa # pylint: disable=line-too-long - 'System.Collections.Generic.IList': 'https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ilist-1', # noqa # pylint: disable=line-too-long - 'System.Collections.Generic.IDictionary': 'https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2', # noqa # pylint: disable=line-too-long - 'System.Collections.Generic.ISet': 'https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1', # noqa # pylint: disable=line-too-long - 'System.Collections.Generic.IEnumerable': 'https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1' # noqa # pylint: disable=line-too-long -} - - -def get_msdn_ref(name): - """ Try and create a reference to a type on MSDN """ - in_msdn = False - if name in MSDN_VALUE_TYPES: - name = MSDN_VALUE_TYPES[name] - in_msdn = True - if name.startswith('System.'): - in_msdn = True - if in_msdn: - link = name.split('<')[0] - link = MSDN_LINK_MAP.get(link, link.lower()) - url = '' - if link.startswith('https://'): - url = link - else: - url = 'https://docs.microsoft.com/en-us/dotnet/api/' + link - node = nodes.reference(name, shorten_type(name)) - node['refuri'] = url - node['reftitle'] = name - return node - return None - -SHORTEN_TYPE_PREFIXES = [ - 'System.', - 'System.Collections.Generic.' -] - - -def shorten_type(typ): - """ Shorten a type. E.g. drops 'System.' """ - offset = 0 - for prefix in SHORTEN_TYPE_PREFIXES: - if typ.startswith(prefix): - if len(prefix) > offset: - offset = len(prefix) - return typ[offset:] + if CSDebug.parse_attr: + logger.info(f"parsed attr: {name, params}") + return name, params class CSharpObject(ObjectDescription): @@ -227,16 +306,14 @@ def add_target_and_index(self, name, _, signode): signode['first'] = (not self.names) self.state.document.note_explicit_target(signode) - objects = self.env.domaindata['csharp']['objects'] + objects = self.env.domaindata['cs']['objects'] key = (self.objtype, name) if key in objects: - self.env.warn(self.env.docname, - 'duplicate description of %s %s, ' % - (self.objtype, name) + - 'other instance in ' + - self.env.doc2path(objects[key]), - self.lineno) + logger.warning(f'duplicate description of {self.objtype} {name}, ' + + f'other instance in {self.env.doc2path(objects[key])}', + location=(self.env.docname, self.lineno)) objects[key] = self.env.docname + indextext = self.get_index_text(name) if indextext: self.indexnode['entries'].append( @@ -253,21 +330,21 @@ def before_content(self): lastname = self.names and self.names[-1] if lastname: self.parentname_set = True - self.parentname_saved = self.env.ref_context.get('csharp:parent') - self.env.ref_context['csharp:parent'] = lastname + self.parentname_saved = self.env.ref_context.get('cs:parent') + self.env.ref_context['cs:parent'] = lastname else: self.parentname_set = False def after_content(self): if self.parentname_set: - self.env.ref_context['csharp:parent'] = self.parentname_saved + self.env.ref_context['cs:parent'] = self.parentname_saved def has_parent(self): - return 'csharp:parent' in self.env.ref_context and \ - self.env.ref_context['csharp:parent'] is not None + return 'cs:parent' in self.env.ref_context and \ + self.env.ref_context['cs:parent'] is not None def get_parent(self): - return self.env.ref_context['csharp:parent'] + return self.env.ref_context['cs:parent'] def get_fullname(self, name): fullname = name @@ -280,42 +357,74 @@ def append_modifiers(signode, modifiers): if not modifiers: return for modifier in modifiers: - signode += nodes.emphasis(modifier, modifier) - signode += nodes.Text(u' ') + signode += addnodes.desc_annotation(modifier, modifier) + signode += nodes.Text('\xa0') - def append_type(self, node, typ): - typ, generic_types, is_array = parse_type_signature(typ) + def append_type(self, node, input_typ, ignored_types=None): + """ ignored_types is a list of types to ignore in the generics of this type """ + typ, modifiers, generic_types, inherited_types, array, ptr = parse_type_signature(input_typ, (self.env.docname, self.lineno)) tnode = addnodes.pending_xref( - '', refdomain='csharp', reftype='type', + '', refdomain='cs', reftype='type', reftarget=typ, modname=None, classname=None) + + # Note: this may not be the correct parent namespace if not self.has_parent(): - tnode['csharp:parent'] = None + tnode['cs:parent'] = None else: - tnode['csharp:parent'] = self.get_parent() - tnode += nodes.Text(shorten_type(typ)) + tnode['cs:parent'] = self.get_parent() + + if modifiers: + self.append_modifiers(node, modifiers) + + typ_short = ExternalRefs.shorten_type(typ) + tnode += addnodes.desc_type(typ_short, typ_short) node += tnode + if generic_types: - node += nodes.Text('<') - for i, typ_param in enumerate(generic_types): - self.append_type(node, typ_param) - if i != len(generic_types)-1: - node += nodes.Text(', ') - node += nodes.Text('>') - if is_array: - node += nodes.Text('[]') - - def append_parameters(self, node, params): + self.append_generics(node, generic_types, ignored_types=ignored_types) + if array: + node += nodes.Text(array) + if ptr: + node += nodes.Text(ptr) + + def append_generics(self, node, generics: List[str], nolink=False, ignored_types=None): + """ nolink will disable xref's, use for newly declared generics in a class declaration, + ignore_types is similar, but a list of types to disable xrefs for """ + node += nodes.Text('<') + for i, typ in enumerate(generics): + if nolink or ignored_types and typ in ignored_types: + node += addnodes.desc_type(typ, typ) + else: + self.append_type(node, typ, ignored_types=ignored_types) + if i != len(generics) - 1: + node += nodes.Text(', ') + node += nodes.Text('>') + + def append_inherits(self, node, inherits: List[str]): + """ Adds inherited types, inherits must be a list of string types """ + node += nodes.Text(' : ') + for (i, typ) in enumerate(inherits): + self.append_type(node, typ) + if i != len(inherits) - 1: + node += nodes.Text(', ') + + def append_parameters(self, node, params, ignore_types=None): + if ignore_types is None: + ignore_types = [] pnodes = addnodes.desc_parameterlist() for param in params: pnode = addnodes.desc_parameter('', '', noemph=True) self.append_modifiers(pnode, param.modifiers) - self.append_type(pnode, param.typ) - pnode += nodes.Text(u' ') + if ignore_types and param.typ in ignore_types: + pnode += addnodes.desc_type(param.typ, param.typ) + else: + self.append_type(pnode, param.typ, ignore_types) + pnode += nodes.Text('\xa0') pnode += nodes.emphasis(param.name, param.name) if param.default is not None: - default = u' = ' + param.default + default = ' = ' + param.default pnode += nodes.emphasis(default, default) pnodes += pnode node += pnodes @@ -326,10 +435,10 @@ def append_indexer_parameters(self, node, params): for param in params: if pnodes.children: - pnodes += nodes.Text(u', ') + pnodes += nodes.Text(', ') self.append_type(pnodes, param.typ) - pnodes += nodes.Text(u' ') + pnodes += nodes.Text('\xa0') pnodes += nodes.emphasis(param.name, param.name) pnodes += nodes.Text(']') @@ -349,58 +458,148 @@ def run(self): env = self.state.document.settings.env namespace = self.arguments[0].strip() if namespace == 'None': - env.ref_context.pop('csharp:parent', None) + env.ref_context.pop('cs:parent', None) else: - env.ref_context['csharp:parent'] = namespace + env.ref_context['cs:parent'] = namespace return [] +class CSharpNamespacePlain(CSharpObject): + """ Visual rendering of a C# namespace, + without updating the parent like the directive CSharpCurrentNamespace. + Used by breathe. """ + + def handle_signature(self, sig, signode): + prefix = 'namespace' + ' ' + signode += addnodes.desc_annotation(prefix, prefix) + signode += addnodes.desc_name(sig, sig) + + return sig + + class CSharpClass(CSharpObject): """ Description of a C# class """ - def handle_signature(self, sig, signode): - typ, _, _ = parse_type_signature(sig) - desc_name = 'class %s' % sig - signode += addnodes.desc_name(desc_name, desc_name) + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + typ, modifiers, generics, inherits, _, _ = parse_type_signature(sig, (self.env.docname, self.lineno)) + + if modifiers: + self.append_modifiers(signode, modifiers) + + prefix = 'class' + ' ' + signode += addnodes.desc_annotation(prefix, prefix) + signode += addnodes.desc_name(typ, typ) + + if generics: + self.append_generics(signode, generics, nolink=True) + if inherits: + self.append_inherits(signode, inherits) + return self.get_fullname(typ) + + +class CSharpStruct(CSharpObject): + """ Description of a C# struct """ + + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + typ, modifiers, generics, inherits, _, _ = parse_type_signature(sig, (self.env.docname, self.lineno)) + + if modifiers: + self.append_modifiers(signode, modifiers) + + prefix = 'struct' + ' ' + signode += addnodes.desc_annotation(prefix, prefix) + signode += addnodes.desc_name(typ, typ) + + if generics: + self.append_generics(signode, generics, nolink=True) + if inherits: + self.append_inherits(signode, inherits) + return self.get_fullname(typ) + + +class CSharpInterface(CSharpObject): + """ Description of a C# interface """ + + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + typ, modifiers, generics, inherits, _, _ = parse_type_signature(sig, (self.env.docname, self.lineno)) + + if modifiers: + self.append_modifiers(signode, modifiers) + + prefix = 'interface' + ' ' + signode += addnodes.desc_annotation(prefix, prefix) + signode += addnodes.desc_name(typ, typ) + + if generics: + self.append_generics(signode, generics, nolink=True) + if inherits: + self.append_inherits(signode, inherits) return self.get_fullname(typ) class CSharpInherits(CSharpObject): - """ Description of an inherited C# class """ + """ Description of an inherited C# struct """ - def handle_signature(self, sig, signode): - typ, _, _ = parse_type_signature(sig) - signode += nodes.Text(': ') + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + signode += nodes.Text(' : ') self.append_type(signode, sig) - return self.get_fullname(typ) + return self.get_fullname(sig) class CSharpMethod(CSharpObject): """ Description of a C# method """ - def handle_signature(self, sig, signode): - modifiers, typ, name, \ - generic_types, params = parse_method_signature(sig) + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + modifiers, return_type, name, generic_params, params = parse_method_signature(sig, (self.env.docname, self.lineno)) + self.append_modifiers(signode, modifiers) + + # note: constructors don't have a return type + if return_type is not None: + # Dont link if its a generic type + if generic_params and return_type in generic_params: + signode += addnodes.desc_type(return_type, return_type) + else: + self.append_type(signode, return_type) + signode += nodes.Text('\xa0') + + signode += addnodes.desc_name(name, name) + + if generic_params: + self.append_generics(signode, generic_params, True) + signode += nodes.Text('\xa0') + + self.append_parameters(signode, params, generic_params) + + return self.get_fullname(name) + + +class CSharpVariable(CSharpObject): + """ Description of a C# variable """ + + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + modifiers, fulltype, _, _, name, default_value = parse_variable_signature(sig, (self.env.docname, self.lineno)) + self.append_modifiers(signode, modifiers) - if typ is not None: - self.append_type(signode, typ) - signode += nodes.Text(' ') + self.append_type(signode, fulltype) + signode += nodes.Text('\xa0') signode += addnodes.desc_name(name, name) - if generic_types is not None: - signode += nodes.Text(generic_types) - signode += nodes.Text(' ') - self.append_parameters(signode, params) + + if default_value: + signode += nodes.Text(' = ') + signode += nodes.Text(default_value) + return self.get_fullname(name) class CSharpProperty(CSharpObject): """ Description of a C# property """ - def handle_signature(self, sig, signode): - modifiers, typ, name, getter, setter = parse_property_signature(sig) + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + modifiers, typ, name, getter, setter, default_val = parse_property_signature(sig, (self.env.docname, self.lineno)) + self.append_modifiers(signode, modifiers) self.append_type(signode, typ) - signode += nodes.Text(' ') + signode += nodes.Text('\xa0') signode += addnodes.desc_name(name, name) signode += nodes.Text(' { ') extra = [] @@ -411,17 +610,41 @@ def handle_signature(self, sig, signode): extra_str = ' '.join(extra) signode += addnodes.desc_annotation(extra_str, extra_str) signode += nodes.Text(' }') + if default_val is not None: + signode += nodes.Text(' = ' + default_val) + return self.get_fullname(name) + + +class CSharpEvent(CSharpObject): + """ Description of a C# event """ + + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + # Remove namespace for now, I think events are not yet supported by breathe? + modifiers, fulltype, _, _, name, default_value = parse_variable_signature(sig, (self.env.docname, self.lineno)) + + prefix = 'event' + ' ' + signode += addnodes.desc_annotation(prefix, prefix) + + self.append_modifiers(signode, modifiers) + self.append_type(signode, fulltype) + signode += nodes.Text('\xa0') + signode += addnodes.desc_name(name, name) + + if default_value: + signode += nodes.Text(' = ') + signode += nodes.Text(default_value) + return self.get_fullname(name) class CSharpIndexer(CSharpObject): """ Description of a C# indexer """ - def handle_signature(self, sig, signode): - modifiers, typ, params, getter, setter = parse_indexer_signature(sig) + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + modifiers, typ, params, getter, setter = parse_indexer_signature(sig, (self.env.docname, self.lineno)) self.append_modifiers(signode, modifiers) self.append_type(signode, typ) - signode += nodes.Text(' ') + signode += nodes.Text('\xa0') signode += addnodes.desc_name('this[]', 'this') self.append_indexer_parameters(signode, params) signode += nodes.Text(' { ') @@ -439,16 +662,17 @@ def handle_signature(self, sig, signode): class CSharpEnum(CSharpObject): """ Description of a C# enum """ - def handle_signature(self, sig, signode): - desc_name = 'enum %s' % sig - signode += addnodes.desc_name(desc_name, desc_name) + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + prefix = 'enum' + ' ' + signode += addnodes.desc_annotation(prefix, prefix) + signode += addnodes.desc_name(sig, sig) return self.get_fullname(sig) class CSharpEnumValue(CSharpObject): """ Description of a C# enum value """ - def handle_signature(self, sig, signode): + def handle_signature(self, sig: str, signode: addnodes.desc_signature): name = sig signode += addnodes.desc_name(name, name) return self.get_fullname(name) @@ -457,59 +681,114 @@ def handle_signature(self, sig, signode): class CSharpAttribute(CSharpObject): """ Description of a C# attribute """ - def handle_signature(self, sig, signode): - name, params = parse_attr_signature(sig) + def handle_signature(self, sig: str, signode: addnodes.desc_signature): + name, params = parse_attr_signature(sig, (self.env.docname, self.lineno)) signode += addnodes.desc_name(name, name) if params: - signode += nodes.Text(' ') + signode += nodes.Text('\xa0') self.append_parameters(signode, params) return self.get_fullname(name) class CSharpXRefRole(XRefRole): def process_link(self, env, refnode, has_explicit_title, title, target): - refnode['csharp:parent'] = env.ref_context.get('csharp:parent') + refnode['cs:parent'] = env.ref_context.get('cs:parent') return super(CSharpXRefRole, self).process_link( env, refnode, has_explicit_title, title, target) class CSharpDomain(Domain): """ C# domain """ - name = 'csharp' + name = 'cs' label = 'C#' + # role to object type map object_types = { - 'class': ObjType(_('class'), 'type'), - 'method': ObjType(_('method'), 'meth'), - 'property': ObjType(_('property'), 'prop'), - 'enum': ObjType(_('enum'), 'type'), - 'value': ObjType(_('value'), 'enum'), - 'attribute': ObjType(_('attribute'), 'attr'), - 'indexer': ObjType(_('indexer'), 'idxr'), + # 'role': ObjType + 'namespace' : ObjType(_('namespace'), 'namespace'), + + # Types + 'class' : ObjType(_('class'), 'class', 'type'), + 'struct' : ObjType(_('struct'), 'struct', 'type'), + 'interface' : ObjType(_('interface'), 'interface', 'type'), + 'enum' : ObjType(_('enum'), 'enum', 'type'), + + 'function' : ObjType(_('function'), 'function', 'func', 'meth', 'member'), + # 'method' : ObjType(_('method'), 'meth'), + + 'var' : ObjType(_('var'), 'var', 'member'), + 'property' : ObjType(_('property'), 'prop', 'member'), + 'event' : ObjType(_('event'), 'event', 'member'), + # 'member' : ObjType(_('member'), 'member', 'var'), + + 'enumerator': ObjType(_('enumerator'), 'enumerator'), + 'attribute' : ObjType(_('attribute'), 'attr'), + 'indexer' : ObjType(_('indexer'), 'idxr'), } directives = { - 'namespace': CSharpCurrentNamespace, - 'class': CSharpClass, - 'inherits': CSharpInherits, - 'method': CSharpMethod, - 'property': CSharpProperty, - 'enum': CSharpEnum, - 'value': CSharpEnumValue, - 'attribute': CSharpAttribute, - 'indexer': CSharpIndexer, + 'namespace' : CSharpCurrentNamespace, + + 'class' : CSharpClass, + 'struct' : CSharpStruct, + 'interface' : CSharpInterface, + 'inherits' : CSharpInherits, + + 'function' : CSharpMethod, + # 'method' : CSharpMethod, + + 'var' : CSharpVariable, + 'property' : CSharpProperty, + 'event' : CSharpEvent, + # 'member' : CSharpVariable, + + 'enum' : CSharpEnum, + 'enumerator': CSharpEnumValue, + 'attribute' : CSharpAttribute, + 'indexer' : CSharpIndexer, } + # See https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html roles = { - 'type': CSharpXRefRole(), - 'meth': CSharpXRefRole(), - 'prop': CSharpXRefRole(), - 'enum': CSharpXRefRole(), - 'attr': CSharpXRefRole(), - 'idxr': CSharpXRefRole(), + # 'key, rst to write a reference': 'type of reference' + 'namespace' : CSharpXRefRole(), + + 'class' : CSharpXRefRole(), + 'struct' : CSharpXRefRole(), + 'interface' : CSharpXRefRole(), + + 'func' : CSharpXRefRole(), + 'meth' : CSharpXRefRole(), + + 'var' : CSharpXRefRole(), + 'prop' : CSharpXRefRole(), + 'event' : CSharpXRefRole(), + 'member' : CSharpXRefRole(), + + 'enum' : CSharpXRefRole(), + 'enumerator': CSharpXRefRole(), + 'value' : CSharpXRefRole(), + 'attr' : CSharpXRefRole(), + 'idxr' : CSharpXRefRole(), + + 'type' : CSharpXRefRole(), + 'ref' : CSharpXRefRole(), } initial_data = { 'objects': {}, # fullname -> docname, objtype } + # noinspection PyUnusedLocal + @staticmethod + def apply_config(app: "Sphinx", config: Config) -> None: + """ Read in the config variables, called once the config is initialized (this is a callback) """ + + try: + CSDebug.set_config_values(config) + ExternalRefs.apply_config(config) + except Exception as e: + # Manually print the error here as sphinx does not do it for ExtensionErrors + logger.error(f"Error in CSharpDomain.apply_config(): {e}, \nCheck that your config variables are correct.") + raise + def clear_doc(self, docname): for (typ, name), doc in dict(self.data['objects']).items(): if doc == docname: @@ -517,27 +796,100 @@ def clear_doc(self, docname): def resolve_xref(self, _, fromdocname, builder, typ, target, node, contnode): - targets = [target] - if node['csharp:parent'] is not None: - parts = node['csharp:parent'].split('.') + targets = [] + parents = [] + # Search in this namespace, note parent may not be where the target resides + if node.get('cs:parent') is not None: + parts = node['cs:parent'].split('.') while parts: targets.append('.'.join(parts)+'.'+target) + parents.append('.'.join(parts)) parts = parts[:-1] - objects = self.data['objects'] + # By adding this last we ensure the list targets is sorted by decreasing string length + targets.append(target) + parents.append('') + + if target is None: + # Fallback to contnode text if the target is None, the case for xrefs created by breathe inside docreftext + target = contnode.astext() + + # Get all objects that end with the initial target objtypes = self.objtypes_for_role(typ) + objects = {key: val for (key, val) in self.data['objects'].items() + # Filter by objtype and check that we end with the target + if key[0] in objtypes and key[1].endswith(target) and + # that the character before the target is a namespace separator or nothing + (len(key[1]) == len(target) or key[1][:-len(target)][-1] == '.')} + + # 1. Found only one item that ends with the target, use this one + if len(objects) == 1: + objtype, tgt = next(iter(objects.keys())) + return make_refnode(builder, fromdocname, + objects[objtype, tgt], + objtype + '-' + tgt, + contnode, (self.label + ' ' if ExternalRefs.multi_lang else '') + f'{objtype}: {tgt}') + + # 2. Search recognized built-in/external override types first, e.g. float, bool, void + # (currently also all other external types) + for tgt in targets: + if ExternalRefs.check_ignored_ref(tgt): + return None + + # 3. Found no local objects that match + if len(objects) == 0: + # 3b Look externally + ref = ExternalRefs.get_external_ref(target, typ) + if ref is not None: + return ref + logger.warning(f"Failed to find xref for: {target}, no objects found that end like this, " + f"searched in object types: {objtypes}", location=node) + # f", filter1: {[i for i in self.data['objects'] if i[1].endswith(target)]}" + # f", filter2: {[i for i in self.data['objects'] if i[0] in objtypes]}") + if CSDebug.xref and not CSDebug.has_printed_xref_objects: + CSDebug.has_printed_xref_objects = True + logger.warning(f"all xref objects: {self.data['objects']}", location=node) + return None + + # 4. Search inside this namespace and its direct parents for tgt in targets: for objtype in objtypes: if (objtype, tgt) in objects: return make_refnode(builder, fromdocname, objects[objtype, tgt], objtype + '-' + tgt, - contnode, tgt + ' ' + objtype) + contnode, (self.label + ' ' if ExternalRefs.multi_lang else '') + f'{objtype}: {tgt}') + + # 5. Search in other namespaces by closest match starting at the parent namespace + if len(objects) > 1: + logger.warning(f"Ambiguous reference to {target}, potential matches: {objects}", location=node) + + # Get closest to the parent namespace + for parent in parents: + matches = [i for i in objects if i[0][1].startswith(parent)] + if len(matches) >= 1: + match_objtype, match_tgt = matches[0] + + if CSDebug.xref: + logger.info(f"Success finding xref for {target}, closest match: {match_objtype}, {match_tgt}, " + f"matches: {len(matches)}", location=node) + + return make_refnode(builder, fromdocname, + objects[match_objtype, match_tgt], + match_objtype + '-' + match_tgt, + contnode, (self.label + ' ' if ExternalRefs.multi_lang else '') + f'{match_objtype}: {match_tgt}') + + # 6. Look externally + ref = ExternalRefs.get_external_ref(target, typ) + if ref is not None: + return ref + + logger.warning(f"Failed to find xref for: {targets}, searched in object types: {objtypes}, parents: {parents}", + location=node) + if CSDebug.xref and not CSDebug.has_printed_xref_objects: + CSDebug.has_printed_xref_objects = False + logger.warning(f"all xref objects: {objects}", location=node) - for tgt in targets: - ref = get_msdn_ref(tgt) - if ref is not None: - return ref return None def get_objects(self): @@ -551,7 +903,3 @@ def merge_domaindata(self, docnames, otherdata): def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode): raise NotImplementedError - - -def setup(app): - app.add_domain(CSharpDomain) diff --git a/sphinx_csharp/debug.py b/sphinx_csharp/debug.py new file mode 100644 index 0000000..8008fa2 --- /dev/null +++ b/sphinx_csharp/debug.py @@ -0,0 +1,46 @@ +class CSDebug: + """ Contains all debug variables for sphinx_csharp """ + + # Config Flags + all = False + parse = False + parse_func = False + parse_var = False + parse_prop = False + parse_attr = False + parse_idxr = False + parse_type = False + xref = False + ext_links = False + + # State related + has_printed_test_links = False + has_printed_xref_objects = False + + @classmethod + def add_config_values(cls, app): + """ Register the config values and set default values """ + app.add_config_value('sphinx_csharp_debug', False, '') + app.add_config_value('sphinx_csharp_debug_parse', False, '') + app.add_config_value('sphinx_csharp_debug_parse_func', False, '') + app.add_config_value('sphinx_csharp_debug_parse_var', False, '') + app.add_config_value('sphinx_csharp_debug_parse_prop', False, '') + app.add_config_value('sphinx_csharp_debug_parse_attr', False, '') + app.add_config_value('sphinx_csharp_debug_parse_idxr', False, '') + app.add_config_value('sphinx_csharp_debug_parse_type', False, '') + app.add_config_value('sphinx_csharp_debug_xref', False, '') + app.add_config_value('sphinx_csharp_debug_ext_links', False, '') + + @classmethod + def set_config_values(cls, config): + """ Initialize debug options from the config """ + cls.all = config['sphinx_csharp_debug'] + cls.parse = cls.all or config['sphinx_csharp_debug_parse'] + cls.parse_func = cls.all or cls.parse or config['sphinx_csharp_debug_parse_func'] + cls.parse_var = cls.all or cls.parse or config['sphinx_csharp_debug_parse_var'] + cls.parse_prop = cls.all or cls.parse or config['sphinx_csharp_debug_parse_prop'] + cls.parse_attr = cls.all or cls.parse or config['sphinx_csharp_debug_parse_attr'] + cls.parse_idxr = cls.all or cls.parse or config['sphinx_csharp_debug_parse_idxr'] + cls.parse_type = cls.all or cls.parse or config['sphinx_csharp_debug_parse_type'] + cls.xref = cls.all or config['sphinx_csharp_debug_xref'] + cls.ext_links = cls.all or config['sphinx_csharp_debug_ext_links'] diff --git a/sphinx_csharp/extrefs.py b/sphinx_csharp/extrefs.py new file mode 100644 index 0000000..4568d6b --- /dev/null +++ b/sphinx_csharp/extrefs.py @@ -0,0 +1,180 @@ +from .debug import CSDebug +from .extrefs_data import ExternalRefsData +import requests +from typing import cast +from sphinx.config import Config +from sphinx.util import logging +from docutils import nodes + +logger = logging.getLogger(__name__) + + +class ExternalRefs: + """ Resolves links to external non-sphinx documentation, e.g. MSDN or Unity. + All data is stored in a separate file in the class ExternalRefsData """ + + extlink_cache = {} + test_links = False + multi_lang = False + + @classmethod + def apply_config(cls, config: Config): + """ Read in the config variables and merge them with the defaults """ + + cls.test_links = config['sphinx_csharp_test_links'] + cls.multi_lang = config['sphinx_csharp_multi_language'] + + # *Merge* config values with the default values + if config['sphinx_csharp_shorten_type_prefixes'] is not None: + ExternalRefsData.shorten_type_prefixes += config['sphinx_csharp_shorten_type_prefixes'] + + if config['sphinx_csharp_ignore_xref'] is not None: + ExternalRefsData.ignore_xref_types += config['sphinx_csharp_ignore_xref'] + + if config['sphinx_csharp_external_type_rename'] is not None: + ExternalRefsData.external_type_rename.update(config['sphinx_csharp_external_type_rename']) + + if config['sphinx_csharp_ext_search_pages'] is not None: + ExternalRefsData.external_search_pages.update(config['sphinx_csharp_ext_search_pages']) + + if config['sphinx_csharp_ext_type_map'] is not None: + a = ExternalRefsData.external_type_map + b = cast(type(a), config['sphinx_csharp_ext_type_map']) + + # Merge keys in both + for pkg in set(b).intersection(a): + # Add new namespaces + for ns in set(b[pkg]).difference(a[pkg]): + a[pkg][ns] = b[pkg][ns].copy() + + # Concat lists for existing namespaces + for ns in set(b[pkg]).intersection(a[pkg]): + a[pkg][ns] += b[pkg][ns] + + # Add new keys + for pkg in set(b).difference(a): + a[pkg] = b[pkg].copy() + + # logger.info(f"merged external_type_map: {CSharpDomain.external_type_map}") + + @classmethod + def check_ignored_ref(cls, name: str) -> bool: + """ Checks if the target is a built-in type or other ignored strings """ + return name in ExternalRefsData.ignore_xref_types + + @classmethod + def shorten_type(cls, typ: str) -> str: + """ Shorten a type. E.g. drops 'System.' """ + # Find largest prefix that matches + offset = 0 + for prefix in ExternalRefsData.shorten_type_prefixes: + if typ.startswith(prefix): + if len(prefix) > offset: + offset = len(prefix) + + # remove trailing dot + if typ[offset] == '.': + offset += 1 + return typ[offset:] + + @classmethod + def get_external_ref(cls, name: str, objtype: str) -> nodes: + """ + Looks in the predefined external targets and adds the link if it is found + returns: None if unsuccessful + """ + input_name = name + + def create_node(fullname: str, name: str, url: str) -> nodes: + """ Small local helper function """ + node = nodes.reference(fullname, name) + node['refuri'] = url + node['reftitle'] = ('C# ' if cls.multi_lang else '') + f'{objtype}: {fullname}' + + return node + + # Use existing link if we have already determined it, for performance + if name in cls.extlink_cache: + if CSDebug.ext_links: + logger.info(f"found in extlink_cache for {name}") + return create_node(cls.extlink_cache[input_name][0], + cls.extlink_cache[input_name][1], + cls.extlink_cache[input_name][2]) + + # Start search in the ExternalRefsData.external_type_map + fullname = name + name_split = name.rsplit('.', 1) + if len(name_split) == 2: + # We also have the namespace in the name + parent, name = name_split + matches = [(pkg, namespace) for pkg in ExternalRefsData.external_type_map + for namespace in ExternalRefsData.external_type_map[pkg] + if name in ExternalRefsData.external_type_map[pkg][namespace] + and namespace.endswith(parent)] + if len(matches) > 1: + # Enforce exact match if there are several + matches_strict = [i for i in matches if i[1] == parent] + if len(matches_strict) >= 1: + matches = matches_strict + else: + # search all namespaces + parent = None + matches = [(pkg, namespace) for pkg in ExternalRefsData.external_type_map + for namespace in ExternalRefsData.external_type_map[pkg] + if name in ExternalRefsData.external_type_map[pkg][namespace]] + + if not matches: + return None + + if len(matches) > 1: + logger.warning(f"ambiguous external reference for '{fullname}' using first, " + f"found matches: {matches}") + + pkg, parent = matches[0] + + link_name = name + if name in ExternalRefsData.external_type_rename: + link_name = ExternalRefsData.external_type_rename[name] + + if parent: + # Skip for empty strings + link_name = f'{parent}.{link_name}' + fullname = f'{pkg} ~> {parent}.{name}' + else: + fullname = f'{pkg} ~> {name}' + + try: + apilink = ExternalRefsData.external_search_pages[pkg][0] % link_name + except KeyError: + logger.warning( + f"external links package does not have any links set in EXTERNAL_SEARCH_PAGES, package: {pkg}, " + f"target fullname: {fullname}") + return None + + apilink_status_code = 0 + if cls.test_links: + if not CSDebug.has_printed_test_links: + CSDebug.has_printed_test_links = True + logger.info("csharp: external link testing is enabled") + try: + apilink_status_code = requests.get(apilink, timeout=3).status_code + except (requests.exceptions.ConnectionError, requests.exceptions.Timeout): + cls.test_links = False + + if not cls.test_links or apilink_status_code < 400: + url = apilink + else: + # Use search link or homepage instead + logger.warning(f"invalid API link, using fallback, " + f"status_code={apilink_status_code}, apilink={apilink}") + url = ExternalRefsData.external_search_pages[pkg][1] % link_name + + name = cls.shorten_type(name) + node = create_node(fullname, name, url) + + # Store result in cache dict + cls.extlink_cache[input_name] = fullname, name, url + + if CSDebug.ext_links: + logger.info(f"found external link: {input_name, fullname, name, url}") + return node diff --git a/sphinx_csharp/extrefs_data.py b/sphinx_csharp/extrefs_data.py new file mode 100644 index 0000000..ccd3d49 --- /dev/null +++ b/sphinx_csharp/extrefs_data.py @@ -0,0 +1,91 @@ +class ExternalRefsData: + """ This class just holds data used for external linking. Keeps data separate from functionality """ + + shorten_type_prefixes = [ + 'System.', + 'System.IO', + 'System.Collections.Generic.', + ] + + """ Types and strings to ignore when looking for a reference """ + ignore_xref_types = [ + '*', + '&', + 'void', + + # Built-in types + 'string', + 'bool', + 'int', + 'long', + 'uint', + 'ulong', + 'float', + 'double', + 'byte', + 'object', + ] + + """ + Contains recognised types and their namespaces as well as the package name. + The package name references the key in external_search_pages + + Format the content like this: + Where Namespace1 is the namespace for the link (which may not match the real namespace):: + + 'package': { + 'Namespace1': ['member1', ...], + ... + }, + ... + """ + external_type_map = { + 'msdn': { + 'System': ['Tuple', 'IDisposable', 'ICloneable', 'IComparable', 'Func', 'Action'], + 'System.Collections': ['IEnumerator'], + 'System.Collections.Generic': ['List', 'Dictionary', 'IList', 'IDictionary', 'ISet', 'IEnumerable'], + 'System.IO': ['FileFormatException'], + 'System.Threading': ['Thread'], + 'System.Runtime.InteropServices': ['GCHandle', 'Marshal'], + }, + 'unity': { + '': ['MonoBehaviour', 'ScriptableObject', + 'GameObject', 'Transform', 'RectTransform', + 'Mesh', 'MeshRenderer', 'MeshFilter', 'Animator', + 'Collider', 'SphereCollider', 'BoxCollider', + 'Material', 'Sprite', + 'Vector2', 'Vector3', 'Vector4', 'Quaternion', 'Color', 'Gradient', + 'Coroutine', 'Space', 'LayerMask', 'Layer', + 'AssetPostprocessor', + ], + }, + } + + """ + Put special cases in here that should be renamed when used in links, use it for generics + The name is swapped *after* searching EXTERNAL_TYPE_MAP, just before constructing the url link + """ + external_type_rename = { + 'List': 'List-1', + 'Dictionary': 'Dictionary-2', + 'IList': 'IList-1', + 'IDictionary': 'IDictionary-2', + 'ISet': 'ISet-2', + 'IEnumerable': 'IEnumerable-1', + 'Func': 'Func-1', + } + + """ + Where do we search for api documentation + Syntax: + 'package': ('api link', 'fallback search link') + Use %s for where to substitute item, every link *must* contain this + """ + external_search_pages = { + 'msdn': ('https://docs.microsoft.com/en-us/dotnet/api/%s', + 'https://docs.microsoft.com/en-us/search/?category=All&scope=.NET&terms=%s'), + 'unity': ('https://docs.unity3d.com/ScriptReference/%s.html', + 'https://docs.unity3d.com/ScriptReference/30_search.html?q=%s'), + 'unityman': ('https://docs.unity3d.com/Manual/%s.html', + 'https://docs.unity3d.com/Manual/30_search.html?q=%s'), + } diff --git a/test/basic/build.sh b/test/basic/build.sh new file mode 100644 index 0000000..4dcca25 --- /dev/null +++ b/test/basic/build.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +sphinx-build . _build \ No newline at end of file diff --git a/test/basic/conf.py b/test/basic/conf.py new file mode 100644 index 0000000..e6fb9ae --- /dev/null +++ b/test/basic/conf.py @@ -0,0 +1,22 @@ +project = 'C# Examples' +version = '' +release = '0.1' +copyright = '2015-2016, djungelorm' + +master_doc = 'index' +source_suffix = '.rst' +extensions = ['sphinx_csharp'] + +pygments_style = 'sphinx' + +# Debug options +sphinx_csharp_debug = False +sphinx_csharp_debug_parse = False +sphinx_csharp_debug_parse_func = False +sphinx_csharp_debug_parse_var = False +sphinx_csharp_debug_parse_prop = False +sphinx_csharp_debug_parse_attr = False +sphinx_csharp_debug_parse_idxr = False +sphinx_csharp_debug_parse_type = False +sphinx_csharp_debug_xref = False +sphinx_csharp_debug_ext_links = False diff --git a/test/index.rst b/test/basic/index.rst similarity index 54% rename from test/index.rst rename to test/basic/index.rst index ffd9b56..13285d4 100644 --- a/test/index.rst +++ b/test/basic/index.rst @@ -1,4 +1,4 @@ -.. default-domain:: csharp +.. default-domain:: cs .. namespace:: MyNamespace @@ -6,59 +6,68 @@ .. inherits:: System.Collections.Generic.IList .. inherits:: System.IDisposable + .. inherits:: System.IO.FileFormatException This is a class with methods and properties. Here are some references to it's methods and properties: - * :meth:`MyClass.MyMethod` - * :meth:`MyMethod` + * :func:`MyClass.MyMethod` + * :func:`MyMethod` * :prop:`MyClass.MyProperty` * :prop:`MyProperty` - .. method:: MyClass (string a, int b = 1, float c = 2.3) + .. function:: MyClass (string a, int b = 1, float c = 2.3) A constructor for the class. - .. method:: void MyMethod (string arg) + .. function:: void MyMethod (string arg) A method with a single argument. And a reference back to the containing class :type:`MyClass` - .. method:: void MyMethodDefaultArg (string arg = "foo") + .. function:: void MyMethodDefaultArg (string arg = "foo") A method with a default argument value. - .. method:: void MyMethodDefaultArgs (int x, bool y = true, List arg = [ "foo", "bar", "baz" ], bool z = false) + .. function:: void MyMethodDefaultArgs (int x, bool y = true, List arg = [ "foo", "bar", "baz" ], bool z = false) A method with default argument values. - .. method:: void MyMethodNoArgs () + .. function:: void MyMethodNoArgs () A method with no arguments. - .. method:: void MyMethodTemplatedArg (System.Collections.Generic.IDictionary arg) + .. function:: void MyMethodTemplatedArg (System.Collections.Generic.IDictionary arg) A method with a templated argument. - .. method:: MyClass MyMethodClass (MyClass arg) + .. function:: void MyMethodTwoDArrayArg (int[][] arg) + + A method with two-dimensional array argument. + + .. function:: int[][] MyMethod2DArrayReturn () + + A method returning a two-dimensional array + + .. function:: MyClass MyMethodClass (MyClass arg) A method with a class as the parameter and return types. - .. method:: MyEnum MyMethodEnum (MyEnum arg) + .. function:: MyEnum MyMethodEnum (MyEnum arg) A method with an enum as the parameter and return types. - .. method:: static int MyStaticMethod (int arg) + .. function:: static int MyStaticMethod (int arg) A static method. - .. method:: int MyMethodHasParamModifiers(ref int arg0, params int[] arg1) + .. function:: int MyMethodHasParamModifiers(ref int arg0, params int[] arg1) A method with a parameter modifier. - .. method:: public static MyMethodHasMultiModifiers() + .. function:: public static MyMethodHasMultiModifiers() A method with multiple method modifiers. @@ -110,7 +119,7 @@ .. indexer:: string this[int i, MyClass j] { get; set; } - .. method:: T AGenericMethod (int x) + .. function:: T AGenericMethod (int x) .. property:: System.Tuple ATupleProperty { get; set; } @@ -118,18 +127,18 @@ This is an enum. - .. value:: Foo + .. enumerator:: Foo An enumerator value. - .. value:: Bar - .. value:: Baz + .. enumerator:: Bar + .. enumerator:: Baz .. class:: MyGenericClass - .. method:: void AMethod() + .. function:: void AMethod() - .. method:: T AGenericMethod (int x) + .. function:: T AGenericMethod (int x) .. attribute:: MyAttribute1 @@ -139,24 +148,65 @@ Another attribute. -Class ref :type:`MyClass` +References +---------- + +Type ref :type:`MyClass` + +Class ref :class:`MyClass` -Method ref: :meth:`MyClass.MyMethod` +Class ref :class:`MyClass2` + +Struct ref :struct:`MyStruct` + +Interface ref :interface:`MyInterface` + +Method ref: :func:`MyClass.MyMethod` Property ref: :prop:`MyClass.MyProperty` Enum ref :type:`MyEnum` -Enum value ref :enum:`MyEnum.Foo` +Enum value ref :enumerator:`MyEnum.Foo` Generic class ref :type:`MyGenericClass` -Generic method ref :meth:`MyClass.AGenericMethod` +Generic method ref :func:`MyClass.AGenericMethod` -Generic method in generic class ref :meth:`MyGenericClass.AGenericMethod` +Generic method in generic class ref :func:`MyGenericClass.AGenericMethod` Attribute ref :attr:`MyAttribute1` Attribute ref :attr:`MyAttribute2` Indexer ref :idxr:`MyClass.this[]` + + +More Tests +---------- + +.. namespace:: OtherNamespace + +.. struct:: public MyStruct < T, U > : IList +.. interface:: public MyInterface < T, U > : IList + +.. namespace:: OtherNamespace.Subspace + + +.. class:: public unsafe MyClass2 < T , U > : Dictionary, MyInterface + + .. function:: public MyStruct MyFunc ( ref int a = 3, float b, ref GameObject c, ref List < GameObject > d = default) + + .. var:: private int a = 0 + + .. var:: private MyEnum a = MyEnum.Bar + + .. var:: private static const List < MyInterface > GenericVar + + .. var:: private static const List < MyInterface > TwoGenericBrackets = new List < MyInterface > () + + .. function:: private List < MyInterface > GenericsGaloreFunc (ref List a = default, List < MyInterface > b = default) + + .. function:: private T ReturnGeneric < T, U > (int a = 0) + +.. function:: (MyStruct, MyClass2) tupleFunc((MyStruct, MyClass2) a) diff --git a/test/breathe/Doxyfile b/test/breathe/Doxyfile new file mode 100644 index 0000000..0f521dd --- /dev/null +++ b/test/breathe/Doxyfile @@ -0,0 +1,2582 @@ +# Doxyfile 1.8.18 + +# 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 configuration +# 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 +# https://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 = "Breathe Test" + +# 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 = _doxygen + +# 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 + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# 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 JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = 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 (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# 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 + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = 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, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# 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). 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 https://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 the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# 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: +# https://www.riverbankcomputing.com/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 + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = 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_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = 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 +# 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 +# (including Cygwin) ands 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 HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= 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 ... \endif and \cond +# ... \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 https://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. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = 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. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = cs + +# 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: https://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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# 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 (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +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 \ + *.doc \ + *.txt \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# 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: +# +# +# +# where is the value of the INPUT_FILTER tag, and 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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +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 +# entity 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 https://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 configuration 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 + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be passed to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# 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 style sheet files is of importance (e.g. the last +# style sheet 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 style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://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 YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = 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: https://developer.apple.com/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 https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.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: https://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: https://doc.qt.io/archives/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: https://doc.qt.io/archives/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: https://doc.qt.io/archives/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: https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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 style sheets (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 + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png The default and svg Looks nicer but requires the +# pdf2svg tool. +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# 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_TRANSPARENT 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 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://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 https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 + +# 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 + S +# (what the is depends on the OS and browser, but it is typically +# , /