├── requirements.txt ├── src └── discord_bot │ ├── cogs │ ├── __init__.py │ ├── misc.py │ └── help.py │ ├── version.py │ ├── __init__.py │ ├── log_setup.py │ ├── utils │ └── utils.py │ ├── environment.py │ └── main.py ├── MANIFEST.in ├── setup.py ├── README.md ├── .gitignore └── Doxyfile /requirements.txt: -------------------------------------------------------------------------------- 1 | discord.py~=2.0 -------------------------------------------------------------------------------- /src/discord_bot/cogs/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/discord_bot/version.py: -------------------------------------------------------------------------------- 1 | VERSION = "3.0.0" 2 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE.txt 2 | 3 | include setup.py 4 | -------------------------------------------------------------------------------- /src/discord_bot/__init__.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | if __package__ is None and not hasattr(sys, "frozen"): 4 | import os.path 5 | 6 | path = os.path.realpath(os.path.abspath(__file__)) 7 | sys.path.insert(0, os.path.dirname(os.path.dirname(path))) 8 | 9 | from discord_bot.main import start_bot 10 | from discord_bot.version import VERSION 11 | 12 | # this version will be read by setup.py and the bot itself 13 | __version__ = VERSION 14 | 15 | 16 | def main(): 17 | start_bot() 18 | 19 | if __name__ == '__main__': 20 | main() 21 | -------------------------------------------------------------------------------- /src/discord_bot/log_setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | import logging 3 | 4 | ### @package log_setup 5 | # 6 | # Setup of logging 7 | # 8 | 9 | # path for databases or config files 10 | if not os.path.exists('data/'): 11 | os.mkdir('data/') 12 | 13 | # set logging format 14 | formatter = logging.Formatter("[{asctime}] [{levelname}] [{module}.{funcName}] {message}", style="{") 15 | 16 | # logger for writing to file 17 | file_logger = logging.FileHandler('data/events.log') 18 | file_logger.setFormatter(formatter) 19 | 20 | # logger for console prints 21 | console_logger = logging.StreamHandler() 22 | console_logger.setFormatter(formatter) 23 | 24 | # get new logger 25 | logger = logging.getLogger('my-bot') 26 | logger.setLevel(logging.INFO) 27 | 28 | # register loggers 29 | logger.addHandler(file_logger) 30 | logger.addHandler(console_logger) # discord handles this logger 31 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import re 2 | 3 | from setuptools import setup, find_packages 4 | import pathlib 5 | 6 | here = pathlib.Path(__file__).parent.resolve() 7 | 8 | # Get the long description from the README file 9 | long_description = (here / 'README.md').read_text(encoding='utf-8') 10 | with open(here / "requirements.txt", "r") as f: 11 | dependencies = f.readlines() 12 | 13 | with open('src/discord_bot/version.py') as f: 14 | version = re.search(r'VERSION\s*=\s*\"((\w+\.?)+)', f.read(), re.MULTILINE).group(1) 15 | 16 | setup( 17 | # TODO: Adjust your project information here 18 | name='discord_bot', 19 | version=version, 20 | description='A discord bot template', 21 | long_description=long_description, 22 | long_description_content_type='text/markdown', 23 | url='https://github.com/nonchris/discord-bot', 24 | author='nonchris', 25 | author_email='info@nonchris.eu', 26 | 27 | project_urls={ 28 | 'Bug Reports': 'https://github.com/nonchris/discord-bot/issues', 29 | 'Source': 'https://github.com/https://github.com/nonchris/discord-bot', 30 | }, 31 | 32 | keywords='discord-bot', 33 | 34 | python_requires='>=3.8, <4', 35 | 36 | install_requires=dependencies, 37 | 38 | classifiers=[ 39 | 40 | 'Development Status :: 5 - Production/Stable', 41 | 42 | 'Environment :: Console', 43 | 44 | 'Intended Audience :: Other Audience', 45 | 'Topic :: Communications :: Chat', 46 | 47 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 48 | 49 | 'Programming Language :: Python :: 3', 50 | 'Programming Language :: Python :: 3.8', 51 | 'Programming Language :: Python :: 3.9', 52 | 'Programming Language :: Python :: 3 :: Only', 53 | 54 | 'Typing :: Typed', 55 | ], 56 | 57 | package_dir={'': 'src'}, 58 | 59 | packages=find_packages(where='src'), 60 | 61 | entry_points={ 62 | 'console_scripts': [ 63 | 'discord-bot=discord_bot:main', 64 | ], 65 | }, 66 | ) 67 | -------------------------------------------------------------------------------- /src/discord_bot/cogs/misc.py: -------------------------------------------------------------------------------- 1 | from typing import Literal, Optional 2 | 3 | import discord 4 | from discord import app_commands 5 | from discord.ext import commands 6 | from discord.ext import tasks 7 | 8 | from ..log_setup import logger 9 | from ..utils import utils as ut 10 | 11 | 12 | ### @package misc 13 | # 14 | # Collection of miscellaneous helpers. 15 | # 16 | 17 | class Misc(commands.Cog): 18 | """ 19 | Various useful Commands for everyone 20 | """ 21 | 22 | def __init__(self, bot): 23 | self.bot: commands.Bot = bot 24 | 25 | # a chat based command 26 | @commands.command(name='ping', help="Check if Bot available") 27 | async def ping(self, ctx): 28 | """! 29 | ping to check if the bot is available 30 | 31 | @param ctx Context of the message 32 | """ 33 | logger.info(f"ping: {round(self.bot.latency * 1000)}") 34 | 35 | await ctx.send( 36 | embed=ut.make_embed( 37 | name='Bot is available', 38 | value=f'`{round(self.bot.latency * 1000)}ms`') 39 | ) 40 | 41 | @app_commands.command(name="ping", description="Ping as a slash command") 42 | # @app_commands.guild_only 43 | async def ping_slash(self, 44 | interaction: discord.Interaction, 45 | mode: Optional[Literal["silent", "loud"]]): 46 | """ 47 | Ping command implementing the same functionality as "chat"-command 48 | But with extra option to be silent 49 | """ 50 | logger.info(f"ping: {round(self.bot.latency * 1000)}") 51 | # decide whether this message shall be silent 52 | ephemeral = True if mode and mode == "silent" else False 53 | 54 | await interaction.response.send_message( 55 | embed=ut.make_embed( 56 | name='Bot is available', 57 | value=f'`{round(self.bot.latency * 1000)}ms`'), 58 | ephemeral=ephemeral 59 | ) 60 | 61 | # Example for an event listener 62 | # This one will be called on each message the bot receives 63 | @commands.Cog.listener() 64 | async def on_message(self, message: discord.Message): 65 | pass 66 | 67 | # Example for a task 68 | # It can be started using self.my_task.start() e.g. from this cogs __init__ 69 | @tasks.loop(seconds=60) 70 | async def my_task(self): 71 | pass 72 | 73 | async def setup(bot): 74 | await bot.add_cog(Misc(bot)) 75 | -------------------------------------------------------------------------------- /src/discord_bot/utils/utils.py: -------------------------------------------------------------------------------- 1 | import re 2 | from typing import Union 3 | 4 | import discord 5 | from discord.errors import Forbidden 6 | 7 | ### @package utils 8 | # 9 | # The color presets, send_message() and make_embed() functions are 10 | # included in the [discord-bot template by 11 | # nonchris](https://github.com/nonchris/discord-bot) 12 | 13 | 14 | # color scheme for embeds as rbg 15 | blue_light = discord.Color.from_rgb(20, 255, 255) # default color 16 | green = discord.Color.from_rgb(142, 250, 60) # success green 17 | yellow = discord.Color.from_rgb(245, 218, 17) # warning like 'hey, that's not cool' 18 | orange = discord.Color.from_rgb(245, 139, 17) # warning - rather critical like 'no more votes left' 19 | red = discord.Color.from_rgb(255, 28, 25) # error red 20 | 21 | ### @package utils 22 | # 23 | # Utilities and helper functions 24 | # 25 | 26 | async def send_embed(ctx, embed): 27 | """! 28 | Handles the sending of embeds 29 | @param ctx context to send to 30 | @param embed embed to send 31 | 32 | - tries to send embed in channel 33 | - tries to send normal message when that fails 34 | - tries to send embed private with information abot missing permissions 35 | If this all fails: https://youtu.be/dQw4w9WgXcQ 36 | """ 37 | try: 38 | await ctx.send(embed=embed) 39 | except Forbidden: 40 | try: 41 | await ctx.send("Hey, seems like I can't send embeds. Please check my permissions :)") 42 | except Forbidden: 43 | await ctx.author.send( 44 | f"Hey, seems like I can't send any message in {ctx.channel.name} on {ctx.guild.name}\n" 45 | f"May you inform the server team about this issue? :slight_smile:", embed=embed) 46 | 47 | 48 | def make_embed(title="", color=blue_light, name="‌", value="‌", footer=None) -> discord.Embed: 49 | """! 50 | Function to generate generate an embed in one function call 51 | please note that name and value can't be empty - name and value contain a zero width non-joiner 52 | 53 | @param title Headline of embed 54 | @param color RGB Tuple (Red, Green, Blue) 55 | @param name: Of field (sub-headline) 56 | @param value: Text of field (actual text) 57 | @param footer: Text in footer 58 | @return Embed ready to send 59 | """ 60 | # make color object 61 | emb = discord.Embed(title=title, color=color) 62 | emb.add_field(name=name, value=value) 63 | if footer: 64 | emb.set_footer(text=footer) 65 | 66 | return emb 67 | 68 | 69 | def extract_id_from_string(content: str) -> Union[int, None]: 70 | """! 71 | Scans string to extract user/guild/message id\n 72 | Can extract IDs from mentions or plaintext 73 | 74 | @return extracted id as int if exists, else None 75 | """ 76 | # matching string that has 18 digits surrounded by non-digits or start/end of string 77 | match = re.match(r'(\D+|^)(\d{18})(\D+|$)', content) 78 | 79 | return int(match.group(2)) if match else None 80 | 81 | 82 | def get_member_name(member: discord.Member) -> str: 83 | """! 84 | Shorthand to extract wich name to use when addressing member 85 | @return member.nick if exists else member.name 86 | """ 87 | return member.nick if member.nick else member.name 88 | -------------------------------------------------------------------------------- /src/discord_bot/environment.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | from .log_setup import logger 4 | from .version import VERSION # load version, other modules can access without extra import 5 | 6 | 7 | ### @package environment 8 | # 9 | # Interactions with the environment variables. 10 | # 11 | from typing import Dict, Optional 12 | 13 | 14 | def load_env(key: str, default: str, config_dict=None) -> str: 15 | """! 16 | Function to load a key from environment or from a config-dict\n 17 | Handles None-types for not set env-variables by returning the default.\n 18 | Prefers env-variables with same name over contents read from config-file\n 19 | Does also replace specified expressions like {PREFIX} with actual content. 20 | 21 | @param key: name of env variable to load 22 | @param default: default value if variable couldn't be loaded 23 | @param config_dict: json-like dict 24 | @return value of env variable or default value 25 | """ 26 | 27 | env_value = os.getenv(key) # get key from environment 28 | 29 | # try to get key also from config file 30 | conf_val = None 31 | if isinstance(config_dict, dict): 32 | conf_val = config_dict.get(key, None) 33 | 34 | # Decide which value to take 35 | if env_value and conf_val: 36 | logger.info(f"Gained '{key}' from environment and config - preferring env-variable") 37 | value = env_value 38 | elif env_value: 39 | logger.debug(f"Gained '{key}' from environment only, using this value") 40 | value = env_value 41 | elif conf_val: 42 | logger.debug(f"Gained '{key}' from config-file only, using this value") 43 | value = conf_val 44 | else: 45 | value = None 46 | 47 | # catch token and prefix value, since it doesn't need the extra replace handling below 48 | # also PREFIX isn't defined yet... 49 | if key == "TOKEN": 50 | return value 51 | 52 | if key == "PREFIX": 53 | if value: 54 | return value 55 | else: 56 | logger.warning(f"Can't load env-variable for: '{key}' - falling back to DEFAULT {key}='{default}'") 57 | return default 58 | 59 | if value is not None: 60 | try: 61 | return value.replace("{PREFIX}", PREFIX) 62 | # this happens when a variable is loaded before PREFIX 63 | except NameError as e: 64 | logger.error( 65 | f"Can't replace expressions for: '{key}' {e.__repr__()}.\n" 66 | f"This happens if a referenced env-variable isn't initiated yet. " 67 | f"You may wanna change the load order - falling back to DEFAULT {key}='{default}' " 68 | ) 69 | return default 70 | logger.warning(f"Can't load env-variable for: '{key}' - falling back to DEFAULT {key}='{default}'") 71 | return default 72 | 73 | 74 | def load_conf_file(config_file='./data/config.json') -> Optional[Dict[str, str]]: 75 | if os.path.isfile(config_file): 76 | logger.debug(f"Config file '{config_file}' exists, trying to read") 77 | try: 78 | with open(config_file, "r") as jsonfile: 79 | return json.load(jsonfile) 80 | 81 | except OSError: 82 | logger.warning(f"Can't open or read config file: '{config_file}'") 83 | 84 | else: 85 | logger.debug(f"No config-file was found under '{config_file}', trying to continue") 86 | 87 | 88 | cfg_dict = load_conf_file('./data/config.json') 89 | 90 | TOKEN = load_env("TOKEN", '', config_dict=cfg_dict) # reading in the token from environment - there is no default... 91 | 92 | # loading optional env variables 93 | PREFIX = load_env("PREFIX", "b!", config_dict=cfg_dict) 94 | OWNER_NAME = load_env("OWNER_NAME", "unknown", config_dict=cfg_dict) # owner name with tag e.g. pi#3141 95 | OWNER_ID = int(load_env("OWNER_ID", "100000000000000000", config_dict=cfg_dict)) # discord id of the owner 96 | ACTIVITY_NAME = load_env("ACTIVITY_NAME", f"{PREFIX}help", config_dict=cfg_dict) # activity bot plays 97 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # discord-bot-template 2 | Generic, functional bot based on discord.py V2. 3 | Including: 4 | - general bot setup, saving your time 5 | - overwritten behaviour in `on_ready()`, `setup_hook()` and `on_guild_join()` 6 | - cog-structure 7 | 8 | - commands 9 | - ping-commands for slash- and chat-usage as demonstration 10 | - a custom help command for old-style chat-command as examples 11 | - old-style reacts to prefix and mention 12 | 13 | - logging setup for console and file 14 | - utils for easy embed creation, id-extraction and more 15 | - easy to use external configuration using json or env-variables 16 | - overall project structure for easy packaging and deployment 17 | 18 | This template is aimed at beginners ([how to start](#I'm-new-to-bots---where-to-start?)) for learning purposes and 19 | advanced users for 20 | saving time. 21 | 22 | 23 | ## Setup 24 | 25 | ###### Setup a [venv](https://docs.python.org/3/library/venv.html) (optional, but recommend) 26 | ```bash 27 | python3 -m venv venv 28 | source venv/bin/activate 29 | ``` 30 | 31 | 32 | ##### Using pip to install and run the bot as (editable) package: 33 | ```bash 34 | python3 -m pip install -e . 35 | export TOKEN="your-token" 36 | discord-bot 37 | ``` 38 | Note: `-e` is meant only for development. Do not use it for deployment! 39 | 40 | ##### Or run the bot directly: 41 | ```bash 42 | pip install -r requirements.txt 43 | export TOKEN="your-token" 44 | python3 src/discord_bot/__init__.py 45 | ``` 46 | 47 | 48 | ### Intents 49 | The bot uses all intents by default, those are required for such simple things like 'display member-count at startup'. 50 | You need to enable those intents in the [discord developers portal](https://discord.com/developers/applications) 51 | under `*YourApplication*/Bot/Privileged Gateway Intents`. 52 | It's possible reconfigure the requested intents in `main.py` if you don't need them. 53 | But I'd suggest using them all for the beginning, especially if you're relatively new to discord.py. 54 | This will only be an issue if your bot reaches more than 100 servers, then you've got to apply for those intents. 55 | 56 | #### Optional env variables 57 | | parameter | description | 58 | | ------ | ------ | 59 | | `PREFIX="b!"` | Command prefix | 60 | | `OWNER_NAME="unknwon"` | Name of the bot owner | 61 | | `OWNER_ID="100000000000000000"` | ID of the bot owner | 62 | | `ACTIVITY_NAME=f"{PREFIX}help"`| Activity bot plays | 63 | 64 | The shown values are the default values that will be loaded if nothing else is specified. 65 | Expressions like `{PREFIX}` will be replaced by during loading the variable and can be used in specified env variables. 66 | 67 | Set those variables using env-variables (suggested): 68 | `export PREFIX="b!"` 69 | Or use a json-file expected at: `./data/config.json` like: 70 | ```json 71 | { 72 | "TOKEN": "[your-token]", 73 | "PREFIX": "b!" 74 | } 75 | ``` 76 | 77 | _If a variable is set using env and json **the environment-variable replaces the json**!_ 78 | 79 | 80 | # I'm new to bots - where to start? 81 | Have a look at `src/discord_bot/cogs/misc.py` this is a good place to start with your first smaller functions. 82 | You'll find some basic examples there. 83 | Try to modify the `ping`-command or start with a small listener (`on_message`) that responds to each message the bot receives. 84 | Or write a slash command that sends the date the [member joined the server](https://discordpy.readthedocs.io/en/latest/api.html?highlight=joined#discord.Member.joined_at). 85 | 86 | You can expand to yor own, new modules when you feel ready for it :) 87 | The official docs for discord.py are [here](https://discordpy.readthedocs.io/en/latest/api.html?highlight=guild#api-reference). 88 | There are also very well documented [examples in the official repository](https://github.com/Rapptz/discord.py/tree/master/examples). 89 | 90 | ### about 91 | This repository contains code that was written by me across various bot-projects, like: 92 | https://github.com/nonchris/discord-fury 93 | https://github.com/nonchris/quiz-bot 94 | https://github.com/Info-Bonn/verification-listener 95 | https://github.com/nonchris/discord-role-selection/tree/main/src/bot 96 | 97 | I collected the most useful and generic functions to save me some time when starting the next bot-project. 98 | 99 | ### documentation 100 | In order to render this documentation, just call `doxygen` 101 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Our own folder for data 2 | data/ 3 | 4 | # Created by https://www.toptal.com/developers/gitignore/api/python,pycharm+all 5 | # Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm+all 6 | 7 | ### PyCharm+all ### 8 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 9 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 10 | 11 | # User-specific stuff 12 | .idea/**/workspace.xml 13 | .idea/**/tasks.xml 14 | .idea/**/usage.statistics.xml 15 | .idea/**/dictionaries 16 | .idea/**/shelf 17 | 18 | # Generated files 19 | .idea/**/contentModel.xml 20 | 21 | # Sensitive or high-churn files 22 | .idea/**/dataSources/ 23 | .idea/**/dataSources.ids 24 | .idea/**/dataSources.local.xml 25 | .idea/**/sqlDataSources.xml 26 | .idea/**/dynamic.xml 27 | .idea/**/uiDesigner.xml 28 | .idea/**/dbnavigator.xml 29 | 30 | # Gradle 31 | .idea/**/gradle.xml 32 | .idea/**/libraries 33 | 34 | # Gradle and Maven with auto-import 35 | # When using Gradle or Maven with auto-import, you should exclude module files, 36 | # since they will be recreated, and may cause churn. Uncomment if using 37 | # auto-import. 38 | # .idea/artifacts 39 | # .idea/compiler.xml 40 | # .idea/jarRepositories.xml 41 | # .idea/modules.xml 42 | # .idea/*.iml 43 | # .idea/modules 44 | # *.iml 45 | # *.ipr 46 | 47 | # CMake 48 | cmake-build-*/ 49 | 50 | # Mongo Explorer plugin 51 | .idea/**/mongoSettings.xml 52 | 53 | # File-based project format 54 | *.iws 55 | 56 | # IntelliJ 57 | out/ 58 | 59 | # mpeltonen/sbt-idea plugin 60 | .idea_modules/ 61 | 62 | # JIRA plugin 63 | atlassian-ide-plugin.xml 64 | 65 | # Cursive Clojure plugin 66 | .idea/replstate.xml 67 | 68 | # Crashlytics plugin (for Android Studio and IntelliJ) 69 | com_crashlytics_export_strings.xml 70 | crashlytics.properties 71 | crashlytics-build.properties 72 | fabric.properties 73 | 74 | # Editor-based Rest Client 75 | .idea/httpRequests 76 | 77 | # Android studio 3.1+ serialized cache file 78 | .idea/caches/build_file_checksums.ser 79 | 80 | ### PyCharm+all Patch ### 81 | # Ignores the whole .idea folder and all .iml files 82 | # See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360 83 | 84 | .idea/ 85 | 86 | # Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023 87 | 88 | *.iml 89 | modules.xml 90 | .idea/misc.xml 91 | *.ipr 92 | 93 | # Sonarlint plugin 94 | .idea/sonarlint 95 | 96 | ### Python ### 97 | # Byte-compiled / optimized / DLL files 98 | __pycache__/ 99 | *.py[cod] 100 | *$py.class 101 | 102 | # C extensions 103 | *.so 104 | 105 | # Distribution / packaging 106 | .Python 107 | build/ 108 | develop-eggs/ 109 | dist/ 110 | downloads/ 111 | eggs/ 112 | .eggs/ 113 | parts/ 114 | sdist/ 115 | var/ 116 | wheels/ 117 | pip-wheel-metadata/ 118 | share/python-wheels/ 119 | *.egg-info/ 120 | .installed.cfg 121 | *.egg 122 | MANIFEST 123 | 124 | # PyInstaller 125 | # Usually these files are written by a python script from a template 126 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 127 | *.manifest 128 | *.spec 129 | 130 | # Installer logs 131 | pip-log.txt 132 | pip-delete-this-directory.txt 133 | 134 | # Unit test / coverage reports 135 | htmlcov/ 136 | .tox/ 137 | .nox/ 138 | .coverage 139 | .coverage.* 140 | .cache 141 | nosetests.xml 142 | coverage.xml 143 | *.cover 144 | *.py,cover 145 | .hypothesis/ 146 | .pytest_cache/ 147 | pytestdebug.log 148 | 149 | # Translations 150 | *.mo 151 | *.pot 152 | 153 | # Django stuff: 154 | *.log 155 | local_settings.py 156 | db.sqlite3 157 | db.sqlite3-journal 158 | 159 | # Flask stuff: 160 | instance/ 161 | .webassets-cache 162 | 163 | # Scrapy stuff: 164 | .scrapy 165 | 166 | # Sphinx documentation 167 | docs/_build/ 168 | doc/_build/ 169 | 170 | # PyBuilder 171 | target/ 172 | 173 | # Jupyter Notebook 174 | .ipynb_checkpoints 175 | 176 | # IPython 177 | profile_default/ 178 | ipython_config.py 179 | 180 | # pyenv 181 | .python-version 182 | 183 | # pipenv 184 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 185 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 186 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 187 | # install all needed dependencies. 188 | #Pipfile.lock 189 | 190 | # poetry 191 | #poetry.lock 192 | 193 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 194 | __pypackages__/ 195 | 196 | # Celery stuff 197 | celerybeat-schedule 198 | celerybeat.pid 199 | 200 | # SageMath parsed files 201 | *.sage.py 202 | 203 | # Environments 204 | # .env 205 | .env/ 206 | .venv/ 207 | env/ 208 | venv/ 209 | ENV/ 210 | env.bak/ 211 | venv.bak/ 212 | pythonenv* 213 | 214 | # Spyder project settings 215 | .spyderproject 216 | .spyproject 217 | 218 | # Rope project settings 219 | .ropeproject 220 | 221 | # mkdocs documentation 222 | /site 223 | 224 | # mypy 225 | .mypy_cache/ 226 | .dmypy.json 227 | dmypy.json 228 | 229 | # Pyre type checker 230 | .pyre/ 231 | 232 | # pytype static type analyzer 233 | .pytype/ 234 | 235 | # operating system-related files 236 | # file properties cache/storage on macOS 237 | *.DS_Store 238 | # thumbnail cache on Windows 239 | Thumbs.db 240 | 241 | # profiling data 242 | .prof 243 | 244 | 245 | # End of https://www.toptal.com/developers/gitignore/api/python,pycharm+all 246 | -------------------------------------------------------------------------------- /src/discord_bot/main.py: -------------------------------------------------------------------------------- 1 | #!/bin/env python 2 | 3 | import discord 4 | from discord.ext import commands 5 | 6 | # setup of logging and env-vars 7 | # logging must be initialized before environment, to enable logging in environment 8 | from .log_setup import logger, formatter, console_logger 9 | from .environment import PREFIX, TOKEN, ACTIVITY_NAME 10 | 11 | """ 12 | This bot is based on a template by nonchris 13 | https://github.com/nonchris/discord-bot 14 | """ 15 | 16 | 17 | class MyBot(commands.Bot): 18 | """! 19 | Custom bot-class implementing useful defaults for loading cogs and pushing slash-commands 20 | This implementation is object-oriented. 21 | You can still overwrite / use the 'classic' decorator method like: 22 | 23 | @bot.event 24 | async def on_ready(): 25 | ... 26 | 27 | """ 28 | 29 | def __init__(self, intents: discord.Intents = discord.Intents.all()): 30 | """ Initialize bot with intents and init super """ 31 | super().__init__(command_prefix=self._prefix_callable, intents=intents) 32 | 33 | async def setup_hook(self): 34 | """! 35 | A coroutine to be called to setup the bot, by default this is blank. 36 | This performs an asynchronous setup after the bot is logged in, 37 | but before it has connected to the Websocket (quoted from d.py docs) 38 | """ 39 | 40 | # login message 41 | async def on_ready(self): 42 | """! 43 | Function called when the bot is ready. Emits the '[Bot] has connected' message 44 | Loads the extensions 45 | """ 46 | 47 | # LOADING Extensions 48 | # this is done in on_ready() so that cogs can fetch data from discord when they're loaded 49 | self.remove_command('help') # unload default help message 50 | # TODO: Register your extensions here 51 | initial_extensions = [ 52 | '.cogs.misc', 53 | '.cogs.help' 54 | ] 55 | 56 | for extension in initial_extensions: 57 | await self.load_extension(extension, package=__package__) 58 | 59 | # Walk all guilds, report connected guilds and push commands to guilds 60 | member_count = 0 61 | guild_string = "" 62 | for g in self.guilds: 63 | guild_string += f"{g.name} - {g.id} - Members: {g.member_count}\n" 64 | member_count += g.member_count 65 | 66 | # PUSHING Commands 67 | # copy all commands to all guilds one after an other 68 | # this is inefficient, but a fast way to push new commands to all guilds 69 | await self.__sync_commands_to_guild(g) 70 | 71 | logger.info(f"\n---\n" 72 | f"Bot '{self.user.name}' has connected, active on {len(self.guilds)} guilds:\n{guild_string}" 73 | f"---\n") 74 | 75 | # set the status of the bot 76 | await self.change_presence( 77 | activity=discord.Activity(type=discord.ActivityType.watching, name=ACTIVITY_NAME)) 78 | 79 | async def on_guild_join(self, guild: discord.Guild): 80 | """! 81 | Function called when bot is invited onto a new server 82 | """ 83 | logger.info(f"Bot joined guild: '{guild.name}'") 84 | # try to push slash commands to new server 85 | await self.__sync_commands_to_guild(guild) 86 | 87 | async def __sync_commands_to_guild(self, guild: discord.Guild): 88 | """! 89 | Function to push all commands to a guild 90 | Doing this for all guilds on startup is is inefficient, but a fast way to push new commands to all guilds 91 | """ 92 | try: 93 | self.tree.copy_global_to(guild=guild) 94 | await self.tree.sync(guild=guild) 95 | logger.info(f"Pushed commands to: {guild.name}") 96 | except discord.errors.Forbidden: 97 | logger.warning(f"Don't have the permissions to push slash commands to: '{guild.name}'") 98 | 99 | # inspired by https://github.com/Rapptz/RoboDanny 100 | # This function will be evaluated for each message 101 | # you can define specific behaviours for different messages or guilds, like custom prefixes for a guild etc... 102 | @staticmethod 103 | def _prefix_callable(_bot, msg: discord.Message): 104 | """! 105 | Function that evaluates whether a (chat)-command was triggered by a message 106 | Inspired by https://github.com/Rapptz/RoboDanny 107 | """ 108 | user_id = _bot.user.id 109 | # way discord expresses mentions 110 | # mobile and desktop have a different syntax how mentions are sent, so we handle both 111 | prefixes = [f'<@!{user_id}> ', f'<@{user_id}> '] 112 | if msg.guild is None: # we're in DMs, using default prefix 113 | prefixes.append(PREFIX) 114 | return prefixes 115 | 116 | # TODO: This would be the place to add guild specific custom prefixes 117 | # you've got the current message hence the guild-id which is perfect to store and load prefixes for a guild 118 | # just append them to base and only append the default prefix if there is no custom prefix for that guild 119 | 120 | prefixes.append(PREFIX) 121 | return prefixes 122 | 123 | 124 | # Create instance of our bot 125 | bot = MyBot() 126 | 127 | 128 | # Entrypoint function called from __init__.py 129 | def start_bot(token=None, log_handler=console_logger, log_formatter=formatter, root_logger=False): 130 | """ Start the bot, takes token, uses token from env if none is given """ 131 | # TODO: Logs from d.py don't appear in the log file (note for the dev, not the template user) 132 | if token is not None: 133 | bot.run(token, log_handler=log_handler, log_formatter=log_formatter, root_logger=root_logger) 134 | if TOKEN is not None: 135 | bot.run(TOKEN, log_handler=log_handler, log_formatter=log_formatter, root_logger=root_logger) 136 | else: 137 | logger.error("No token was given! - Exiting") 138 | -------------------------------------------------------------------------------- /src/discord_bot/cogs/help.py: -------------------------------------------------------------------------------- 1 | import discord 2 | from discord.ext import commands 3 | 4 | from ..utils import utils as utl 5 | from ..environment import OWNER_NAME, OWNER_ID, VERSION, PREFIX 6 | 7 | ### @package help 8 | # 9 | # This custom help command is a replacement for the default one on any Discord Bot written in discord.py! 10 | # However, you must put "bot.remove_command('help')" in your bot, and the command must be in a cog for it to work. 11 | # 12 | # Original concept by [Jared Newsom (AKA Jared M.F.)](https://gist.github.com/StudioMFTechnologies/ad41bfd32b2379ccffe90b0e34128b8b) 13 | # Rewritten and optimized by [nonchris](https://github.com/nonchris) 14 | # 15 | # This version relies more on the structure around this module than the gist does, which is more 'stand alone' 16 | 17 | 18 | class Help(commands.Cog): 19 | """ 20 | Sends this help message 21 | """ 22 | 23 | def __init__(self, bot): 24 | """! 25 | Constructor 26 | 27 | @param bot The bot instance to be used. 28 | """ 29 | self.bot = bot 30 | 31 | @commands.command(aliases=['h', 'hilfe']) 32 | # @commands.bot_has_permissions(add_reactions=True,embed_links=True) 33 | async def help(self, ctx, *params): 34 | """! 35 | Shows all modules of that bot, slash commands will not be listed 36 | 37 | @param ctx Context of the message. 38 | @param params further arguments 39 | """ 40 | 41 | # checks if cog parameter was given 42 | # if not: sending all modules and commands not associated with a cog 43 | if not params: 44 | # checks if owner is on this server - used to 'tag' owner 45 | try: 46 | owner = ctx.guild.get_member(OWNER_ID).mention 47 | 48 | except AttributeError: 49 | owner = OWNER_NAME 50 | 51 | # starting to build embed 52 | emb = discord.Embed(title='Commands and modules', color=utl.blue_light, 53 | description=f'Use `{PREFIX}h ` to gain more information about that module ' 54 | f':smiley:\n' 55 | f'Please note that _slash commands are not listed in this overview_.\n') 56 | 57 | # iterating trough cogs, gathering descriptions 58 | cogs_desc = '' 59 | for cog in self.bot.cogs: 60 | # ignoring boring cogs 61 | if cog == "MessageListener" or cog == "Help": 62 | continue 63 | cogs_desc += f'`{cog}` {self.bot.cogs[cog].__doc__}\n' 64 | 65 | # adding 'list' of cogs to embed 66 | emb.add_field(name='Modules', value=cogs_desc, inline=False) 67 | 68 | # integrating trough uncategorized commands 69 | commands_desc = '' 70 | for command in self.bot.walk_commands(): 71 | # if cog not in a cog 72 | # listing command if cog name is None and command isn't hidden 73 | if not command.cog_name and not command.hidden: 74 | commands_desc += f'{command.name} - {command.help}\n' 75 | 76 | # adding those commands to embed 77 | if commands_desc: 78 | emb.add_field(name='Not belonging to a module', value=commands_desc, inline=False) 79 | 80 | # setting information about author 81 | emb.add_field(name="About", 82 | value=f"This bot is maintained by {owner}.\n\ 83 | Please visit https://github.com/nonchris/discord-bot to submit ideas or bugs.\n\ 84 | Based on a template by nonchris: https://github.com/nonchris/discord-bot.\n") 85 | emb.set_footer(text=f"Bot is running Version: {VERSION}") 86 | 87 | # block called when one cog-name is given 88 | # trying to find matching cog and it's commands 89 | elif len(params) == 1: 90 | 91 | # iterating trough cogs 92 | for cog in self.bot.cogs: 93 | # check if cog is the matching one 94 | if cog.lower() == params[0].lower(): 95 | 96 | # making title - getting description from doc-string below class 97 | emb = discord.Embed(title=f'{cog} - commands', description=self.bot.cogs[cog].__doc__, 98 | color=utl.green) 99 | 100 | # getting commands from cog 101 | for command in self.bot.get_cog(cog).get_commands(): 102 | # if cog is not hidden 103 | if not command.hidden: 104 | emb.add_field(name=f"{PREFIX}{command.name}", value=command.help, inline=False) 105 | # found cog - breaking loop 106 | break 107 | 108 | # if input not found 109 | # yes, for-loops have an else statement, it's called when no 'break' was issued 110 | else: 111 | emb = discord.Embed(title="What's that?!", 112 | description=f"I've never heard from a module called `{params[0]}` before :scream:", 113 | color=utl.orange) 114 | 115 | # too many cogs requested - only one at a time allowed 116 | elif len(params) > 1: 117 | emb = discord.Embed(title="That's too much.", 118 | description="Please request only one module at once :sweat_smile:", 119 | color=utl.orange) 120 | 121 | else: 122 | emb = discord.Embed(title="It's a magical place.", 123 | description="I don't know how you got here. But I didn't see this coming at all.\n" 124 | "Would you please be so kind to report that issue to me on github?\n" 125 | "https://github.com/nonchris/discord-bot/issues\n" 126 | "Thank you! ~Chris", 127 | color=utl.orange) 128 | 129 | # sending reply embed using our own function defined above 130 | await utl.send_embed(ctx, emb) 131 | 132 | 133 | async def setup(bot): 134 | """! 135 | Setup a bot. 136 | 137 | @param bot The bot to setup. 138 | """ 139 | await bot.add_cog(Help(bot)) 140 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.9.1 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the configuration 21 | # file that follow. The default is UTF-8 which is also the encoding used for all 22 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 23 | # iconv built into libc) for the transcoding. See 24 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "discord-bot" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 1.0 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = "A generic, functional bot based on discord.py" 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = documentation 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 97 | # documentation generated by doxygen is written. Doxygen will use this 98 | # information to generate all generated output in the proper direction. 99 | # Possible values are: None, LTR, RTL and Context. 100 | # The default value is: None. 101 | 102 | OUTPUT_TEXT_DIRECTION = None 103 | 104 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 105 | # descriptions after the members that are listed in the file and class 106 | # documentation (similar to Javadoc). Set to NO to disable this. 107 | # The default value is: YES. 108 | 109 | BRIEF_MEMBER_DESC = YES 110 | 111 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 112 | # description of a member or function before the detailed description 113 | # 114 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 115 | # brief descriptions will be completely suppressed. 116 | # The default value is: YES. 117 | 118 | REPEAT_BRIEF = YES 119 | 120 | # This tag implements a quasi-intelligent brief description abbreviator that is 121 | # used to form the text in various listings. Each string in this list, if found 122 | # as the leading text of the brief description, will be stripped from the text 123 | # and the result, after processing the whole list, is used as the annotated 124 | # text. Otherwise, the brief description is used as-is. If left blank, the 125 | # following values are used ($name is automatically replaced with the name of 126 | # the entity):The $name class, The $name widget, The $name file, is, provides, 127 | # specifies, contains, represents, a, an and the. 128 | 129 | ABBREVIATE_BRIEF = "The $name class" \ 130 | "The $name widget" \ 131 | "The $name file" \ 132 | is \ 133 | provides \ 134 | specifies \ 135 | contains \ 136 | represents \ 137 | a \ 138 | an \ 139 | the 140 | 141 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 142 | # doxygen will generate a detailed section even if there is only a brief 143 | # description. 144 | # The default value is: NO. 145 | 146 | ALWAYS_DETAILED_SEC = NO 147 | 148 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 149 | # inherited members of a class in the documentation of that class as if those 150 | # members were ordinary class members. Constructors, destructors and assignment 151 | # operators of the base classes will not be shown. 152 | # The default value is: NO. 153 | 154 | INLINE_INHERITED_MEMB = NO 155 | 156 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 157 | # before files name in the file list and in the header files. If set to NO the 158 | # shortest path that makes the file name unique will be used 159 | # The default value is: YES. 160 | 161 | FULL_PATH_NAMES = YES 162 | 163 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 164 | # Stripping is only done if one of the specified strings matches the left-hand 165 | # part of the path. The tag can be used to show relative paths in the file list. 166 | # If left blank the directory from which doxygen is run is used as the path to 167 | # strip. 168 | # 169 | # Note that you can specify absolute paths here, but also relative paths, which 170 | # will be relative from the directory where doxygen is started. 171 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 172 | 173 | STRIP_FROM_PATH = 174 | 175 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 176 | # path mentioned in the documentation of a class, which tells the reader which 177 | # header file to include in order to use a class. If left blank only the name of 178 | # the header file containing the class definition is used. Otherwise one should 179 | # specify the list of include paths that are normally passed to the compiler 180 | # using the -I flag. 181 | 182 | STRIP_FROM_INC_PATH = 183 | 184 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 185 | # less readable) file names. This can be useful is your file systems doesn't 186 | # support long names like on DOS, Mac, or CD-ROM. 187 | # The default value is: NO. 188 | 189 | SHORT_NAMES = NO 190 | 191 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 192 | # first line (until the first dot) of a Javadoc-style comment as the brief 193 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 194 | # style comments (thus requiring an explicit @brief command for a brief 195 | # description.) 196 | # The default value is: NO. 197 | 198 | JAVADOC_AUTOBRIEF = YES 199 | 200 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 201 | # such as 202 | # /*************** 203 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 204 | # Javadoc-style will behave just like regular comments and it will not be 205 | # interpreted by doxygen. 206 | # The default value is: NO. 207 | 208 | JAVADOC_BANNER = NO 209 | 210 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 211 | # line (until the first dot) of a Qt-style comment as the brief description. If 212 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 213 | # requiring an explicit \brief command for a brief description.) 214 | # The default value is: NO. 215 | 216 | QT_AUTOBRIEF = NO 217 | 218 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 219 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 220 | # a brief description. This used to be the default behavior. The new default is 221 | # to treat a multi-line C++ comment block as a detailed description. Set this 222 | # tag to YES if you prefer the old behavior instead. 223 | # 224 | # Note that setting this tag to YES also means that rational rose comments are 225 | # not recognized any more. 226 | # The default value is: NO. 227 | 228 | MULTILINE_CPP_IS_BRIEF = NO 229 | 230 | # By default Python docstrings are displayed as preformatted text and doxygen's 231 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 232 | # doxygen's special commands can be used and the contents of the docstring 233 | # documentation blocks is shown as doxygen documentation. 234 | # The default value is: YES. 235 | 236 | PYTHON_DOCSTRING = NO 237 | 238 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 239 | # documentation from any documented member that it re-implements. 240 | # The default value is: YES. 241 | 242 | INHERIT_DOCS = YES 243 | 244 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 245 | # page for each member. If set to NO, the documentation of a member will be part 246 | # of the file/class/namespace that contains it. 247 | # The default value is: NO. 248 | 249 | SEPARATE_MEMBER_PAGES = NO 250 | 251 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 252 | # uses this value to replace tabs by spaces in code fragments. 253 | # Minimum value: 1, maximum value: 16, default value: 4. 254 | 255 | TAB_SIZE = 4 256 | 257 | # This tag can be used to specify a number of aliases that act as commands in 258 | # the documentation. An alias has the form: 259 | # name=value 260 | # For example adding 261 | # "sideeffect=@par Side Effects:\n" 262 | # will allow you to put the command \sideeffect (or @sideeffect) in the 263 | # documentation, which will result in a user-defined paragraph with heading 264 | # "Side Effects:". You can put \n's in the value part of an alias to insert 265 | # newlines (in the resulting output). You can put ^^ in the value part of an 266 | # alias to insert a newline as if a physical newline was in the original file. 267 | # When you need a literal { or } or , in the value part of an alias you have to 268 | # escape them by means of a backslash (\), this can lead to conflicts with the 269 | # commands \{ and \} for these it is advised to use the version @{ and @} or use 270 | # a double escape (\\{ and \\}) 271 | 272 | ALIASES = 273 | 274 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 275 | # only. Doxygen will then generate output that is more tailored for C. For 276 | # instance, some of the names that are used will be different. The list of all 277 | # members will be omitted, etc. 278 | # The default value is: NO. 279 | 280 | OPTIMIZE_OUTPUT_FOR_C = NO 281 | 282 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 283 | # Python sources only. Doxygen will then generate output that is more tailored 284 | # for that language. For instance, namespaces will be presented as packages, 285 | # qualified scopes will look different, etc. 286 | # The default value is: NO. 287 | 288 | OPTIMIZE_OUTPUT_JAVA = YES 289 | 290 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 291 | # sources. Doxygen will then generate output that is tailored for Fortran. 292 | # The default value is: NO. 293 | 294 | OPTIMIZE_FOR_FORTRAN = NO 295 | 296 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 297 | # sources. Doxygen will then generate output that is tailored for VHDL. 298 | # The default value is: NO. 299 | 300 | OPTIMIZE_OUTPUT_VHDL = NO 301 | 302 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 303 | # sources only. Doxygen will then generate output that is more tailored for that 304 | # language. For instance, namespaces will be presented as modules, types will be 305 | # separated into more groups, etc. 306 | # The default value is: NO. 307 | 308 | OPTIMIZE_OUTPUT_SLICE = NO 309 | 310 | # Doxygen selects the parser to use depending on the extension of the files it 311 | # parses. With this tag you can assign which parser to use for a given 312 | # extension. Doxygen has a built-in mapping, but you can override or extend it 313 | # using this tag. The format is ext=language, where ext is a file extension, and 314 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 315 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, 316 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 317 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 318 | # tries to guess whether the code is fixed or free formatted code, this is the 319 | # default for Fortran type files). For instance to make doxygen treat .inc files 320 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), 321 | # use: inc=Fortran f=C. 322 | # 323 | # Note: For files without extension you can use no_extension as a placeholder. 324 | # 325 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 326 | # the files are not read by doxygen. When specifying no_extension you should add 327 | # * to the FILE_PATTERNS. 328 | # 329 | # Note see also the list of default file extension mappings. 330 | 331 | EXTENSION_MAPPING = 332 | 333 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 334 | # according to the Markdown format, which allows for more readable 335 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 336 | # The output of markdown processing is further processed by doxygen, so you can 337 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 338 | # case of backward compatibilities issues. 339 | # The default value is: YES. 340 | 341 | MARKDOWN_SUPPORT = YES 342 | 343 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 344 | # to that level are automatically included in the table of contents, even if 345 | # they do not have an id attribute. 346 | # Note: This feature currently applies only to Markdown headings. 347 | # Minimum value: 0, maximum value: 99, default value: 5. 348 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 349 | 350 | TOC_INCLUDE_HEADINGS = 5 351 | 352 | # When enabled doxygen tries to link words that correspond to documented 353 | # classes, or namespaces to their corresponding documentation. Such a link can 354 | # be prevented in individual cases by putting a % sign in front of the word or 355 | # globally by setting AUTOLINK_SUPPORT to NO. 356 | # The default value is: YES. 357 | 358 | AUTOLINK_SUPPORT = YES 359 | 360 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 361 | # to include (a tag file for) the STL sources as input, then you should set this 362 | # tag to YES in order to let doxygen match functions declarations and 363 | # definitions whose arguments contain STL classes (e.g. func(std::string); 364 | # versus func(std::string) {}). This also make the inheritance and collaboration 365 | # diagrams that involve STL classes more complete and accurate. 366 | # The default value is: NO. 367 | 368 | BUILTIN_STL_SUPPORT = NO 369 | 370 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 371 | # enable parsing support. 372 | # The default value is: NO. 373 | 374 | CPP_CLI_SUPPORT = NO 375 | 376 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 377 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 378 | # will parse them like normal C++ but will assume all classes use public instead 379 | # of private inheritance when no explicit protection keyword is present. 380 | # The default value is: NO. 381 | 382 | SIP_SUPPORT = NO 383 | 384 | # For Microsoft's IDL there are propget and propput attributes to indicate 385 | # getter and setter methods for a property. Setting this option to YES will make 386 | # doxygen to replace the get and set methods by a property in the documentation. 387 | # This will only work if the methods are indeed getting or setting a simple 388 | # type. If this is not the case, or you want to show the methods anyway, you 389 | # should set this option to NO. 390 | # The default value is: YES. 391 | 392 | IDL_PROPERTY_SUPPORT = YES 393 | 394 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 395 | # tag is set to YES then doxygen will reuse the documentation of the first 396 | # member in the group (if any) for the other members of the group. By default 397 | # all members of a group must be documented explicitly. 398 | # The default value is: NO. 399 | 400 | DISTRIBUTE_GROUP_DOC = NO 401 | 402 | # If one adds a struct or class to a group and this option is enabled, then also 403 | # any nested class or struct is added to the same group. By default this option 404 | # is disabled and one has to add nested compounds explicitly via \ingroup. 405 | # The default value is: NO. 406 | 407 | GROUP_NESTED_COMPOUNDS = NO 408 | 409 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 410 | # (for instance a group of public functions) to be put as a subgroup of that 411 | # type (e.g. under the Public Functions section). Set it to NO to prevent 412 | # subgrouping. Alternatively, this can be done per class using the 413 | # \nosubgrouping command. 414 | # The default value is: YES. 415 | 416 | SUBGROUPING = YES 417 | 418 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 419 | # are shown inside the group in which they are included (e.g. using \ingroup) 420 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 421 | # and RTF). 422 | # 423 | # Note that this feature does not work in combination with 424 | # SEPARATE_MEMBER_PAGES. 425 | # The default value is: NO. 426 | 427 | INLINE_GROUPED_CLASSES = NO 428 | 429 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 430 | # with only public data fields or simple typedef fields will be shown inline in 431 | # the documentation of the scope in which they are defined (i.e. file, 432 | # namespace, or group documentation), provided this scope is documented. If set 433 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 434 | # Man pages) or section (for LaTeX and RTF). 435 | # The default value is: NO. 436 | 437 | INLINE_SIMPLE_STRUCTS = YES 438 | 439 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 440 | # enum is documented as struct, union, or enum with the name of the typedef. So 441 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 442 | # with name TypeT. When disabled the typedef will appear as a member of a file, 443 | # namespace, or class. And the struct will be named TypeS. This can typically be 444 | # useful for C code in case the coding convention dictates that all compound 445 | # types are typedef'ed and only the typedef is referenced, never the tag name. 446 | # The default value is: NO. 447 | 448 | TYPEDEF_HIDES_STRUCT = NO 449 | 450 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 451 | # cache is used to resolve symbols given their name and scope. Since this can be 452 | # an expensive process and often the same symbol appears multiple times in the 453 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 454 | # doxygen will become slower. If the cache is too large, memory is wasted. The 455 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 456 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 457 | # symbols. At the end of a run doxygen will report the cache usage and suggest 458 | # the optimal cache size from a speed point of view. 459 | # Minimum value: 0, maximum value: 9, default value: 0. 460 | 461 | LOOKUP_CACHE_SIZE = 0 462 | 463 | # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use 464 | # during processing. When set to 0 doxygen will based this on the number of 465 | # cores available in the system. You can set it explicitly to a value larger 466 | # than 0 to get more control over the balance between CPU load and processing 467 | # speed. At this moment only the input processing can be done using multiple 468 | # threads. Since this is still an experimental feature the default is set to 1, 469 | # which efficively disables parallel processing. Please report any issues you 470 | # encounter. Generating dot graphs in parallel is controlled by the 471 | # DOT_NUM_THREADS setting. 472 | # Minimum value: 0, maximum value: 32, default value: 1. 473 | 474 | NUM_PROC_THREADS = 1 475 | 476 | #--------------------------------------------------------------------------- 477 | # Build related configuration options 478 | #--------------------------------------------------------------------------- 479 | 480 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 481 | # documentation are documented, even if no documentation was available. Private 482 | # class members and static file members will be hidden unless the 483 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 484 | # Note: This will also disable the warnings about undocumented members that are 485 | # normally produced when WARNINGS is set to YES. 486 | # The default value is: NO. 487 | 488 | EXTRACT_ALL = YES 489 | 490 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 491 | # be included in the documentation. 492 | # The default value is: NO. 493 | 494 | EXTRACT_PRIVATE = NO 495 | 496 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 497 | # methods of a class will be included in the documentation. 498 | # The default value is: NO. 499 | 500 | EXTRACT_PRIV_VIRTUAL = NO 501 | 502 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 503 | # scope will be included in the documentation. 504 | # The default value is: NO. 505 | 506 | EXTRACT_PACKAGE = NO 507 | 508 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 509 | # included in the documentation. 510 | # The default value is: NO. 511 | 512 | EXTRACT_STATIC = NO 513 | 514 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 515 | # locally in source files will be included in the documentation. If set to NO, 516 | # only classes defined in header files are included. Does not have any effect 517 | # for Java sources. 518 | # The default value is: YES. 519 | 520 | EXTRACT_LOCAL_CLASSES = YES 521 | 522 | # This flag is only useful for Objective-C code. If set to YES, local methods, 523 | # which are defined in the implementation section but not in the interface are 524 | # included in the documentation. If set to NO, only methods in the interface are 525 | # included. 526 | # The default value is: NO. 527 | 528 | EXTRACT_LOCAL_METHODS = NO 529 | 530 | # If this flag is set to YES, the members of anonymous namespaces will be 531 | # extracted and appear in the documentation as a namespace called 532 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 533 | # the file that contains the anonymous namespace. By default anonymous namespace 534 | # are hidden. 535 | # The default value is: NO. 536 | 537 | EXTRACT_ANON_NSPACES = NO 538 | 539 | # If this flag is set to YES, the name of an unnamed parameter in a declaration 540 | # will be determined by the corresponding definition. By default unnamed 541 | # parameters remain unnamed in the output. 542 | # The default value is: YES. 543 | 544 | RESOLVE_UNNAMED_PARAMS = YES 545 | 546 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 547 | # undocumented members inside documented classes or files. If set to NO these 548 | # members will be included in the various overviews, but no documentation 549 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 550 | # The default value is: NO. 551 | 552 | HIDE_UNDOC_MEMBERS = NO 553 | 554 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 555 | # undocumented classes that are normally visible in the class hierarchy. If set 556 | # to NO, these classes will be included in the various overviews. This option 557 | # has no effect if EXTRACT_ALL is enabled. 558 | # The default value is: NO. 559 | 560 | HIDE_UNDOC_CLASSES = NO 561 | 562 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 563 | # declarations. If set to NO, these declarations will be included in the 564 | # documentation. 565 | # The default value is: NO. 566 | 567 | HIDE_FRIEND_COMPOUNDS = NO 568 | 569 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 570 | # documentation blocks found inside the body of a function. If set to NO, these 571 | # blocks will be appended to the function's detailed documentation block. 572 | # The default value is: NO. 573 | 574 | HIDE_IN_BODY_DOCS = NO 575 | 576 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 577 | # \internal command is included. If the tag is set to NO then the documentation 578 | # will be excluded. Set it to YES to include the internal documentation. 579 | # The default value is: NO. 580 | 581 | INTERNAL_DOCS = NO 582 | 583 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 584 | # able to match the capabilities of the underlying filesystem. In case the 585 | # filesystem is case sensitive (i.e. it supports files in the same directory 586 | # whose names only differ in casing), the option must be set to YES to properly 587 | # deal with such files in case they appear in the input. For filesystems that 588 | # are not case sensitive the option should be be set to NO to properly deal with 589 | # output files written for symbols that only differ in casing, such as for two 590 | # classes, one named CLASS and the other named Class, and to also support 591 | # references to files without having to specify the exact matching casing. On 592 | # Windows (including Cygwin) and MacOS, users should typically set this option 593 | # to NO, whereas on Linux or other Unix flavors it should typically be set to 594 | # YES. 595 | # The default value is: system dependent. 596 | 597 | CASE_SENSE_NAMES = YES 598 | 599 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 600 | # their full class and namespace scopes in the documentation. If set to YES, the 601 | # scope will be hidden. 602 | # The default value is: NO. 603 | 604 | HIDE_SCOPE_NAMES = NO 605 | 606 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 607 | # append additional text to a page's title, such as Class Reference. If set to 608 | # YES the compound reference will be hidden. 609 | # The default value is: NO. 610 | 611 | HIDE_COMPOUND_REFERENCE= NO 612 | 613 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 614 | # the files that are included by a file in the documentation of that file. 615 | # The default value is: YES. 616 | 617 | SHOW_INCLUDE_FILES = YES 618 | 619 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 620 | # grouped member an include statement to the documentation, telling the reader 621 | # which file to include in order to use the member. 622 | # The default value is: NO. 623 | 624 | SHOW_GROUPED_MEMB_INC = NO 625 | 626 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 627 | # files with double quotes in the documentation rather than with sharp brackets. 628 | # The default value is: NO. 629 | 630 | FORCE_LOCAL_INCLUDES = NO 631 | 632 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 633 | # documentation for inline members. 634 | # The default value is: YES. 635 | 636 | INLINE_INFO = YES 637 | 638 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 639 | # (detailed) documentation of file and class members alphabetically by member 640 | # name. If set to NO, the members will appear in declaration order. 641 | # The default value is: YES. 642 | 643 | SORT_MEMBER_DOCS = YES 644 | 645 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 646 | # descriptions of file, namespace and class members alphabetically by member 647 | # name. If set to NO, the members will appear in declaration order. Note that 648 | # this will also influence the order of the classes in the class list. 649 | # The default value is: NO. 650 | 651 | SORT_BRIEF_DOCS = YES 652 | 653 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 654 | # (brief and detailed) documentation of class members so that constructors and 655 | # destructors are listed first. If set to NO the constructors will appear in the 656 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 657 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 658 | # member documentation. 659 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 660 | # detailed member documentation. 661 | # The default value is: NO. 662 | 663 | SORT_MEMBERS_CTORS_1ST = NO 664 | 665 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 666 | # of group names into alphabetical order. If set to NO the group names will 667 | # appear in their defined order. 668 | # The default value is: NO. 669 | 670 | SORT_GROUP_NAMES = NO 671 | 672 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 673 | # fully-qualified names, including namespaces. If set to NO, the class list will 674 | # be sorted only by class name, not including the namespace part. 675 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 676 | # Note: This option applies only to the class list, not to the alphabetical 677 | # list. 678 | # The default value is: NO. 679 | 680 | SORT_BY_SCOPE_NAME = NO 681 | 682 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 683 | # type resolution of all parameters of a function it will reject a match between 684 | # the prototype and the implementation of a member function even if there is 685 | # only one candidate or it is obvious which candidate to choose by doing a 686 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 687 | # accept a match between prototype and implementation in such cases. 688 | # The default value is: NO. 689 | 690 | STRICT_PROTO_MATCHING = NO 691 | 692 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 693 | # list. This list is created by putting \todo commands in the documentation. 694 | # The default value is: YES. 695 | 696 | GENERATE_TODOLIST = YES 697 | 698 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 699 | # list. This list is created by putting \test commands in the documentation. 700 | # The default value is: YES. 701 | 702 | GENERATE_TESTLIST = YES 703 | 704 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 705 | # list. This list is created by putting \bug commands in the documentation. 706 | # The default value is: YES. 707 | 708 | GENERATE_BUGLIST = YES 709 | 710 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 711 | # the deprecated list. This list is created by putting \deprecated commands in 712 | # the documentation. 713 | # The default value is: YES. 714 | 715 | GENERATE_DEPRECATEDLIST= YES 716 | 717 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 718 | # sections, marked by \if ... \endif and \cond 719 | # ... \endcond blocks. 720 | 721 | ENABLED_SECTIONS = 722 | 723 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 724 | # initial value of a variable or macro / define can have for it to appear in the 725 | # documentation. If the initializer consists of more lines than specified here 726 | # it will be hidden. Use a value of 0 to hide initializers completely. The 727 | # appearance of the value of individual variables and macros / defines can be 728 | # controlled using \showinitializer or \hideinitializer command in the 729 | # documentation regardless of this setting. 730 | # Minimum value: 0, maximum value: 10000, default value: 30. 731 | 732 | MAX_INITIALIZER_LINES = 30 733 | 734 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 735 | # the bottom of the documentation of classes and structs. If set to YES, the 736 | # list will mention the files that were used to generate the documentation. 737 | # The default value is: YES. 738 | 739 | SHOW_USED_FILES = YES 740 | 741 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 742 | # will remove the Files entry from the Quick Index and from the Folder Tree View 743 | # (if specified). 744 | # The default value is: YES. 745 | 746 | SHOW_FILES = YES 747 | 748 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 749 | # page. This will remove the Namespaces entry from the Quick Index and from the 750 | # Folder Tree View (if specified). 751 | # The default value is: YES. 752 | 753 | SHOW_NAMESPACES = YES 754 | 755 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 756 | # doxygen should invoke to get the current version for each file (typically from 757 | # the version control system). Doxygen will invoke the program by executing (via 758 | # popen()) the command command input-file, where command is the value of the 759 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 760 | # by doxygen. Whatever the program writes to standard output is used as the file 761 | # version. For an example see the documentation. 762 | 763 | FILE_VERSION_FILTER = 764 | 765 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 766 | # by doxygen. The layout file controls the global structure of the generated 767 | # output files in an output format independent way. To create the layout file 768 | # that represents doxygen's defaults, run doxygen with the -l option. You can 769 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 770 | # will be used as the name of the layout file. 771 | # 772 | # Note that if you run doxygen from a directory containing a file called 773 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 774 | # tag is left empty. 775 | 776 | LAYOUT_FILE = 777 | 778 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 779 | # the reference definitions. This must be a list of .bib files. The .bib 780 | # extension is automatically appended if omitted. This requires the bibtex tool 781 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 782 | # For LaTeX the style of the bibliography can be controlled using 783 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 784 | # search path. See also \cite for info how to create references. 785 | 786 | CITE_BIB_FILES = 787 | 788 | #--------------------------------------------------------------------------- 789 | # Configuration options related to warning and progress messages 790 | #--------------------------------------------------------------------------- 791 | 792 | # The QUIET tag can be used to turn on/off the messages that are generated to 793 | # standard output by doxygen. If QUIET is set to YES this implies that the 794 | # messages are off. 795 | # The default value is: NO. 796 | 797 | QUIET = NO 798 | 799 | # The WARNINGS tag can be used to turn on/off the warning messages that are 800 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 801 | # this implies that the warnings are on. 802 | # 803 | # Tip: Turn warnings on while writing the documentation. 804 | # The default value is: YES. 805 | 806 | WARNINGS = YES 807 | 808 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 809 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 810 | # will automatically be disabled. 811 | # The default value is: YES. 812 | 813 | WARN_IF_UNDOCUMENTED = YES 814 | 815 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 816 | # potential errors in the documentation, such as not documenting some parameters 817 | # in a documented function, or documenting parameters that don't exist or using 818 | # markup commands wrongly. 819 | # The default value is: YES. 820 | 821 | WARN_IF_DOC_ERROR = YES 822 | 823 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 824 | # are documented, but have no documentation for their parameters or return 825 | # value. If set to NO, doxygen will only warn about wrong or incomplete 826 | # parameter documentation, but not about the absence of documentation. If 827 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 828 | # The default value is: NO. 829 | 830 | WARN_NO_PARAMDOC = NO 831 | 832 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 833 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 834 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 835 | # at the end of the doxygen process doxygen will return with a non-zero status. 836 | # Possible values are: NO, YES and FAIL_ON_WARNINGS. 837 | # The default value is: NO. 838 | 839 | WARN_AS_ERROR = NO 840 | 841 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 842 | # can produce. The string should contain the $file, $line, and $text tags, which 843 | # will be replaced by the file and line number from which the warning originated 844 | # and the warning text. Optionally the format may contain $version, which will 845 | # be replaced by the version of the file (if it could be obtained via 846 | # FILE_VERSION_FILTER) 847 | # The default value is: $file:$line: $text. 848 | 849 | WARN_FORMAT = "$file:$line: $text" 850 | 851 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 852 | # messages should be written. If left blank the output is written to standard 853 | # error (stderr). 854 | 855 | WARN_LOGFILE = 856 | 857 | #--------------------------------------------------------------------------- 858 | # Configuration options related to the input files 859 | #--------------------------------------------------------------------------- 860 | 861 | # The INPUT tag is used to specify the files and/or directories that contain 862 | # documented source files. You may enter file names like myfile.cpp or 863 | # directories like /usr/src/myproject. Separate the files or directories with 864 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 865 | # Note: If this tag is empty the current directory is searched. 866 | 867 | INPUT = README.md src src/cogs 868 | 869 | # This tag can be used to specify the character encoding of the source files 870 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 871 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 872 | # documentation (see: 873 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 874 | # The default value is: UTF-8. 875 | 876 | INPUT_ENCODING = UTF-8 877 | 878 | # If the value of the INPUT tag contains directories, you can use the 879 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 880 | # *.h) to filter out the source-files in the directories. 881 | # 882 | # Note that for custom extensions or not directly supported extensions you also 883 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 884 | # read by doxygen. 885 | # 886 | # Note the list of default checked file patterns might differ from the list of 887 | # default file extension mappings. 888 | # 889 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 890 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 891 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 892 | # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), 893 | # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, 894 | # *.ucf, *.qsf and *.ice. 895 | 896 | FILE_PATTERNS = *.c \ 897 | *.cc \ 898 | *.cxx \ 899 | *.cpp \ 900 | *.c++ \ 901 | *.java \ 902 | *.ii \ 903 | *.ixx \ 904 | *.ipp \ 905 | *.i++ \ 906 | *.inl \ 907 | *.idl \ 908 | *.ddl \ 909 | *.odl \ 910 | *.h \ 911 | *.hh \ 912 | *.hxx \ 913 | *.hpp \ 914 | *.h++ \ 915 | *.cs \ 916 | *.d \ 917 | *.php \ 918 | *.php4 \ 919 | *.php5 \ 920 | *.phtml \ 921 | *.inc \ 922 | *.m \ 923 | *.markdown \ 924 | *.md \ 925 | *.mm \ 926 | *.dox \ 927 | *.py \ 928 | *.pyw \ 929 | *.f90 \ 930 | *.f95 \ 931 | *.f03 \ 932 | *.f08 \ 933 | *.f18 \ 934 | *.f \ 935 | *.for \ 936 | *.vhd \ 937 | *.vhdl \ 938 | *.ucf \ 939 | *.qsf \ 940 | *.ice 941 | 942 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 943 | # be searched for input files as well. 944 | # The default value is: NO. 945 | 946 | RECURSIVE = NO 947 | 948 | # The EXCLUDE tag can be used to specify files and/or directories that should be 949 | # excluded from the INPUT source files. This way you can easily exclude a 950 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 951 | # 952 | # Note that relative paths are relative to the directory from which doxygen is 953 | # run. 954 | 955 | EXCLUDE = 956 | 957 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 958 | # directories that are symbolic links (a Unix file system feature) are excluded 959 | # from the input. 960 | # The default value is: NO. 961 | 962 | EXCLUDE_SYMLINKS = NO 963 | 964 | # If the value of the INPUT tag contains directories, you can use the 965 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 966 | # certain files from those directories. 967 | # 968 | # Note that the wildcards are matched against the file with absolute path, so to 969 | # exclude all test directories for example use the pattern */test/* 970 | 971 | EXCLUDE_PATTERNS = 972 | 973 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 974 | # (namespaces, classes, functions, etc.) that should be excluded from the 975 | # output. The symbol name can be a fully qualified name, a word, or if the 976 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 977 | # AClass::ANamespace, ANamespace::*Test 978 | # 979 | # Note that the wildcards are matched against the file with absolute path, so to 980 | # exclude all test directories use the pattern */test/* 981 | 982 | EXCLUDE_SYMBOLS = 983 | 984 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 985 | # that contain example code fragments that are included (see the \include 986 | # command). 987 | 988 | EXAMPLE_PATH = 989 | 990 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 991 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 992 | # *.h) to filter out the source-files in the directories. If left blank all 993 | # files are included. 994 | 995 | EXAMPLE_PATTERNS = * 996 | 997 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 998 | # searched for input files to be used with the \include or \dontinclude commands 999 | # irrespective of the value of the RECURSIVE tag. 1000 | # The default value is: NO. 1001 | 1002 | EXAMPLE_RECURSIVE = NO 1003 | 1004 | # The IMAGE_PATH tag can be used to specify one or more files or directories 1005 | # that contain images that are to be included in the documentation (see the 1006 | # \image command). 1007 | 1008 | IMAGE_PATH = 1009 | 1010 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 1011 | # invoke to filter for each input file. Doxygen will invoke the filter program 1012 | # by executing (via popen()) the command: 1013 | # 1014 | # 1015 | # 1016 | # where is the value of the INPUT_FILTER tag, and is the 1017 | # name of an input file. Doxygen will then use the output that the filter 1018 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 1019 | # will be ignored. 1020 | # 1021 | # Note that the filter must not add or remove lines; it is applied before the 1022 | # code is scanned, but not when the output code is generated. If lines are added 1023 | # or removed, the anchors will not be placed correctly. 1024 | # 1025 | # Note that for custom extensions or not directly supported extensions you also 1026 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1027 | # properly processed by doxygen. 1028 | 1029 | INPUT_FILTER = 1030 | 1031 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1032 | # basis. Doxygen will compare the file name with each pattern and apply the 1033 | # filter if there is a match. The filters are a list of the form: pattern=filter 1034 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1035 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1036 | # patterns match the file name, INPUT_FILTER is applied. 1037 | # 1038 | # Note that for custom extensions or not directly supported extensions you also 1039 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1040 | # properly processed by doxygen. 1041 | 1042 | FILTER_PATTERNS = 1043 | 1044 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1045 | # INPUT_FILTER) will also be used to filter the input files that are used for 1046 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1047 | # The default value is: NO. 1048 | 1049 | FILTER_SOURCE_FILES = NO 1050 | 1051 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1052 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1053 | # it is also possible to disable source filtering for a specific pattern using 1054 | # *.ext= (so without naming a filter). 1055 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1056 | 1057 | FILTER_SOURCE_PATTERNS = 1058 | 1059 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1060 | # is part of the input, its contents will be placed on the main page 1061 | # (index.html). This can be useful if you have a project on for instance GitHub 1062 | # and want to reuse the introduction page also for the doxygen output. 1063 | 1064 | USE_MDFILE_AS_MAINPAGE = README.md 1065 | 1066 | #--------------------------------------------------------------------------- 1067 | # Configuration options related to source browsing 1068 | #--------------------------------------------------------------------------- 1069 | 1070 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1071 | # generated. Documented entities will be cross-referenced with these sources. 1072 | # 1073 | # Note: To get rid of all source code in the generated output, make sure that 1074 | # also VERBATIM_HEADERS is set to NO. 1075 | # The default value is: NO. 1076 | 1077 | SOURCE_BROWSER = NO 1078 | 1079 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1080 | # classes and enums directly into the documentation. 1081 | # The default value is: NO. 1082 | 1083 | INLINE_SOURCES = NO 1084 | 1085 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1086 | # special comment blocks from generated source code fragments. Normal C, C++ and 1087 | # Fortran comments will always remain visible. 1088 | # The default value is: YES. 1089 | 1090 | STRIP_CODE_COMMENTS = YES 1091 | 1092 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1093 | # entity all documented functions referencing it will be listed. 1094 | # The default value is: NO. 1095 | 1096 | REFERENCED_BY_RELATION = NO 1097 | 1098 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1099 | # all documented entities called/used by that function will be listed. 1100 | # The default value is: NO. 1101 | 1102 | REFERENCES_RELATION = NO 1103 | 1104 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1105 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1106 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1107 | # link to the documentation. 1108 | # The default value is: YES. 1109 | 1110 | REFERENCES_LINK_SOURCE = YES 1111 | 1112 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1113 | # source code will show a tooltip with additional information such as prototype, 1114 | # brief description and links to the definition and documentation. Since this 1115 | # will make the HTML file larger and loading of large files a bit slower, you 1116 | # can opt to disable this feature. 1117 | # The default value is: YES. 1118 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1119 | 1120 | SOURCE_TOOLTIPS = YES 1121 | 1122 | # If the USE_HTAGS tag is set to YES then the references to source code will 1123 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1124 | # source browser. The htags tool is part of GNU's global source tagging system 1125 | # (see https://www.gnu.org/software/global/global.html). You will need version 1126 | # 4.8.6 or higher. 1127 | # 1128 | # To use it do the following: 1129 | # - Install the latest version of global 1130 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1131 | # - Make sure the INPUT points to the root of the source tree 1132 | # - Run doxygen as normal 1133 | # 1134 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1135 | # tools must be available from the command line (i.e. in the search path). 1136 | # 1137 | # The result: instead of the source browser generated by doxygen, the links to 1138 | # source code will now point to the output of htags. 1139 | # The default value is: NO. 1140 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1141 | 1142 | USE_HTAGS = NO 1143 | 1144 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1145 | # verbatim copy of the header file for each class for which an include is 1146 | # specified. Set to NO to disable this. 1147 | # See also: Section \class. 1148 | # The default value is: YES. 1149 | 1150 | VERBATIM_HEADERS = YES 1151 | 1152 | #--------------------------------------------------------------------------- 1153 | # Configuration options related to the alphabetical class index 1154 | #--------------------------------------------------------------------------- 1155 | 1156 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1157 | # compounds will be generated. Enable this if the project contains a lot of 1158 | # classes, structs, unions or interfaces. 1159 | # The default value is: YES. 1160 | 1161 | ALPHABETICAL_INDEX = YES 1162 | 1163 | # In case all classes in a project start with a common prefix, all classes will 1164 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1165 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1166 | # while generating the index headers. 1167 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1168 | 1169 | IGNORE_PREFIX = 1170 | 1171 | #--------------------------------------------------------------------------- 1172 | # Configuration options related to the HTML output 1173 | #--------------------------------------------------------------------------- 1174 | 1175 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1176 | # The default value is: YES. 1177 | 1178 | GENERATE_HTML = YES 1179 | 1180 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1181 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1182 | # it. 1183 | # The default directory is: html. 1184 | # This tag requires that the tag GENERATE_HTML is set to YES. 1185 | 1186 | HTML_OUTPUT = html 1187 | 1188 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1189 | # generated HTML page (for example: .htm, .php, .asp). 1190 | # The default value is: .html. 1191 | # This tag requires that the tag GENERATE_HTML is set to YES. 1192 | 1193 | HTML_FILE_EXTENSION = .html 1194 | 1195 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1196 | # each generated HTML page. If the tag is left blank doxygen will generate a 1197 | # standard header. 1198 | # 1199 | # To get valid HTML the header file that includes any scripts and style sheets 1200 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1201 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1202 | # default header using 1203 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1204 | # YourConfigFile 1205 | # and then modify the file new_header.html. See also section "Doxygen usage" 1206 | # for information on how to generate the default header that doxygen normally 1207 | # uses. 1208 | # Note: The header is subject to change so you typically have to regenerate the 1209 | # default header when upgrading to a newer version of doxygen. For a description 1210 | # of the possible markers and block names see the documentation. 1211 | # This tag requires that the tag GENERATE_HTML is set to YES. 1212 | 1213 | HTML_HEADER = 1214 | 1215 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1216 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1217 | # footer. See HTML_HEADER for more information on how to generate a default 1218 | # footer and what special commands can be used inside the footer. See also 1219 | # section "Doxygen usage" for information on how to generate the default footer 1220 | # that doxygen normally uses. 1221 | # This tag requires that the tag GENERATE_HTML is set to YES. 1222 | 1223 | HTML_FOOTER = 1224 | 1225 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1226 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1227 | # the HTML output. If left blank doxygen will generate a default style sheet. 1228 | # See also section "Doxygen usage" for information on how to generate the style 1229 | # sheet that doxygen normally uses. 1230 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1231 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1232 | # obsolete. 1233 | # This tag requires that the tag GENERATE_HTML is set to YES. 1234 | 1235 | HTML_STYLESHEET = 1236 | 1237 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1238 | # cascading style sheets that are included after the standard style sheets 1239 | # created by doxygen. Using this option one can overrule certain style aspects. 1240 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1241 | # standard style sheet and is therefore more robust against future updates. 1242 | # Doxygen will copy the style sheet files to the output directory. 1243 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1244 | # style sheet in the list overrules the setting of the previous ones in the 1245 | # list). For an example see the documentation. 1246 | # This tag requires that the tag GENERATE_HTML is set to YES. 1247 | 1248 | HTML_EXTRA_STYLESHEET = 1249 | 1250 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1251 | # other source files which should be copied to the HTML output directory. Note 1252 | # that these files will be copied to the base HTML output directory. Use the 1253 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1254 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1255 | # files will be copied as-is; there are no commands or markers available. 1256 | # This tag requires that the tag GENERATE_HTML is set to YES. 1257 | 1258 | HTML_EXTRA_FILES = 1259 | 1260 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1261 | # will adjust the colors in the style sheet and background images according to 1262 | # this color. Hue is specified as an angle on a colorwheel, see 1263 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1264 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1265 | # purple, and 360 is red again. 1266 | # Minimum value: 0, maximum value: 359, default value: 220. 1267 | # This tag requires that the tag GENERATE_HTML is set to YES. 1268 | 1269 | HTML_COLORSTYLE_HUE = 220 1270 | 1271 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1272 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1273 | # value of 255 will produce the most vivid colors. 1274 | # Minimum value: 0, maximum value: 255, default value: 100. 1275 | # This tag requires that the tag GENERATE_HTML is set to YES. 1276 | 1277 | HTML_COLORSTYLE_SAT = 100 1278 | 1279 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1280 | # luminance component of the colors in the HTML output. Values below 100 1281 | # gradually make the output lighter, whereas values above 100 make the output 1282 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1283 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1284 | # change the gamma. 1285 | # Minimum value: 40, maximum value: 240, default value: 80. 1286 | # This tag requires that the tag GENERATE_HTML is set to YES. 1287 | 1288 | HTML_COLORSTYLE_GAMMA = 80 1289 | 1290 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1291 | # page will contain the date and time when the page was generated. Setting this 1292 | # to YES can help to show when doxygen was last run and thus if the 1293 | # documentation is up to date. 1294 | # The default value is: NO. 1295 | # This tag requires that the tag GENERATE_HTML is set to YES. 1296 | 1297 | HTML_TIMESTAMP = NO 1298 | 1299 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1300 | # documentation will contain a main index with vertical navigation menus that 1301 | # are dynamically created via JavaScript. If disabled, the navigation index will 1302 | # consists of multiple levels of tabs that are statically embedded in every HTML 1303 | # page. Disable this option to support browsers that do not have JavaScript, 1304 | # like the Qt help browser. 1305 | # The default value is: YES. 1306 | # This tag requires that the tag GENERATE_HTML is set to YES. 1307 | 1308 | HTML_DYNAMIC_MENUS = YES 1309 | 1310 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1311 | # documentation will contain sections that can be hidden and shown after the 1312 | # page has loaded. 1313 | # The default value is: NO. 1314 | # This tag requires that the tag GENERATE_HTML is set to YES. 1315 | 1316 | HTML_DYNAMIC_SECTIONS = NO 1317 | 1318 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1319 | # shown in the various tree structured indices initially; the user can expand 1320 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1321 | # such a level that at most the specified number of entries are visible (unless 1322 | # a fully collapsed tree already exceeds this amount). So setting the number of 1323 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1324 | # representing an infinite number of entries and will result in a full expanded 1325 | # tree by default. 1326 | # Minimum value: 0, maximum value: 9999, default value: 100. 1327 | # This tag requires that the tag GENERATE_HTML is set to YES. 1328 | 1329 | HTML_INDEX_NUM_ENTRIES = 100 1330 | 1331 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1332 | # generated that can be used as input for Apple's Xcode 3 integrated development 1333 | # environment (see: 1334 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1335 | # create a documentation set, doxygen will generate a Makefile in the HTML 1336 | # output directory. Running make will produce the docset in that directory and 1337 | # running make install will install the docset in 1338 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1339 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1340 | # genXcode/_index.html for more information. 1341 | # The default value is: NO. 1342 | # This tag requires that the tag GENERATE_HTML is set to YES. 1343 | 1344 | GENERATE_DOCSET = NO 1345 | 1346 | # This tag determines the name of the docset feed. A documentation feed provides 1347 | # an umbrella under which multiple documentation sets from a single provider 1348 | # (such as a company or product suite) can be grouped. 1349 | # The default value is: Doxygen generated docs. 1350 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1351 | 1352 | DOCSET_FEEDNAME = "Doxygen generated docs" 1353 | 1354 | # This tag specifies a string that should uniquely identify the documentation 1355 | # set bundle. This should be a reverse domain-name style string, e.g. 1356 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1357 | # The default value is: org.doxygen.Project. 1358 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1359 | 1360 | DOCSET_BUNDLE_ID = org.doxygen.Project 1361 | 1362 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1363 | # the documentation publisher. This should be a reverse domain-name style 1364 | # string, e.g. com.mycompany.MyDocSet.documentation. 1365 | # The default value is: org.doxygen.Publisher. 1366 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1367 | 1368 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1369 | 1370 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1371 | # The default value is: Publisher. 1372 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1373 | 1374 | DOCSET_PUBLISHER_NAME = Publisher 1375 | 1376 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1377 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1378 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1379 | # (see: 1380 | # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. 1381 | # 1382 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1383 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1384 | # files are now used as the Windows 98 help format, and will replace the old 1385 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1386 | # HTML files also contain an index, a table of contents, and you can search for 1387 | # words in the documentation. The HTML workshop also contains a viewer for 1388 | # compressed HTML files. 1389 | # The default value is: NO. 1390 | # This tag requires that the tag GENERATE_HTML is set to YES. 1391 | 1392 | GENERATE_HTMLHELP = NO 1393 | 1394 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1395 | # file. You can add a path in front of the file if the result should not be 1396 | # written to the html output directory. 1397 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1398 | 1399 | CHM_FILE = 1400 | 1401 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1402 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1403 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1404 | # The file has to be specified with full path. 1405 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1406 | 1407 | HHC_LOCATION = 1408 | 1409 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1410 | # (YES) or that it should be included in the main .chm file (NO). 1411 | # The default value is: NO. 1412 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1413 | 1414 | GENERATE_CHI = NO 1415 | 1416 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1417 | # and project file content. 1418 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1419 | 1420 | CHM_INDEX_ENCODING = 1421 | 1422 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1423 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1424 | # enables the Previous and Next buttons. 1425 | # The default value is: NO. 1426 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1427 | 1428 | BINARY_TOC = NO 1429 | 1430 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1431 | # the table of contents of the HTML help documentation and to the tree view. 1432 | # The default value is: NO. 1433 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1434 | 1435 | TOC_EXPAND = NO 1436 | 1437 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1438 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1439 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1440 | # (.qch) of the generated HTML documentation. 1441 | # The default value is: NO. 1442 | # This tag requires that the tag GENERATE_HTML is set to YES. 1443 | 1444 | GENERATE_QHP = NO 1445 | 1446 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1447 | # the file name of the resulting .qch file. The path specified is relative to 1448 | # the HTML output folder. 1449 | # This tag requires that the tag GENERATE_QHP is set to YES. 1450 | 1451 | QCH_FILE = 1452 | 1453 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1454 | # Project output. For more information please see Qt Help Project / Namespace 1455 | # (see: 1456 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1457 | # The default value is: org.doxygen.Project. 1458 | # This tag requires that the tag GENERATE_QHP is set to YES. 1459 | 1460 | QHP_NAMESPACE = org.doxygen.Project 1461 | 1462 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1463 | # Help Project output. For more information please see Qt Help Project / Virtual 1464 | # Folders (see: 1465 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1466 | # The default value is: doc. 1467 | # This tag requires that the tag GENERATE_QHP is set to YES. 1468 | 1469 | QHP_VIRTUAL_FOLDER = doc 1470 | 1471 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1472 | # filter to add. For more information please see Qt Help Project / Custom 1473 | # Filters (see: 1474 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1475 | # This tag requires that the tag GENERATE_QHP is set to YES. 1476 | 1477 | QHP_CUST_FILTER_NAME = 1478 | 1479 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1480 | # custom filter to add. For more information please see Qt Help Project / Custom 1481 | # Filters (see: 1482 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1483 | # This tag requires that the tag GENERATE_QHP is set to YES. 1484 | 1485 | QHP_CUST_FILTER_ATTRS = 1486 | 1487 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1488 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1489 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1490 | # This tag requires that the tag GENERATE_QHP is set to YES. 1491 | 1492 | QHP_SECT_FILTER_ATTRS = 1493 | 1494 | # The QHG_LOCATION tag can be used to specify the location (absolute path 1495 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1496 | # run qhelpgenerator on the generated .qhp file. 1497 | # This tag requires that the tag GENERATE_QHP is set to YES. 1498 | 1499 | QHG_LOCATION = 1500 | 1501 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1502 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1503 | # install this plugin and make it available under the help contents menu in 1504 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1505 | # to be copied into the plugins directory of eclipse. The name of the directory 1506 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1507 | # After copying Eclipse needs to be restarted before the help appears. 1508 | # The default value is: NO. 1509 | # This tag requires that the tag GENERATE_HTML is set to YES. 1510 | 1511 | GENERATE_ECLIPSEHELP = NO 1512 | 1513 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1514 | # the directory name containing the HTML and XML files should also have this 1515 | # name. Each documentation set should have its own identifier. 1516 | # The default value is: org.doxygen.Project. 1517 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1518 | 1519 | ECLIPSE_DOC_ID = org.doxygen.Project 1520 | 1521 | # If you want full control over the layout of the generated HTML pages it might 1522 | # be necessary to disable the index and replace it with your own. The 1523 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1524 | # of each HTML page. A value of NO enables the index and the value YES disables 1525 | # it. Since the tabs in the index contain the same information as the navigation 1526 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1527 | # The default value is: NO. 1528 | # This tag requires that the tag GENERATE_HTML is set to YES. 1529 | 1530 | DISABLE_INDEX = NO 1531 | 1532 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1533 | # structure should be generated to display hierarchical information. If the tag 1534 | # value is set to YES, a side panel will be generated containing a tree-like 1535 | # index structure (just like the one that is generated for HTML Help). For this 1536 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1537 | # (i.e. any modern browser). Windows users are probably better off using the 1538 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1539 | # further fine-tune the look of the index. As an example, the default style 1540 | # sheet generated by doxygen has an example that shows how to put an image at 1541 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1542 | # the same information as the tab index, you could consider setting 1543 | # DISABLE_INDEX to YES when enabling this option. 1544 | # The default value is: NO. 1545 | # This tag requires that the tag GENERATE_HTML is set to YES. 1546 | 1547 | GENERATE_TREEVIEW = NO 1548 | 1549 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1550 | # doxygen will group on one line in the generated HTML documentation. 1551 | # 1552 | # Note that a value of 0 will completely suppress the enum values from appearing 1553 | # in the overview section. 1554 | # Minimum value: 0, maximum value: 20, default value: 4. 1555 | # This tag requires that the tag GENERATE_HTML is set to YES. 1556 | 1557 | ENUM_VALUES_PER_LINE = 4 1558 | 1559 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1560 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1561 | # Minimum value: 0, maximum value: 1500, default value: 250. 1562 | # This tag requires that the tag GENERATE_HTML is set to YES. 1563 | 1564 | TREEVIEW_WIDTH = 250 1565 | 1566 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1567 | # external symbols imported via tag files in a separate window. 1568 | # The default value is: NO. 1569 | # This tag requires that the tag GENERATE_HTML is set to YES. 1570 | 1571 | EXT_LINKS_IN_WINDOW = NO 1572 | 1573 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1574 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1575 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1576 | # the HTML output. These images will generally look nicer at scaled resolutions. 1577 | # Possible values are: png (the default) and svg (looks nicer but requires the 1578 | # pdf2svg or inkscape tool). 1579 | # The default value is: png. 1580 | # This tag requires that the tag GENERATE_HTML is set to YES. 1581 | 1582 | HTML_FORMULA_FORMAT = png 1583 | 1584 | # Use this tag to change the font size of LaTeX formulas included as images in 1585 | # the HTML documentation. When you change the font size after a successful 1586 | # doxygen run you need to manually remove any form_*.png images from the HTML 1587 | # output directory to force them to be regenerated. 1588 | # Minimum value: 8, maximum value: 50, default value: 10. 1589 | # This tag requires that the tag GENERATE_HTML is set to YES. 1590 | 1591 | FORMULA_FONTSIZE = 10 1592 | 1593 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1594 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1595 | # supported properly for IE 6.0, but are supported on all modern browsers. 1596 | # 1597 | # Note that when changing this option you need to delete any form_*.png files in 1598 | # the HTML output directory before the changes have effect. 1599 | # The default value is: YES. 1600 | # This tag requires that the tag GENERATE_HTML is set to YES. 1601 | 1602 | FORMULA_TRANSPARENT = YES 1603 | 1604 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1605 | # to create new LaTeX commands to be used in formulas as building blocks. See 1606 | # the section "Including formulas" for details. 1607 | 1608 | FORMULA_MACROFILE = 1609 | 1610 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1611 | # https://www.mathjax.org) which uses client side JavaScript for the rendering 1612 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1613 | # installed or if you want to formulas look prettier in the HTML output. When 1614 | # enabled you may also need to install MathJax separately and configure the path 1615 | # to it using the MATHJAX_RELPATH option. 1616 | # The default value is: NO. 1617 | # This tag requires that the tag GENERATE_HTML is set to YES. 1618 | 1619 | USE_MATHJAX = NO 1620 | 1621 | # When MathJax is enabled you can set the default output format to be used for 1622 | # the MathJax output. See the MathJax site (see: 1623 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. 1624 | # Possible values are: HTML-CSS (which is slower, but has the best 1625 | # compatibility), NativeMML (i.e. MathML) and SVG. 1626 | # The default value is: HTML-CSS. 1627 | # This tag requires that the tag USE_MATHJAX is set to YES. 1628 | 1629 | MATHJAX_FORMAT = HTML-CSS 1630 | 1631 | # When MathJax is enabled you need to specify the location relative to the HTML 1632 | # output directory using the MATHJAX_RELPATH option. The destination directory 1633 | # should contain the MathJax.js script. For instance, if the mathjax directory 1634 | # is located at the same level as the HTML output directory, then 1635 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1636 | # Content Delivery Network so you can quickly see the result without installing 1637 | # MathJax. However, it is strongly recommended to install a local copy of 1638 | # MathJax from https://www.mathjax.org before deployment. 1639 | # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. 1640 | # This tag requires that the tag USE_MATHJAX is set to YES. 1641 | 1642 | MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 1643 | 1644 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1645 | # extension names that should be enabled during MathJax rendering. For example 1646 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1647 | # This tag requires that the tag USE_MATHJAX is set to YES. 1648 | 1649 | MATHJAX_EXTENSIONS = 1650 | 1651 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1652 | # of code that will be used on startup of the MathJax code. See the MathJax site 1653 | # (see: 1654 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1655 | # example see the documentation. 1656 | # This tag requires that the tag USE_MATHJAX is set to YES. 1657 | 1658 | MATHJAX_CODEFILE = 1659 | 1660 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1661 | # the HTML output. The underlying search engine uses javascript and DHTML and 1662 | # should work on any modern browser. Note that when using HTML help 1663 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1664 | # there is already a search function so this one should typically be disabled. 1665 | # For large projects the javascript based search engine can be slow, then 1666 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1667 | # search using the keyboard; to jump to the search box use + S 1668 | # (what the is depends on the OS and browser, but it is typically 1669 | # , /