├── CHANGELOG.md ├── LICENSE.md ├── .gitattributes ├── Documentation~ ├── doxygen-awesome.7z └── Doxyfile ├── CHANGELOG.md.meta ├── LICENSE.md.meta ├── README.md.meta ├── package.json.meta ├── Runtime.meta ├── Runtime ├── ILockable.cs ├── Nebukam.JobAssist.asmdef.meta ├── Extensions.cs.meta ├── ILockable.cs.meta ├── Processor.cs.meta ├── AbstractProcessor.cs.meta ├── ParallelProcessor.cs.meta ├── PlaceholderJobs.cs.meta ├── ProcessorChain.cs.meta ├── ProcessorGroup.cs.meta ├── AbstractProcessorCompound.cs.meta ├── Nebukam.JobAssist.asmdef ├── PlaceholderJobs.cs ├── Processor.cs ├── ParallelProcessor.cs ├── ProcessorGroup.cs ├── ProcessorChain.cs ├── AbstractProcessor.cs ├── AbstractProcessorCompound.cs └── Extensions.cs ├── Samples~ └── JobStacking │ ├── JobStackingExample.cs.meta │ └── JobStackingExample.cs ├── .github └── workflows │ └── main.yml ├── package.json ├── .gitignore └── README.md /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /Documentation~/doxygen-awesome.7z: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Nebukam/com.nebukam.job-assist/HEAD/Documentation~/doxygen-awesome.7z -------------------------------------------------------------------------------- /CHANGELOG.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 3d04cbc32cf609a4192b929e0b9955d9 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /LICENSE.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: a26b1e901828e1c41a0b9461220e21da 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /README.md.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: eefcee9eca6909944b4d5c69f7cd0176 3 | TextScriptImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /package.json.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: eb8c386aedc5e5042a577c162b3bec9a 3 | PackageManifestImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /Runtime.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: dd92794db23410d43aab9d390205ca03 3 | folderAsset: yes 4 | DefaultImporter: 5 | externalObjects: {} 6 | userData: 7 | assetBundleName: 8 | assetBundleVariant: 9 | -------------------------------------------------------------------------------- /Runtime/ILockable.cs: -------------------------------------------------------------------------------- 1 | namespace Nebukam.JobAssist 2 | { 3 | public interface ILockable 4 | { 5 | bool locked { get; } 6 | void Lock(); 7 | void Unlock(); 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /Runtime/Nebukam.JobAssist.asmdef.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 34f6ec2a853fbf54d972f1af68f2ffae 3 | AssemblyDefinitionImporter: 4 | externalObjects: {} 5 | userData: 6 | assetBundleName: 7 | assetBundleVariant: 8 | -------------------------------------------------------------------------------- /Runtime/Extensions.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: eb8102587f2882248949dd85666281a7 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/ILockable.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 5e8da583b32cc534c871738ad76b90a6 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/Processor.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: a76f1b180a6680044ae880b02f16795f 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/AbstractProcessor.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: ae7cfb3b357eb1a41a3b4f32fed637b2 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/ParallelProcessor.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 0b30d34211db4b04c8823b6508040b01 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/PlaceholderJobs.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 33d7e9e5498b86a43a6ea051d596e76b 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/ProcessorChain.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 75e4853b669368843bcddc973c0f4578 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/ProcessorGroup.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 7ae87af6d6cfbb54f9982ef37554e302 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/AbstractProcessorCompound.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 6a5433315301b8748aba4dd6f0c70b20 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Samples~/JobStacking/JobStackingExample.cs.meta: -------------------------------------------------------------------------------- 1 | fileFormatVersion: 2 2 | guid: 8fc3e61e2489f0a4a88f8c65bb554e31 3 | MonoImporter: 4 | externalObjects: {} 5 | serializedVersion: 2 6 | defaultReferences: [] 7 | executionOrder: 0 8 | icon: {instanceID: 0} 9 | userData: 10 | assetBundleName: 11 | assetBundleVariant: 12 | -------------------------------------------------------------------------------- /Runtime/Nebukam.JobAssist.asmdef: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Nebukam.JobAssist", 3 | "references": [ 4 | "GUID:2665a8d13d1b3f18800f46e256720795", 5 | "GUID:e0cd26848372d4e5c891c569017e11f1", 6 | "GUID:8a2eafa29b15f444eb6d74f94a930e1d" 7 | ], 8 | "includePlatforms": [], 9 | "excludePlatforms": [], 10 | "allowUnsafeCode": true, 11 | "overrideReferences": false, 12 | "precompiledReferences": [], 13 | "autoReferenced": true, 14 | "defineConstraints": [], 15 | "versionDefines": [] 16 | } -------------------------------------------------------------------------------- /Runtime/PlaceholderJobs.cs: -------------------------------------------------------------------------------- 1 | using Unity.Burst; 2 | using Unity.Jobs; 3 | 4 | namespace Nebukam.JobAssist 5 | { 6 | 7 | [BurstCompile] 8 | public struct DisabledProcessor : IJob { public void Execute() { } } 9 | 10 | [BurstCompile] 11 | public struct Unemployed : IJob { public void Execute() { } } 12 | 13 | [BurstCompile] 14 | public struct UnemployedParallel : IJobParallelFor { public void Execute(int index) { } } 15 | 16 | [BurstCompile] 17 | public struct EmptyCompound : IJob { public void Execute() { } } 18 | 19 | } 20 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | on: 3 | push: 4 | branches: 5 | - master 6 | 7 | jobs: 8 | build: 9 | name: Release 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Checkout 13 | uses: actions/checkout@v2 14 | with: 15 | fetch-depth: 0 16 | - name: Automatic GitHub Release 17 | uses: justincy/github-action-npm-release@2.0.2 18 | id: release 19 | - name: Print release output 20 | if: ${{ steps.release.outputs.released == 'true' }} 21 | run: echo Release ID ${{ steps.release.outputs.release_id }} 22 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "com.nebukam.job-assist", 3 | "version": "1.1.6", 4 | "displayName": "N:JobAssist", 5 | "description": "Micro helper library for Unity's Job System", 6 | "unity": "2022.1", 7 | "unityRelease": "0f1", 8 | "documentationUrl":"https://nebukam.github.io/docs/unity/com.nebukam.job-assist/", 9 | "keywords": [ 10 | "Job" 11 | ], 12 | "category": "Job System", 13 | "author": { 14 | "name": "Timothe Lapetite", 15 | "email": "nebukam@gmail.com", 16 | "url": "https://github.com/Nebukam/com.nebukam.job-assist" 17 | }, 18 | "dependencies": { 19 | "com.unity.burst": "1.8.17", 20 | "com.unity.jobs": "0.70.0-preview.7", 21 | "com.unity.collections": "1.3.1" 22 | }, 23 | "samples": [ 24 | { 25 | "displayName": "JobStacking", 26 | "description": "Job Stacking example.", 27 | "path": "Samples~/JobStacking" 28 | } 29 | ] 30 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # This .gitignore file should be placed at the root of your Unity project directory 2 | # 3 | # Get latest from https://github.com/github/gitignore/blob/master/Unity.gitignore 4 | # 5 | /[Ll]ibrary/ 6 | /[Tt]emp/ 7 | /[Oo]bj/ 8 | /[Bb]uild/ 9 | /[Bb]uilds/ 10 | /[Ll]ogs/ 11 | /[Mm]emoryCaptures/ 12 | 13 | # Never ignore Asset meta data 14 | !/[Aa]ssets/**/*.meta 15 | 16 | # Uncomment this line if you wish to ignore the asset store tools plugin 17 | # /[Aa]ssets/AssetStoreTools* 18 | 19 | # TextMesh Pro files 20 | [Aa]ssets/TextMesh*Pro/ 21 | 22 | # Autogenerated Jetbrains Rider plugin 23 | [Aa]ssets/Plugins/Editor/JetBrains* 24 | 25 | # Visual Studio cache directory 26 | .vs/ 27 | 28 | # Gradle cache directory 29 | .gradle/ 30 | 31 | # Autogenerated VS/MD/Consulo solution and project files 32 | ExportedObj/ 33 | .consulo/ 34 | *.csproj 35 | *.unityproj 36 | *.sln 37 | *.suo 38 | *.tmp 39 | *.user 40 | *.userprefs 41 | *.pidb 42 | *.booproj 43 | *.svd 44 | *.pdb 45 | *.mdb 46 | *.opendb 47 | *.VC.db 48 | 49 | # Unity3D generated meta files 50 | *.pidb.meta 51 | *.pdb.meta 52 | *.mdb.meta 53 | 54 | # Unity3D generated file on crash reports 55 | sysinfo.txt 56 | 57 | # Builds 58 | *.apk 59 | *.unitypackage 60 | 61 | # Crashlytics generated file 62 | crashlytics-build.properties 63 | 64 | -------------------------------------------------------------------------------- /Runtime/Processor.cs: -------------------------------------------------------------------------------- 1 | using Unity.Collections; 2 | using Unity.Jobs; 3 | 4 | namespace Nebukam.JobAssist 5 | { 6 | 7 | public abstract class Processor : AbstractProcessor, IProcessor 8 | where T : struct, IJob 9 | { 10 | 11 | protected T m_currentJob; 12 | 13 | #region Scheduling 14 | 15 | internal override void OnPrepare() 16 | { 17 | Prepare(ref m_currentJob, m_scaledLockedDelta); 18 | } 19 | 20 | internal override JobHandle OnScheduled(IProcessor dependsOn = null) 21 | { 22 | return dependsOn == null 23 | ? m_currentJob.Schedule() 24 | : m_currentJob.Schedule(dependsOn.currentHandle); 25 | } 26 | 27 | internal override JobHandle OnScheduled(JobHandle dependsOn) 28 | { 29 | return m_currentJob.Schedule(dependsOn); 30 | } 31 | 32 | protected abstract void Prepare(ref T job, float delta); 33 | 34 | #endregion 35 | 36 | #region Complete & Apply 37 | 38 | protected sealed override void OnCompleteBegins() 39 | { 40 | m_currentHandle.Complete(); 41 | } 42 | 43 | protected sealed override void OnCompleteEnds() 44 | { 45 | Apply(ref m_currentJob); 46 | } 47 | 48 | protected virtual void Apply(ref T job) { } 49 | 50 | #endregion 51 | 52 | #region ILockable 53 | 54 | public sealed override void Lock() 55 | { 56 | if (m_locked) { return; } 57 | m_currentJob = default; 58 | base.Lock(); 59 | } 60 | 61 | public sealed override void Unlock(){ 62 | base.Unlock(); 63 | } 64 | 65 | #endregion 66 | 67 | } 68 | 69 | } 70 | -------------------------------------------------------------------------------- /Runtime/ParallelProcessor.cs: -------------------------------------------------------------------------------- 1 | using Unity.Collections; 2 | using Unity.Jobs; 3 | 4 | namespace Nebukam.JobAssist 5 | { 6 | 7 | public interface IParallelProcessor : IProcessor 8 | { 9 | int chunkSize { get; set; } 10 | } 11 | 12 | 13 | public abstract class ParallelProcessor : AbstractProcessor, IParallelProcessor 14 | where T : struct, IJobParallelFor 15 | { 16 | 17 | protected T m_currentJob; 18 | public int chunkSize { get; set; } = 64; 19 | 20 | protected int m_jobLength = 0; 21 | 22 | #region Scheduling 23 | 24 | internal override void OnPrepare() 25 | { 26 | m_jobLength = Prepare(ref m_currentJob, m_scaledLockedDelta); 27 | } 28 | 29 | internal override JobHandle OnScheduled(IProcessor dependsOn = null) 30 | { 31 | return dependsOn == null 32 | ? m_currentJob.Schedule(m_jobLength, chunkSize) 33 | : m_currentJob.Schedule(m_jobLength, chunkSize, dependsOn.currentHandle); 34 | } 35 | 36 | internal override JobHandle OnScheduled(JobHandle dependsOn) 37 | { 38 | return m_currentJob.Schedule(m_jobLength, chunkSize, dependsOn); 39 | } 40 | 41 | protected abstract int Prepare(ref T job, float delta); 42 | 43 | #endregion 44 | 45 | #region Complete & Apply 46 | 47 | protected sealed override void OnCompleteBegins() 48 | { 49 | m_currentHandle.Complete(); 50 | } 51 | 52 | protected sealed override void OnCompleteEnds() 53 | { 54 | Apply(ref m_currentJob); 55 | } 56 | 57 | protected virtual void Apply(ref T job) { } 58 | 59 | #endregion 60 | 61 | #region ILockable 62 | 63 | public sealed override void Lock() 64 | { 65 | if (m_locked) { return; } 66 | m_currentJob = default; 67 | base.Lock(); 68 | } 69 | 70 | public sealed override void Unlock() 71 | { 72 | base.Unlock(); 73 | } 74 | 75 | #endregion 76 | 77 | } 78 | 79 | } 80 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![stable](https://img.shields.io/badge/stable-darkgreen.svg) 2 | ![version](https://img.shields.io/badge/dynamic/json?color=blue&label=version&query=version&url=https%3A%2F%2Fraw.githubusercontent.com%2FNebukam%2Fcom.nebukam.job-assist%2Fmaster%2Fpackage.json) 3 | ![in development](https://img.shields.io/badge/status-in%20development-blue.svg) 4 | [![doc](https://img.shields.io/badge/documentation-darkgreen.svg)](https://nebukam.github.io/docs/unity/com.nebukam.job-assist/) 5 | 6 | # N:JobAssist 7 | #### Helper library for Unity's Job System 8 | 9 | N:JobAssist is a mini-library that help streamlining interactions with Unity's Job System through wrappers, grouping and chaining automation. 10 | It was initially designed for [**N:ORCA**](https://github.com/Nebukam/com.nebukam.orca) & [**N:Geom**](https://github.com/Nebukam/com.nebukam.geom), but ended in its own package for practical purposes. 11 | 12 | --- 13 | ## Hows 14 | 15 | ### Installation 16 | > To be used with [Unity's Package Manager](https://docs.unity3d.com/Manual/upm-ui-giturl.html). 17 | > ⚠ [Git Dependency Resolver For Unity](https://github.com/mob-sakai/GitDependencyResolverForUnity) must be installed *before* in order to fetch nested git dependencies. (See the [Installation troubleshooting](#installation-troubleshooting) if you encounter issues). 18 | 19 | See [Unity's Package Manager : Getting Started](https://docs.unity3d.com/Manual/upm-parts.html) 20 | 21 | --- 22 | ## Dependencies 23 | - **Unity.Collections 1.3.1** [com.unity.collections]() 24 | - **Unity.Jobs 0.51.0** [com.unity.jobs]() 25 | 26 | --- 27 | ## Installation Troubleshooting 28 | 29 | After installing this package, Unity may complain about missing namespace references error (effectively located in dependencies). What [Git Dependency Resolver For Unity](https://github.com/mob-sakai/GitDependencyResolverForUnity) does, instead of editing your project's package.json, is create local copies of the git repo *effectively acting as custom local packages*. 30 | Hence, if you encounter issues, try the following: 31 | - In the project explorer, do a ```Reimport All``` on the **Packages** folder (located at the same level as **Assets** & **Favorites**). This should do the trick. 32 | - Delete Library/ScriptAssemblies from you project, then ```Reimport All```. 33 | - Check the [Resolver usage for users](https://github.com/mob-sakai/GitDependencyResolverForUnity#usage) 34 | 35 | 36 | -------------------------------------------------------------------------------- /Samples~/JobStacking/JobStackingExample.cs: -------------------------------------------------------------------------------- 1 | using System.Collections; 2 | using System.Collections.Generic; 3 | using UnityEngine; 4 | using Unity.Jobs; 5 | using Unity.Collections; 6 | 7 | namespace Nebukam.JobAssist.Examples 8 | { 9 | 10 | public class JobStackingExample : MonoBehaviour 11 | { 12 | 13 | JobStack jobStack = new JobStack(); 14 | 15 | void Start() 16 | { 17 | 18 | SimpleJobHandler A = new SimpleJobHandler("A"); 19 | SimpleJobHandler B = new SimpleJobHandler("B"); 20 | SimpleJobHandler C = new SimpleJobHandler("C"); 21 | SimpleJobHandler D = new SimpleJobHandler("D"); 22 | 23 | jobStack.Add(A); 24 | jobStack.Add(B); 25 | jobStack.Add(C); 26 | jobStack.Add(D); 27 | 28 | } 29 | 30 | void Update() 31 | { 32 | //Schedule like a normal job. 33 | jobStack.Schedule(Time.deltaTime); 34 | } 35 | 36 | void LateUpdate() 37 | { 38 | //Completeting the stack will ensure Complete() is called 39 | //in order in each registered job. 40 | jobStack.Complete(); 41 | } 42 | 43 | } 44 | 45 | public class SimpleJobHandler : JobHandler 46 | { 47 | 48 | protected int index = 1; 49 | protected string m_id = string.Empty; 50 | 51 | protected NativeArray m_result = new NativeArray(1, Allocator.Persistent); 52 | 53 | public SimpleJobHandler(string ID) 54 | { 55 | m_id = ID; 56 | } 57 | 58 | protected override void Prepare(ref SimpleJob job, float delta) 59 | { 60 | //Prepare the job, fill values etc 61 | job.val = index; 62 | job.results = m_result; 63 | } 64 | 65 | protected override void Apply(ref SimpleJob job) 66 | { 67 | //Apply the results of the job 68 | index = m_result[0]; 69 | Debug.Log(m_id+" : "+ index); 70 | } 71 | 72 | } 73 | 74 | public struct SimpleJob : IJob 75 | { 76 | 77 | public int val; 78 | public NativeArray results; 79 | 80 | public void Execute() 81 | { 82 | results [0] = val + 1; 83 | //Execute your job... 84 | } 85 | } 86 | 87 | 88 | } 89 | -------------------------------------------------------------------------------- /Runtime/ProcessorGroup.cs: -------------------------------------------------------------------------------- 1 | using Unity.Collections; 2 | using Unity.Jobs; 3 | using static Nebukam.JobAssist.Extensions; 4 | 5 | namespace Nebukam.JobAssist 6 | { 7 | 8 | public interface IProcessorGroup : IProcessorCompound 9 | { 10 | 11 | } 12 | 13 | /// 14 | /// A ProcessorGroup starts its child processors at the same time 15 | /// and return a combined handle 16 | /// 17 | public abstract class ProcessorGroup : AbstractProcessorCompound, IProcessorGroup 18 | { 19 | 20 | protected NativeArray m_groupHandles = default; 21 | 22 | #region Scheduling 23 | 24 | internal override void OnPrepare() 25 | { 26 | MakeLength(ref m_groupHandles, m_enabledChildren); 27 | base.OnPrepare(); 28 | } 29 | 30 | internal override JobHandle OnScheduled(IProcessor dependsOn = null) 31 | { 32 | 33 | if (m_isCompoundEmpty) { return ScheduleEmpty(dependsOn); } 34 | 35 | int count = Count; 36 | IProcessor proc; 37 | IProcessorCompound comp; 38 | 39 | for (int i = 0; i < count; i++) 40 | { 41 | proc = m_childs[i]; 42 | comp = proc as IProcessorCompound; 43 | if (!proc.enabled 44 | || (comp != null && comp.isCompoundEmpty)) 45 | { continue; } // Skip disabled and/or empty 46 | 47 | m_groupHandles[i] = proc.Schedule(m_scaledLockedDelta, dependsOn); 48 | } 49 | 50 | return JobHandle.CombineDependencies(m_groupHandles); 51 | 52 | } 53 | 54 | internal override JobHandle OnScheduled(JobHandle dependsOn) 55 | { 56 | 57 | if (m_isCompoundEmpty) { return ScheduleEmpty(dependsOn); } 58 | 59 | int count = Count; 60 | IProcessor proc; 61 | IProcessorCompound comp; 62 | 63 | for (int i = 0; i < count; i++) 64 | { 65 | proc = m_childs[i]; 66 | comp = proc as IProcessorCompound; 67 | if (!proc.enabled 68 | || (comp != null && comp.isCompoundEmpty)) 69 | { continue; } // Skip disabled and/or empty 70 | 71 | m_groupHandles[i] = proc.Schedule(m_scaledLockedDelta, dependsOn); 72 | } 73 | 74 | return JobHandle.CombineDependencies(m_groupHandles); 75 | 76 | } 77 | 78 | #endregion 79 | 80 | #region Complete & Apply 81 | 82 | protected sealed override void OnCompleteEnds() { } 83 | 84 | #endregion 85 | 86 | #region IDisposable 87 | 88 | protected override void InternalDispose() 89 | { 90 | m_groupHandles.Release(); 91 | } 92 | 93 | #endregion 94 | 95 | #region Abstracts 96 | /* 97 | protected override void InternalLock() { } 98 | 99 | protected override void Prepare(float delta) { } 100 | 101 | protected override void Apply() { } 102 | 103 | protected override void InternalUnlock() { } 104 | */ 105 | #endregion 106 | 107 | } 108 | } 109 | -------------------------------------------------------------------------------- /Runtime/ProcessorChain.cs: -------------------------------------------------------------------------------- 1 | using Unity.Jobs; 2 | 3 | namespace Nebukam.JobAssist 4 | { 5 | 6 | public interface IProcessorChain : IProcessorCompound 7 | { 8 | 9 | } 10 | 11 | /// 12 | /// A ProcessorChain chains its child processor and return the last 13 | /// job of the chain as its handle. 14 | /// 15 | public abstract class ProcessorChain : AbstractProcessorCompound, IProcessorChain 16 | { 17 | 18 | 19 | #region Scheduling 20 | 21 | internal override JobHandle OnScheduled(IProcessor dependsOn = null) 22 | { 23 | 24 | if (m_isCompoundEmpty) { return ScheduleEmpty(dependsOn); } 25 | 26 | int count = m_childs.Count; 27 | IProcessor proc, prevProc = dependsOn; 28 | IProcessorCompound comp; 29 | JobHandle handle = default(JobHandle); 30 | 31 | for (int i = 0; i < count; i++) 32 | { 33 | proc = m_childs[i]; 34 | proc.compoundIndex = i; // Redundant ? 35 | comp = proc as IProcessorCompound; 36 | 37 | if (!proc.enabled 38 | || (comp != null && comp.isCompoundEmpty)) 39 | { continue; } // Skip disabled and/or empty 40 | 41 | 42 | 43 | handle = prevProc == null 44 | ? proc.Schedule(m_scaledLockedDelta) 45 | : proc.Schedule(m_scaledLockedDelta, prevProc); ; 46 | prevProc = proc; 47 | 48 | } 49 | 50 | return handle; 51 | 52 | } 53 | 54 | internal override JobHandle OnScheduled(JobHandle dependsOn) 55 | { 56 | 57 | if (m_isCompoundEmpty) { return ScheduleEmpty(dependsOn); } 58 | 59 | int count = m_childs.Count; 60 | IProcessor proc, prevProc = null; 61 | IProcessorCompound comp; 62 | JobHandle handle = default(JobHandle); 63 | 64 | for (int i = 0; i < count; i++) 65 | { 66 | proc = m_childs[i]; 67 | proc.compoundIndex = i; // Redundant ? 68 | 69 | comp = proc as IProcessorCompound; 70 | 71 | if (!proc.enabled 72 | || (comp != null && comp.isCompoundEmpty)) 73 | { continue; } // Skip disabled and/or empty 74 | 75 | handle = prevProc == null 76 | ? proc.Schedule(m_scaledLockedDelta, m_jobHandleDependency) 77 | : proc.Schedule(m_scaledLockedDelta, prevProc); 78 | prevProc = proc; 79 | 80 | } 81 | 82 | return handle; 83 | } 84 | 85 | #endregion 86 | 87 | #region Complete & Apply 88 | 89 | protected sealed override void OnCompleteEnds() { } 90 | 91 | #endregion 92 | 93 | #region Abstracts 94 | /* 95 | protected override void InternalLock() { } 96 | 97 | protected override void Prepare(float delta) { } 98 | 99 | protected override void Apply() { } 100 | 101 | protected override void InternalUnlock() { } 102 | 103 | protected override void InternalDispose() { } 104 | */ 105 | #endregion 106 | 107 | } 108 | } 109 | -------------------------------------------------------------------------------- /Runtime/AbstractProcessor.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using Unity.Jobs; 3 | 4 | namespace Nebukam.JobAssist 5 | { 6 | 7 | public interface IProcessor : IDisposable, ILockable 8 | { 9 | 10 | /// 11 | /// Whether this processor is enabled or not. 12 | /// Note that this property is only accounted for by compounds. 13 | /// While disabled a Processor can still be found by TryGetFirst, TryGetFirstInCompount & Find 14 | /// 15 | bool enabled { get; set; } 16 | 17 | /// 18 | /// User-defined delta multiplier. 19 | /// 20 | float deltaMultiplier { get; set; } 21 | 22 | /// 23 | /// Parent compound for this processor, if any 24 | /// 25 | IProcessorCompound compound { get; set; } 26 | /// 27 | /// Index of this processor inside its parent 28 | /// 29 | int compoundIndex { get; set; } 30 | 31 | /// 32 | /// Return whether or not this processor' job is scheduled 33 | /// 34 | bool scheduled { get; } 35 | /// 36 | /// Return whether or not this processor' job is completed 37 | /// 38 | bool completed { get; } 39 | 40 | /// 41 | /// Return the current IProcessor dependency, if any. 42 | /// 43 | IProcessor procDependency { get; } 44 | /// 45 | /// Return the current JobHandle dependency, if any. 46 | /// 47 | JobHandle currentHandle { get; } 48 | 49 | /// 50 | /// Schedule the processor' job if not scheduled already. 51 | /// 52 | /// 53 | /// IProcessor dependency. 54 | /// 55 | JobHandle Schedule(float delta, IProcessor dependsOn = null); 56 | /// 57 | /// Schedule the processor' job if not scheduled already. 58 | /// 59 | /// 60 | /// JobHandle dependency. 61 | /// 62 | JobHandle Schedule(float delta, JobHandle dependsOn); 63 | 64 | /// 65 | /// Completes the job. 66 | /// 67 | void Complete(); 68 | 69 | /// 70 | /// Completes the job only if it is finished. 71 | /// Return false if the job hasn't been scheduled. 72 | /// 73 | /// Whether the job has been completed or not 74 | bool TryComplete(); 75 | 76 | /// 77 | /// Schedules and immediately completes the job 78 | /// 79 | /// 80 | void Run(float delta = 0f); 81 | 82 | } 83 | 84 | public abstract class AbstractProcessor : IProcessor 85 | { 86 | 87 | public float deltaMultiplier { get; set; } = 1.0f; 88 | 89 | protected bool m_locked = false; 90 | public bool locked { get { return m_locked; } } 91 | 92 | protected IProcessorCompound m_compound = null; 93 | public IProcessorCompound compound { get { return m_compound; } set { m_compound = value; } } 94 | 95 | public int compoundIndex { get; set; } = -1; 96 | 97 | protected bool m_hasJobHandleDependency = false; 98 | protected JobHandle m_jobHandleDependency = default(JobHandle); 99 | 100 | protected IProcessor m_procDependency = null; 101 | public IProcessor procDependency { get { return m_procDependency; } } 102 | 103 | protected JobHandle m_currentHandle; 104 | public JobHandle currentHandle { get { return m_currentHandle; } } 105 | 106 | protected float m_lockedDelta = 0f; 107 | protected float m_scaledLockedDelta = 0f; 108 | protected float m_deltaSum = 0f; 109 | 110 | protected bool m_scheduled = false; 111 | public bool scheduled { get { return m_scheduled; } } 112 | public bool completed { get { return m_scheduled ? m_currentHandle.IsCompleted : false; } } 113 | 114 | protected bool m_enabled = true; 115 | public bool enabled { 116 | get { return m_enabled; } 117 | set 118 | { 119 | if(m_locked) 120 | { 121 | throw new Exception("You cannot change a processor status while it is locked."); 122 | } 123 | 124 | m_enabled = value; 125 | } 126 | } 127 | 128 | #if UNITY_EDITOR 129 | protected bool m_disposed = false; 130 | #endif 131 | 132 | #region Scheduling 133 | 134 | public JobHandle Schedule(float delta, IProcessor dependsOn = null) 135 | { 136 | 137 | #if UNITY_EDITOR 138 | if (m_disposed) 139 | { 140 | throw new Exception("Schedule() called on disposed Processor ( " + GetType().Name + " )."); 141 | } 142 | #endif 143 | m_deltaSum += delta; 144 | 145 | if (m_scheduled) { return m_currentHandle; } 146 | 147 | m_scheduled = true; 148 | m_hasJobHandleDependency = false; 149 | m_procDependency = dependsOn; 150 | 151 | Lock(); 152 | 153 | OnPrepare(); 154 | 155 | m_currentHandle = OnScheduled(m_procDependency); 156 | 157 | return m_currentHandle; 158 | 159 | } 160 | 161 | public JobHandle Schedule(float delta, JobHandle dependsOn) 162 | { 163 | 164 | #if UNITY_EDITOR 165 | if (m_disposed) 166 | { 167 | throw new Exception("Schedule() called on disposed Processor ( " + GetType().Name + " )."); 168 | } 169 | #endif 170 | m_deltaSum += delta; 171 | 172 | if (m_scheduled) { return m_currentHandle; } 173 | 174 | m_scheduled = true; 175 | m_hasJobHandleDependency = true; 176 | m_jobHandleDependency = dependsOn; 177 | m_procDependency = null; 178 | 179 | Lock(); 180 | 181 | OnPrepare(); 182 | 183 | m_currentHandle = OnScheduled(dependsOn); 184 | 185 | return m_currentHandle; 186 | } 187 | 188 | internal abstract void OnPrepare(); 189 | 190 | internal abstract JobHandle OnScheduled(IProcessor dependsOn = null); 191 | 192 | internal abstract JobHandle OnScheduled(JobHandle dependsOn); 193 | 194 | #endregion 195 | 196 | #region Complete & Apply 197 | 198 | /// 199 | /// Complete the job. 200 | /// 201 | public void Complete() 202 | { 203 | 204 | #if UNITY_EDITOR 205 | if (m_disposed) 206 | { 207 | throw new Exception("Complete() called on disposed Processor ( " + GetType().Name + " )."); 208 | } 209 | #endif 210 | 211 | if (!m_scheduled) { return; } 212 | 213 | // Complete dependencies 214 | 215 | if (m_hasJobHandleDependency) 216 | m_jobHandleDependency.Complete(); 217 | 218 | m_procDependency?.Complete(); 219 | 220 | // Complete self 221 | 222 | OnCompleteBegins(); 223 | 224 | m_scheduled = false; 225 | 226 | OnCompleteEnds(); 227 | 228 | Unlock(); 229 | 230 | } 231 | 232 | protected abstract void OnCompleteBegins(); 233 | 234 | protected abstract void OnCompleteEnds(); 235 | 236 | public bool TryComplete() 237 | { 238 | if (!m_scheduled) { return false; } 239 | if (completed) 240 | { 241 | Complete(); 242 | return true; 243 | } 244 | else 245 | { 246 | return false; 247 | } 248 | } 249 | 250 | public void Run(float delta = 0f) 251 | { 252 | Schedule(delta); 253 | Complete(); 254 | } 255 | 256 | #endregion 257 | 258 | #region ILockable 259 | 260 | public virtual void Lock() 261 | { 262 | if (m_locked) { return; } 263 | m_lockedDelta = m_deltaSum; 264 | m_scaledLockedDelta = m_lockedDelta * deltaMultiplier; 265 | m_deltaSum = 0f; 266 | InternalLock(); 267 | m_locked = true; 268 | } 269 | 270 | protected virtual void InternalLock() { } 271 | 272 | public virtual void Unlock() 273 | { 274 | if (!m_locked) { return; } 275 | m_locked = false; 276 | if (m_scheduled) { Complete(); } //Complete the job for safety 277 | InternalUnlock(); 278 | } 279 | 280 | protected virtual void InternalUnlock() { } 281 | 282 | #endregion 283 | 284 | #region Hierarchy 285 | 286 | protected bool TryGetFirstInCompound

(out P processor, bool deep = false) 287 | where P : class, IProcessor 288 | { 289 | processor = null; 290 | if (m_compound != null && compoundIndex >= 0) 291 | { 292 | //TODO : If compoundIndex == 0, need to go upward in compounds 293 | return m_compound.TryGetFirst(compoundIndex - 1, out processor, deep); 294 | 295 | } 296 | else 297 | { 298 | return false; 299 | } 300 | } 301 | 302 | #endregion 303 | 304 | #region IDisposable 305 | 306 | protected void Dispose(bool disposing) 307 | { 308 | 309 | if (!disposing) { return; } 310 | #if UNITY_EDITOR 311 | m_disposed = true; 312 | #endif 313 | 314 | //Complete the job first so we can rid of unmanaged resources. 315 | if (m_scheduled) { m_currentHandle.Complete(); } 316 | 317 | InternalDispose(); 318 | 319 | m_procDependency = null; 320 | m_scheduled = false; 321 | 322 | } 323 | 324 | protected virtual void InternalDispose() { } 325 | 326 | public void Dispose() 327 | { 328 | // Dispose of unmanaged resources. 329 | Dispose(true); 330 | // Suppress finalization. 331 | GC.SuppressFinalize(this); 332 | } 333 | 334 | #endregion 335 | 336 | } 337 | } 338 | -------------------------------------------------------------------------------- /Runtime/AbstractProcessorCompound.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using Unity.Collections; 4 | using Unity.Jobs; 5 | 6 | namespace Nebukam.JobAssist 7 | { 8 | 9 | public interface IProcessorCompound : IProcessor 10 | { 11 | 12 | ///

13 | /// Return the current number of children in this compound 14 | /// 15 | int Count { get; } 16 | 17 | bool isCompoundEmpty { get; } 18 | 19 | /// 20 | /// Return the child stored at a given index 21 | /// 22 | /// 23 | /// 24 | IProcessor this[int i] { get; } 25 | 26 | /// 27 | /// Dispose of the compound as well as all of its childrens. 28 | /// Recursive. 29 | /// 30 | void DisposeAll(); 31 | 32 | /// 33 | /// Attempt to find the first item of type P 34 | /// 35 | /// 36 | /// 37 | /// 38 | /// 39 | /// 40 | bool TryGetFirst

(int startIndex, out P processor, bool deep = false) where P : class, IProcessor; 41 | bool Find

(out P processor) where P : class, IProcessor; 42 | 43 | } 44 | 45 | public abstract class AbstractProcessorCompound : AbstractProcessor, IProcessorCompound 46 | { 47 | 48 | protected EmptyCompound m_emptyCompoundJob; 49 | protected bool m_isCompoundEmpty = false; 50 | public bool isCompoundEmpty { get { return m_isCompoundEmpty; } } 51 | 52 | protected int m_enabledChildren = 0; 53 | 54 | protected List m_childs = new List(); 55 | public int Count { get { return m_childs.Count; } } 56 | 57 | public IProcessor this[int i] { get { return m_childs[i]; } } 58 | 59 | #region Child management 60 | 61 | public IProcessor Add(IProcessor proc) 62 | { 63 | 64 | #if UNITY_EDITOR 65 | if (m_locked) 66 | { 67 | throw new Exception("You cannot add new processors to a locked chain"); 68 | } 69 | #endif 70 | 71 | if (m_childs.Contains(proc)) { return proc; } 72 | m_childs.Add(proc); 73 | return OnChildAdded(proc, Count - 1); 74 | } 75 | 76 | public P Add

(P proc) 77 | where P : class, IProcessor 78 | { 79 | 80 | #if UNITY_EDITOR 81 | if (m_locked) 82 | { 83 | throw new Exception("You cannot add new processors to a locked chain"); 84 | } 85 | #endif 86 | 87 | if (m_childs.Contains(proc)) { return proc; } 88 | m_childs.Add(proc); 89 | return OnChildAdded(proc, Count - 1) as P; 90 | } 91 | 92 | ///

93 | /// Create (if null) and add item 94 | /// 95 | /// 96 | /// 97 | /// 98 | public P Add

(ref P proc) 99 | where P : class, IProcessor, new() 100 | { 101 | #if UNITY_EDITOR 102 | if (m_locked) 103 | { 104 | throw new Exception("You cannot add new processors to a locked chain"); 105 | } 106 | #endif 107 | if (proc != null) { return Add(proc); } 108 | proc = new P(); 109 | return Add(proc); 110 | } 111 | 112 | public P Insert

(int atIndex, P proc) 113 | where P : class, IProcessor 114 | { 115 | 116 | #if UNITY_EDITOR 117 | if (m_locked) 118 | { 119 | throw new Exception("You cannot insert new processors to a locked chain"); 120 | } 121 | #endif 122 | if (m_childs.Contains(proc)) { return proc; } //TODO: Handle situation gracefully, re-order ? 123 | if (atIndex > m_childs.Count - 1) { return Add(proc); } 124 | 125 | m_childs.Insert(atIndex, proc); 126 | return OnChildAdded(proc, atIndex) as P; 127 | } 128 | 129 | public P InsertBefore

(IProcessor beforeItem, P proc) 130 | where P : class, IProcessor 131 | { 132 | 133 | #if UNITY_EDITOR 134 | if (m_locked) 135 | { 136 | throw new Exception("You cannot insert new processors to a locked chain"); 137 | } 138 | #endif 139 | int atIndex = m_childs.IndexOf(beforeItem); 140 | if (atIndex == -1) { return Add(proc); } 141 | return Insert(atIndex, proc); 142 | } 143 | 144 | public P InsertBefore

(IProcessor beforeProc, ref P proc) 145 | where P : class, IProcessor, new() 146 | { 147 | 148 | #if UNITY_EDITOR 149 | if (m_locked) 150 | { 151 | throw new Exception("You cannot insert new processors to a locked chain"); 152 | } 153 | #endif 154 | if (proc != null) { return InsertBefore(beforeProc, proc); } 155 | proc = new P(); 156 | return InsertBefore(beforeProc, proc); 157 | } 158 | 159 | ///

160 | /// Removes a processor from the chain 161 | /// 162 | /// 163 | public IProcessor Remove(IProcessor proc) 164 | { 165 | 166 | #if UNITY_EDITOR 167 | if (m_locked) 168 | { 169 | throw new Exception("You cannot remove processors from a locked chain"); 170 | } 171 | #endif 172 | 173 | int index = m_childs.IndexOf(proc); 174 | if (index == -1) { return null; } 175 | 176 | m_childs.RemoveAt(index); 177 | return OnChildRemoved(proc, index); 178 | 179 | } 180 | 181 | /// 182 | /// Removes a processor from the chain 183 | /// 184 | /// 185 | public IProcessor RemoveAt(int index) 186 | { 187 | 188 | #if UNITY_EDITOR 189 | if (m_locked) 190 | { 191 | throw new Exception("You cannot remove processors from a locked chain"); 192 | } 193 | #endif 194 | IProcessor proc = m_childs[index]; 195 | m_childs.RemoveAt(index); 196 | return OnChildRemoved(proc, index); 197 | 198 | } 199 | 200 | 201 | protected IProcessor OnChildAdded(IProcessor child, int childIndex) 202 | { 203 | child.compound = this; 204 | RefreshChildIndices(childIndex); 205 | return child; 206 | } 207 | 208 | protected IProcessor OnChildRemoved(IProcessor child, int childIndex) 209 | { 210 | child.compound = null; 211 | RefreshChildIndices(childIndex); 212 | return child; 213 | } 214 | 215 | protected void RefreshChildIndices(int from) 216 | { 217 | int count = Count; 218 | if (from <= count - 1) 219 | { 220 | for (int i = from; i < count; i++) 221 | m_childs[i].compoundIndex = i; 222 | } 223 | } 224 | 225 | #endregion 226 | 227 | #region Scheduling 228 | 229 | internal override void OnPrepare() 230 | { 231 | Prepare(m_scaledLockedDelta); 232 | } 233 | 234 | internal JobHandle ScheduleEmpty(IProcessor dependsOn = null) 235 | { 236 | return dependsOn == null 237 | ? m_emptyCompoundJob.Schedule() 238 | : m_emptyCompoundJob.Schedule(dependsOn.currentHandle); 239 | } 240 | 241 | internal JobHandle ScheduleEmpty(JobHandle dependsOn) 242 | { 243 | return m_emptyCompoundJob.Schedule(dependsOn); 244 | } 245 | 246 | /// 247 | /// In a ProcessorGroup, Prepare is called right before scheduling the existing group for the job. 248 | /// If you intend to dynamically modify the group childs list, do so in InternalLock(), right before base.InternalLock(). 249 | /// 250 | /// 251 | protected virtual void Prepare(float delta) { } 252 | 253 | #endregion 254 | 255 | #region Complete & Apply 256 | 257 | protected sealed override void OnCompleteBegins() 258 | { 259 | 260 | if (m_isCompoundEmpty) 261 | { 262 | m_currentHandle.Complete(); 263 | } 264 | else 265 | { 266 | for (int i = 0, n = m_childs.Count; i < n; i++) 267 | m_childs[i].Complete(); 268 | } 269 | 270 | Apply(); 271 | 272 | } 273 | 274 | protected virtual void Apply() { } 275 | 276 | #endregion 277 | 278 | #region ILockable 279 | 280 | public override sealed void Lock() 281 | { 282 | 283 | if (m_locked) { return; } 284 | 285 | base.Lock(); 286 | 287 | m_enabledChildren = 0; 288 | 289 | for (int i = 0, n = m_childs.Count; i < n; i++) 290 | { 291 | IProcessor child = m_childs[i]; 292 | child.Lock(); 293 | 294 | if (!child.enabled) { continue; } 295 | 296 | // Skip empty compounds 297 | IProcessorCompound childCompound = child as IProcessorCompound; 298 | if (childCompound != null && childCompound.isCompoundEmpty) { continue; } 299 | 300 | m_enabledChildren++; 301 | } 302 | 303 | if (m_enabledChildren == 0) 304 | { 305 | m_isCompoundEmpty = true; 306 | m_emptyCompoundJob = default; 307 | } 308 | else 309 | { 310 | m_isCompoundEmpty = false; 311 | } 312 | 313 | } 314 | 315 | public override sealed void Unlock() 316 | { 317 | if (!m_locked) { return; } 318 | 319 | base.Unlock(); 320 | 321 | for (int i = 0, n = m_childs.Count; i < n; i++) 322 | m_childs[i].Unlock(); 323 | } 324 | 325 | #endregion 326 | 327 | #region Hierarchy 328 | 329 | public bool TryGetFirst

(int startIndex, out P processor, bool deep = false) 330 | where P : class, IProcessor 331 | { 332 | 333 | processor = null; 334 | 335 | if (startIndex < 0) { startIndex = m_childs.Count - 1; } 336 | 337 | IProcessor child; 338 | IProcessorCompound childCompound; 339 | 340 | for (int i = startIndex; i >= 0; i--) 341 | { 342 | child = m_childs[i]; 343 | processor = child as P; 344 | 345 | if (processor != null) 346 | { 347 | return true; 348 | } 349 | 350 | if (!deep) { continue; } 351 | 352 | childCompound = child as IProcessorCompound; 353 | 354 | if (childCompound != null 355 | && childCompound.Find(out processor)) 356 | return true; 357 | 358 | } 359 | 360 | //If local search fails, it goes up one level and restarts. 361 | //This is actually super slow so make sure to cache the results of TryGet & Find. 362 | return TryGetFirstInCompound(out processor, deep); 363 | 364 | } 365 | 366 | ///

367 | /// Goes through all child processors & compounts in reverse order 368 | /// until if find a processor with the correct signature. 369 | /// 370 | /// 371 | /// 372 | /// 373 | public bool Find

(out P processor) 374 | where P : class, IProcessor 375 | { 376 | 377 | processor = null; 378 | 379 | IProcessor child; 380 | IProcessorCompound childCompound; 381 | 382 | for (int i = Count - 1; i >= 0; i--) 383 | { 384 | child = m_childs[i]; 385 | processor = child as P; 386 | 387 | if (processor != null) 388 | return true; 389 | 390 | childCompound = child as IProcessorCompound; 391 | 392 | if (childCompound != null 393 | && childCompound.Find(out processor)) 394 | return true; 395 | 396 | } 397 | 398 | return false; 399 | 400 | } 401 | 402 | #endregion 403 | 404 | #region IDisposable 405 | 406 | public void DisposeAll() 407 | { 408 | 409 | #if UNITY_EDITOR 410 | if (m_disposed) 411 | { 412 | return; 413 | 414 | //throw new Exception("DisposeAll() called on already disposed Compound."); 415 | } 416 | #endif 417 | 418 | if (m_scheduled) { m_currentHandle.Complete(); } 419 | 420 | IProcessor p; 421 | 422 | for (int i = 0, count = m_childs.Count; i < count; i++) 423 | { 424 | p = m_childs[i]; 425 | 426 | if (p is IProcessorCompound) 427 | (p as IProcessorCompound).DisposeAll(); 428 | else 429 | p.Dispose(); 430 | 431 | } 432 | 433 | m_scheduled = false; // Avoid Completting current handle twice 434 | 435 | Dispose(); 436 | 437 | } 438 | 439 | #endregion 440 | 441 | } 442 | } 443 | -------------------------------------------------------------------------------- /Runtime/Extensions.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using Unity.Collections; 4 | using Unity.Jobs; 5 | using Unity.Burst; 6 | 7 | namespace Nebukam.JobAssist 8 | { 9 | public static class Extensions 10 | { 11 | 12 | ///

13 | /// Call Complete() on a JobHandle only if the job IsCompleted = true. 14 | /// 15 | /// 16 | /// 17 | public static bool TryComplete(this JobHandle @this) 18 | { 19 | if (@this.IsCompleted) { @this.Complete(); return true; } 20 | return false; 21 | } 22 | 23 | /// 24 | /// Extremely inneficient "remove at" method for NativeList 25 | /// Usefull for debug & making sure algorithms are working as intented 26 | /// Shouldn't be used in production. 27 | /// 28 | /// 29 | /// 30 | /// 31 | /// 32 | public static T RemoveAt(this ref NativeList @this, int index) 33 | where T : unmanaged 34 | { 35 | int length = @this.Length; 36 | T val = @this[index]; 37 | 38 | for (int i = index; i < length - 1; i++) 39 | @this[i] = @this[i + 1]; 40 | 41 | @this.ResizeUninitialized(length - 1); 42 | return val; 43 | 44 | } 45 | 46 | /// 47 | /// Checks whether a NativeMultiHashMap as a given value associated to a given key 48 | /// 49 | /// 50 | /// 51 | /// 52 | /// 53 | /// 54 | /// 55 | public static bool Contains(this ref NativeParallelMultiHashMap @this, ref TKey key, ref TValue value) 56 | where TKey : unmanaged, IEquatable 57 | where TValue : unmanaged, IEquatable 58 | { 59 | NativeParallelMultiHashMapIterator it; 60 | TValue result; 61 | if (@this.TryGetFirstValue(key, out result, out it)) 62 | { 63 | if (result.Equals(value)) { return true; } 64 | while (@this.TryGetNextValue(out result, ref it)) 65 | { 66 | if (result.Equals(value)) { return true; } 67 | } 68 | } 69 | return false; 70 | } 71 | 72 | /// 73 | /// Removes a single value from the list associated to the a key 74 | /// 75 | /// 76 | /// 77 | /// 78 | /// 79 | /// 80 | /// 81 | public static bool Remove(this ref NativeParallelMultiHashMap @this, ref TKey key, ref TValue value) 82 | where TKey : unmanaged, IEquatable 83 | where TValue : unmanaged, IEquatable 84 | { 85 | if (!@this.Contains(ref key, ref value)) { return false; } 86 | 87 | NativeList values = new NativeList(5, Allocator.Temp); 88 | NativeParallelMultiHashMapIterator it; 89 | TValue result; 90 | if (@this.TryGetFirstValue(key, out result, out it)) 91 | { 92 | if (result.Equals(value)) { } else { values.Add(result); } 93 | while (@this.TryGetNextValue(out result, ref it)) 94 | { 95 | if (result.Equals(value)) { } else { values.Add(result); } 96 | } 97 | } 98 | 99 | @this.Remove(key); 100 | for (int i = 0, count = values.Length; i < count; i++) { @this.Add(key, values[i]); } 101 | values.Dispose(); 102 | 103 | return true; 104 | } 105 | 106 | public static bool Contains(this ref NativeList @this, ref TValue value) 107 | where TValue : unmanaged, IEquatable 108 | { 109 | for (int i = 0, count = @this.Length; i < count; i++) 110 | if (@this[i].Equals(value)) { return true; } 111 | return false; 112 | } 113 | 114 | public static bool AddOnce(this ref NativeList @this, ref TValue value) 115 | where TValue : unmanaged, IEquatable 116 | { 117 | if (@this.Contains(ref value)) { return false; } 118 | @this.Add(value); 119 | return true; 120 | } 121 | 122 | public static TValue Pop(this ref NativeList @this) 123 | where TValue : unmanaged 124 | { 125 | int index = @this.Length - 1; 126 | TValue result = @this[index]; 127 | @this.ResizeUninitialized(index); 128 | return result; 129 | } 130 | 131 | public static TValue Shift(this ref NativeList @this) 132 | where TValue : unmanaged 133 | { 134 | TValue result = @this[0]; 135 | @this.RemoveAt(0); 136 | return result; 137 | } 138 | 139 | /// 140 | /// Return a list containing all values associated to a given key. 141 | /// If no value is found, returns an empty list. 142 | /// 143 | /// 144 | /// 145 | /// 146 | /// 147 | /// 148 | /// 149 | /// 150 | public static NativeList GetValues(this ref NativeParallelMultiHashMap @this, ref TKey key, Allocator alloc, int capacity = 5) 151 | where TKey : unmanaged, IEquatable 152 | where TValue : unmanaged, IEquatable 153 | { 154 | 155 | NativeList list = new NativeList(capacity, alloc); 156 | 157 | NativeList values = new NativeList(5, Allocator.Temp); 158 | NativeParallelMultiHashMapIterator it; 159 | 160 | TValue result; 161 | if (@this.TryGetFirstValue(key, out result, out it)) 162 | { 163 | list.Add(result); 164 | while (@this.TryGetNextValue(out result, ref it)) 165 | { 166 | list.Add(result); 167 | } 168 | } 169 | 170 | return list; 171 | } 172 | 173 | /// 174 | /// Push value associated with a given key to a given list. 175 | /// Return the number of values added. 176 | /// 177 | /// 178 | /// 179 | /// 180 | /// 181 | /// 182 | /// 183 | public static int PushValues(this ref NativeParallelMultiHashMap @this, ref TKey key, ref NativeList list) 184 | where TKey : unmanaged, IEquatable 185 | where TValue : unmanaged, IEquatable 186 | { 187 | 188 | NativeList values = new NativeList(5, Allocator.Temp); 189 | NativeParallelMultiHashMapIterator it; 190 | 191 | int resultCount = 0; 192 | TValue result; 193 | if (@this.TryGetFirstValue(key, out result, out it)) 194 | { 195 | list.Add(result); 196 | resultCount++; 197 | while (@this.TryGetNextValue(out result, ref it)) 198 | { 199 | list.Add(result); 200 | resultCount++; 201 | } 202 | } 203 | 204 | return resultCount; 205 | } 206 | 207 | /// 208 | /// Returns a clone of a NativeMultiHashMap 209 | /// 210 | /// 211 | /// 212 | /// 213 | /// 214 | /// 215 | public static NativeParallelMultiHashMap Clone(this ref NativeParallelMultiHashMap @this, Allocator alloc) 216 | where TKey : unmanaged, IEquatable 217 | where TValue : unmanaged 218 | { 219 | 220 | NativeParallelMultiHashMap cloneHashMap = new NativeParallelMultiHashMap(@this.Count(), alloc); 221 | 222 | NativeParallelMultiHashMapIterator it; 223 | NativeArray keys = @this.GetKeyArray(Allocator.Temp); 224 | TKey key; 225 | TValue value; 226 | 227 | for (int k = 0, count = keys.Length; k < count; k++) 228 | { 229 | key = keys[k]; 230 | if (@this.TryGetFirstValue(key, out value, out it)) 231 | { 232 | cloneHashMap.Add(key, value); 233 | while (@this.TryGetNextValue(out value, ref it)) 234 | { 235 | cloneHashMap.Add(key, value); 236 | } 237 | } 238 | } 239 | 240 | keys.Dispose(); 241 | 242 | return cloneHashMap; 243 | } 244 | 245 | /// 246 | /// Ensure a NativeArray is of required size. 247 | /// 248 | /// 249 | /// 250 | /// 251 | /// 252 | /// true if the size is unchanged, false if the NativeArray has been updated 253 | public static bool MakeLength(ref NativeArray nativeArray, int length, Allocator alloc = Allocator.Persistent) 254 | where T : unmanaged 255 | { 256 | if (!nativeArray.IsCreated 257 | || nativeArray.Length != length) 258 | { 259 | nativeArray.Release(); 260 | nativeArray = new NativeArray(length, alloc); 261 | return false; 262 | } 263 | 264 | return true; 265 | 266 | } 267 | 268 | /// 269 | /// Ensure a NativeArray is of required size. 270 | /// 271 | /// 272 | /// 273 | /// 274 | /// 275 | /// true if the size is unchanged, false if the NativeArray has been updated 276 | public static bool MakeLength(ref NativeParallelHashMap nativeHashMap, int length, Allocator alloc = Allocator.Persistent) 277 | where TKey : unmanaged, IEquatable 278 | where TValue : unmanaged 279 | { 280 | if (!nativeHashMap.IsCreated 281 | || nativeHashMap.Count() != length) 282 | { 283 | nativeHashMap.Release(); 284 | nativeHashMap = new NativeParallelHashMap(length, alloc); 285 | return false; 286 | } 287 | 288 | return true; 289 | 290 | } 291 | 292 | /// 293 | /// Ensure a NativeArray is of required size. 294 | /// 295 | /// 296 | /// 297 | /// 298 | /// 299 | /// true if the size is unchanged, false if the NativeArray has been updated 300 | public static bool MakeLength(ref T[] array, int length) 301 | where T : struct 302 | { 303 | if (array.Length != length) 304 | { 305 | array = new T[length]; 306 | return false; 307 | } 308 | 309 | return true; 310 | 311 | } 312 | 313 | /// 314 | /// Ensure a NativeArray has at least a given size. 315 | /// 316 | /// 317 | /// 318 | /// 319 | /// 320 | /// 321 | /// true if the size is unchanged, false if the NativeArray has been updated 322 | public static bool EnsureMinLength(ref NativeArray nativeArray, int length, int padding = 0, Allocator alloc = Allocator.Persistent) 323 | where T : unmanaged 324 | { 325 | if (!nativeArray.IsCreated 326 | || nativeArray.Length < length) 327 | { 328 | nativeArray.Release(); 329 | nativeArray = new NativeArray(length + padding, alloc); 330 | return false; 331 | } 332 | 333 | return true; 334 | 335 | } 336 | 337 | /// 338 | /// Copies the content of a managed array into a nativeArray 339 | /// Ensure the target native array has the same length as the source. 340 | /// 341 | /// 342 | /// 343 | /// 344 | /// true if the size is unchanged, false if the NativeArray has been updated 345 | public static bool Copy(T[] src, ref NativeArray dest, Allocator alloc = Allocator.Persistent) 346 | where T : unmanaged 347 | { 348 | int count = src.Length; 349 | bool resized = MakeLength(ref dest, src.Length, alloc); 350 | NativeArray.Copy(src, dest); 351 | return resized; 352 | } 353 | 354 | /// 355 | /// Copies the content of a NativeArray into a managed array 356 | /// Ensure the target native array has the same length as the source. 357 | /// 358 | /// 359 | /// 360 | /// 361 | /// true if the size is unchanged, false if the NativeArray has been updated 362 | public static bool Copy(NativeArray src, ref T[] dest) 363 | where T : unmanaged 364 | { 365 | int count = src.Length; 366 | bool resized = dest.Length != count; 367 | if (resized) { dest = new T[count]; } 368 | NativeArray.Copy(src, dest); 369 | return resized; 370 | } 371 | 372 | /// 373 | /// Copies the content of a NativeArray into a managed array 374 | /// Ensure the target native array has the same length as the source. 375 | /// 376 | /// 377 | /// 378 | /// 379 | /// true if the size is unchanged, false if the NativeArray has been updated 380 | public static bool Copy(NativeArray src, ref NativeArray dest, Allocator alloc = Allocator.Persistent) 381 | where T : unmanaged 382 | { 383 | int count = src.Length; 384 | bool resized = !dest.IsCreated || dest.Length != count; 385 | if (resized) 386 | { 387 | dest.Release(); 388 | dest = new NativeArray(count, alloc); 389 | } 390 | NativeArray.Copy(src, dest); 391 | return resized; 392 | } 393 | 394 | /// 395 | /// Copies the content of a managed list into a nativeArray 396 | /// Ensure the target native array has the same length as the source. 397 | /// 398 | /// 399 | /// 400 | /// 401 | /// true if the size is unchanged, false if the NativeArray has been updated 402 | public static bool Copy(List src, ref NativeArray dest, Allocator alloc = Allocator.Persistent) 403 | where T : unmanaged 404 | { 405 | int count = src.Count; 406 | bool resized = MakeLength(ref dest, src.Count, alloc); 407 | 408 | for (int i = 0; i < count; i++) 409 | dest[i] = src[i]; 410 | 411 | return resized; 412 | } 413 | 414 | /// 415 | /// Copies the content of a managed list into a nativeArray 416 | /// Ensure the target native array has the same length as the source. 417 | /// 418 | /// 419 | /// 420 | /// 421 | public static void Copy(List src, ref NativeList dest, Allocator alloc = Allocator.Persistent) 422 | where T : unmanaged 423 | { 424 | int count = src.Count; 425 | 426 | if (!dest.IsCreated) 427 | dest = new NativeList(count + 1, alloc); 428 | else if (dest.Capacity <= count) 429 | dest.Capacity = count + 1; 430 | 431 | for (int i = 0; i < count; i++) 432 | dest.AddNoResize(src[i]); 433 | 434 | } 435 | 436 | public static void Release(this NativeArray @this) where T : unmanaged { if (@this.IsCreated) { @this.Dispose(); } } 437 | public static void Release(this NativeList @this) where T : unmanaged { if (@this.IsCreated) { @this.Dispose(); } } 438 | public static void Release(this NativeParallelHashMap @this) where TKey : unmanaged, IEquatable where TValue : unmanaged { if (@this.IsCreated) { @this.Dispose(); } } 439 | public static void Release(this NativeParallelMultiHashMap @this) where TKey : unmanaged, IEquatable where TValue : unmanaged { if (@this.IsCreated) { @this.Dispose(); } } 440 | 441 | public static void FloodArray(NativeArray array, T value) 442 | where T : unmanaged 443 | { 444 | new FloodArray { array = array, value = value }.Run(array.Length); 445 | } 446 | 447 | } 448 | 449 | [BurstCompile] 450 | internal struct FloodArray : Unity.Jobs.IJobParallelFor 451 | where T : unmanaged 452 | { 453 | public NativeArray array; 454 | public T value; 455 | public void Execute(int index) 456 | { 457 | array[index] = value; 458 | } 459 | } 460 | } 461 | -------------------------------------------------------------------------------- /Documentation~/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.9.2 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 = N:JobAssist 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.1 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 = com.nebukam.job-assist 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 = . 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 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = YES 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 193 | # such as 194 | # /*************** 195 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 196 | # Javadoc-style will behave just like regular comments and it will not be 197 | # interpreted by doxygen. 198 | # The default value is: NO. 199 | 200 | JAVADOC_BANNER = NO 201 | 202 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 203 | # line (until the first dot) of a Qt-style comment as the brief description. If 204 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 205 | # requiring an explicit \brief command for a brief description.) 206 | # The default value is: NO. 207 | 208 | QT_AUTOBRIEF = NO 209 | 210 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 211 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 212 | # a brief description. This used to be the default behavior. The new default is 213 | # to treat a multi-line C++ comment block as a detailed description. Set this 214 | # tag to YES if you prefer the old behavior instead. 215 | # 216 | # Note that setting this tag to YES also means that rational rose comments are 217 | # not recognized any more. 218 | # The default value is: NO. 219 | 220 | MULTILINE_CPP_IS_BRIEF = NO 221 | 222 | # By default Python docstrings are displayed as preformatted text and doxygen's 223 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 224 | # doxygen's special commands can be used and the contents of the docstring 225 | # documentation blocks is shown as doxygen documentation. 226 | # The default value is: YES. 227 | 228 | PYTHON_DOCSTRING = YES 229 | 230 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 231 | # documentation from any documented member that it re-implements. 232 | # The default value is: YES. 233 | 234 | INHERIT_DOCS = YES 235 | 236 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 237 | # page for each member. If set to NO, the documentation of a member will be part 238 | # of the file/class/namespace that contains it. 239 | # The default value is: NO. 240 | 241 | SEPARATE_MEMBER_PAGES = NO 242 | 243 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 244 | # uses this value to replace tabs by spaces in code fragments. 245 | # Minimum value: 1, maximum value: 16, default value: 4. 246 | 247 | TAB_SIZE = 4 248 | 249 | # This tag can be used to specify a number of aliases that act as commands in 250 | # the documentation. An alias has the form: 251 | # name=value 252 | # For example adding 253 | # "sideeffect=@par Side Effects:^^" 254 | # will allow you to put the command \sideeffect (or @sideeffect) in the 255 | # documentation, which will result in a user-defined paragraph with heading 256 | # "Side Effects:". Note that you cannot put \n's in the value part of an alias 257 | # to insert newlines (in the resulting output). You can put ^^ in the value part 258 | # of an alias to insert a newline as if a physical newline was in the original 259 | # file. When you need a literal { or } or , in the value part of an alias you 260 | # have to escape them by means of a backslash (\), this can lead to conflicts 261 | # with the commands \{ and \} for these it is advised to use the version @{ and 262 | # @} or use a double escape (\\{ and \\}) 263 | 264 | ALIASES = 265 | 266 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 267 | # only. Doxygen will then generate output that is more tailored for C. For 268 | # instance, some of the names that are used will be different. The list of all 269 | # members will be omitted, etc. 270 | # The default value is: NO. 271 | 272 | OPTIMIZE_OUTPUT_FOR_C = NO 273 | 274 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 275 | # Python sources only. Doxygen will then generate output that is more tailored 276 | # for that language. For instance, namespaces will be presented as packages, 277 | # qualified scopes will look different, etc. 278 | # The default value is: NO. 279 | 280 | OPTIMIZE_OUTPUT_JAVA = YES 281 | 282 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 283 | # sources. Doxygen will then generate output that is tailored for Fortran. 284 | # The default value is: NO. 285 | 286 | OPTIMIZE_FOR_FORTRAN = NO 287 | 288 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 289 | # sources. Doxygen will then generate output that is tailored for VHDL. 290 | # The default value is: NO. 291 | 292 | OPTIMIZE_OUTPUT_VHDL = NO 293 | 294 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 295 | # sources only. Doxygen will then generate output that is more tailored for that 296 | # language. For instance, namespaces will be presented as modules, types will be 297 | # separated into more groups, etc. 298 | # The default value is: NO. 299 | 300 | OPTIMIZE_OUTPUT_SLICE = NO 301 | 302 | # Doxygen selects the parser to use depending on the extension of the files it 303 | # parses. With this tag you can assign which parser to use for a given 304 | # extension. Doxygen has a built-in mapping, but you can override or extend it 305 | # using this tag. The format is ext=language, where ext is a file extension, and 306 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 307 | # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, 308 | # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 309 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 310 | # tries to guess whether the code is fixed or free formatted code, this is the 311 | # default for Fortran type files). For instance to make doxygen treat .inc files 312 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), 313 | # use: inc=Fortran f=C. 314 | # 315 | # Note: For files without extension you can use no_extension as a placeholder. 316 | # 317 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 318 | # the files are not read by doxygen. When specifying no_extension you should add 319 | # * to the FILE_PATTERNS. 320 | # 321 | # Note see also the list of default file extension mappings. 322 | 323 | EXTENSION_MAPPING = 324 | 325 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 326 | # according to the Markdown format, which allows for more readable 327 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 328 | # The output of markdown processing is further processed by doxygen, so you can 329 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 330 | # case of backward compatibilities issues. 331 | # The default value is: YES. 332 | 333 | MARKDOWN_SUPPORT = YES 334 | 335 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 336 | # to that level are automatically included in the table of contents, even if 337 | # they do not have an id attribute. 338 | # Note: This feature currently applies only to Markdown headings. 339 | # Minimum value: 0, maximum value: 99, default value: 5. 340 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 341 | 342 | TOC_INCLUDE_HEADINGS = 5 343 | 344 | # When enabled doxygen tries to link words that correspond to documented 345 | # classes, or namespaces to their corresponding documentation. Such a link can 346 | # be prevented in individual cases by putting a % sign in front of the word or 347 | # globally by setting AUTOLINK_SUPPORT to NO. 348 | # The default value is: YES. 349 | 350 | AUTOLINK_SUPPORT = YES 351 | 352 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 353 | # to include (a tag file for) the STL sources as input, then you should set this 354 | # tag to YES in order to let doxygen match functions declarations and 355 | # definitions whose arguments contain STL classes (e.g. func(std::string); 356 | # versus func(std::string) {}). This also make the inheritance and collaboration 357 | # diagrams that involve STL classes more complete and accurate. 358 | # The default value is: NO. 359 | 360 | BUILTIN_STL_SUPPORT = NO 361 | 362 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 363 | # enable parsing support. 364 | # The default value is: NO. 365 | 366 | CPP_CLI_SUPPORT = NO 367 | 368 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 369 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 370 | # will parse them like normal C++ but will assume all classes use public instead 371 | # of private inheritance when no explicit protection keyword is present. 372 | # The default value is: NO. 373 | 374 | SIP_SUPPORT = NO 375 | 376 | # For Microsoft's IDL there are propget and propput attributes to indicate 377 | # getter and setter methods for a property. Setting this option to YES will make 378 | # doxygen to replace the get and set methods by a property in the documentation. 379 | # This will only work if the methods are indeed getting or setting a simple 380 | # type. If this is not the case, or you want to show the methods anyway, you 381 | # should set this option to NO. 382 | # The default value is: YES. 383 | 384 | IDL_PROPERTY_SUPPORT = YES 385 | 386 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 387 | # tag is set to YES then doxygen will reuse the documentation of the first 388 | # member in the group (if any) for the other members of the group. By default 389 | # all members of a group must be documented explicitly. 390 | # The default value is: NO. 391 | 392 | DISTRIBUTE_GROUP_DOC = NO 393 | 394 | # If one adds a struct or class to a group and this option is enabled, then also 395 | # any nested class or struct is added to the same group. By default this option 396 | # is disabled and one has to add nested compounds explicitly via \ingroup. 397 | # The default value is: NO. 398 | 399 | GROUP_NESTED_COMPOUNDS = NO 400 | 401 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 402 | # (for instance a group of public functions) to be put as a subgroup of that 403 | # type (e.g. under the Public Functions section). Set it to NO to prevent 404 | # subgrouping. Alternatively, this can be done per class using the 405 | # \nosubgrouping command. 406 | # The default value is: YES. 407 | 408 | SUBGROUPING = YES 409 | 410 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 411 | # are shown inside the group in which they are included (e.g. using \ingroup) 412 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 413 | # and RTF). 414 | # 415 | # Note that this feature does not work in combination with 416 | # SEPARATE_MEMBER_PAGES. 417 | # The default value is: NO. 418 | 419 | INLINE_GROUPED_CLASSES = NO 420 | 421 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 422 | # with only public data fields or simple typedef fields will be shown inline in 423 | # the documentation of the scope in which they are defined (i.e. file, 424 | # namespace, or group documentation), provided this scope is documented. If set 425 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 426 | # Man pages) or section (for LaTeX and RTF). 427 | # The default value is: NO. 428 | 429 | INLINE_SIMPLE_STRUCTS = NO 430 | 431 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 432 | # enum is documented as struct, union, or enum with the name of the typedef. So 433 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 434 | # with name TypeT. When disabled the typedef will appear as a member of a file, 435 | # namespace, or class. And the struct will be named TypeS. This can typically be 436 | # useful for C code in case the coding convention dictates that all compound 437 | # types are typedef'ed and only the typedef is referenced, never the tag name. 438 | # The default value is: NO. 439 | 440 | TYPEDEF_HIDES_STRUCT = NO 441 | 442 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 443 | # cache is used to resolve symbols given their name and scope. Since this can be 444 | # an expensive process and often the same symbol appears multiple times in the 445 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 446 | # doxygen will become slower. If the cache is too large, memory is wasted. The 447 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 448 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 449 | # symbols. At the end of a run doxygen will report the cache usage and suggest 450 | # the optimal cache size from a speed point of view. 451 | # Minimum value: 0, maximum value: 9, default value: 0. 452 | 453 | LOOKUP_CACHE_SIZE = 0 454 | 455 | # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use 456 | # during processing. When set to 0 doxygen will based this on the number of 457 | # cores available in the system. You can set it explicitly to a value larger 458 | # than 0 to get more control over the balance between CPU load and processing 459 | # speed. At this moment only the input processing can be done using multiple 460 | # threads. Since this is still an experimental feature the default is set to 1, 461 | # which effectively disables parallel processing. Please report any issues you 462 | # encounter. Generating dot graphs in parallel is controlled by the 463 | # DOT_NUM_THREADS setting. 464 | # Minimum value: 0, maximum value: 32, default value: 1. 465 | 466 | NUM_PROC_THREADS = 1 467 | 468 | #--------------------------------------------------------------------------- 469 | # Build related configuration options 470 | #--------------------------------------------------------------------------- 471 | 472 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 473 | # documentation are documented, even if no documentation was available. Private 474 | # class members and static file members will be hidden unless the 475 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 476 | # Note: This will also disable the warnings about undocumented members that are 477 | # normally produced when WARNINGS is set to YES. 478 | # The default value is: NO. 479 | 480 | EXTRACT_ALL = YES 481 | 482 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 483 | # be included in the documentation. 484 | # The default value is: NO. 485 | 486 | EXTRACT_PRIVATE = NO 487 | 488 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 489 | # methods of a class will be included in the documentation. 490 | # The default value is: NO. 491 | 492 | EXTRACT_PRIV_VIRTUAL = NO 493 | 494 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 495 | # scope will be included in the documentation. 496 | # The default value is: NO. 497 | 498 | EXTRACT_PACKAGE = NO 499 | 500 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 501 | # included in the documentation. 502 | # The default value is: NO. 503 | 504 | EXTRACT_STATIC = YES 505 | 506 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 507 | # locally in source files will be included in the documentation. If set to NO, 508 | # only classes defined in header files are included. Does not have any effect 509 | # for Java sources. 510 | # The default value is: YES. 511 | 512 | EXTRACT_LOCAL_CLASSES = YES 513 | 514 | # This flag is only useful for Objective-C code. If set to YES, local methods, 515 | # which are defined in the implementation section but not in the interface are 516 | # included in the documentation. If set to NO, only methods in the interface are 517 | # included. 518 | # The default value is: NO. 519 | 520 | EXTRACT_LOCAL_METHODS = NO 521 | 522 | # If this flag is set to YES, the members of anonymous namespaces will be 523 | # extracted and appear in the documentation as a namespace called 524 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 525 | # the file that contains the anonymous namespace. By default anonymous namespace 526 | # are hidden. 527 | # The default value is: NO. 528 | 529 | EXTRACT_ANON_NSPACES = NO 530 | 531 | # If this flag is set to YES, the name of an unnamed parameter in a declaration 532 | # will be determined by the corresponding definition. By default unnamed 533 | # parameters remain unnamed in the output. 534 | # The default value is: YES. 535 | 536 | RESOLVE_UNNAMED_PARAMS = YES 537 | 538 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 539 | # undocumented members inside documented classes or files. If set to NO these 540 | # members will be included in the various overviews, but no documentation 541 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 542 | # The default value is: NO. 543 | 544 | HIDE_UNDOC_MEMBERS = NO 545 | 546 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 547 | # undocumented classes that are normally visible in the class hierarchy. If set 548 | # to NO, these classes will be included in the various overviews. This option 549 | # has no effect if EXTRACT_ALL is enabled. 550 | # The default value is: NO. 551 | 552 | HIDE_UNDOC_CLASSES = NO 553 | 554 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 555 | # declarations. If set to NO, these declarations will be included in the 556 | # documentation. 557 | # The default value is: NO. 558 | 559 | HIDE_FRIEND_COMPOUNDS = NO 560 | 561 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 562 | # documentation blocks found inside the body of a function. If set to NO, these 563 | # blocks will be appended to the function's detailed documentation block. 564 | # The default value is: NO. 565 | 566 | HIDE_IN_BODY_DOCS = NO 567 | 568 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 569 | # \internal command is included. If the tag is set to NO then the documentation 570 | # will be excluded. Set it to YES to include the internal documentation. 571 | # The default value is: NO. 572 | 573 | INTERNAL_DOCS = YES 574 | 575 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be 576 | # able to match the capabilities of the underlying filesystem. In case the 577 | # filesystem is case sensitive (i.e. it supports files in the same directory 578 | # whose names only differ in casing), the option must be set to YES to properly 579 | # deal with such files in case they appear in the input. For filesystems that 580 | # are not case sensitive the option should be be set to NO to properly deal with 581 | # output files written for symbols that only differ in casing, such as for two 582 | # classes, one named CLASS and the other named Class, and to also support 583 | # references to files without having to specify the exact matching casing. On 584 | # Windows (including Cygwin) and MacOS, users should typically set this option 585 | # to NO, whereas on Linux or other Unix flavors it should typically be set to 586 | # YES. 587 | # The default value is: system dependent. 588 | 589 | CASE_SENSE_NAMES = NO 590 | 591 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 592 | # their full class and namespace scopes in the documentation. If set to YES, the 593 | # scope will be hidden. 594 | # The default value is: NO. 595 | 596 | HIDE_SCOPE_NAMES = NO 597 | 598 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 599 | # append additional text to a page's title, such as Class Reference. If set to 600 | # YES the compound reference will be hidden. 601 | # The default value is: NO. 602 | 603 | HIDE_COMPOUND_REFERENCE= NO 604 | 605 | # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class 606 | # will show which file needs to be included to use the class. 607 | # The default value is: YES. 608 | 609 | SHOW_HEADERFILE = YES 610 | 611 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 612 | # the files that are included by a file in the documentation of that file. 613 | # The default value is: YES. 614 | 615 | SHOW_INCLUDE_FILES = YES 616 | 617 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 618 | # grouped member an include statement to the documentation, telling the reader 619 | # which file to include in order to use the member. 620 | # The default value is: NO. 621 | 622 | SHOW_GROUPED_MEMB_INC = NO 623 | 624 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 625 | # files with double quotes in the documentation rather than with sharp brackets. 626 | # The default value is: NO. 627 | 628 | FORCE_LOCAL_INCLUDES = NO 629 | 630 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 631 | # documentation for inline members. 632 | # The default value is: YES. 633 | 634 | INLINE_INFO = YES 635 | 636 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 637 | # (detailed) documentation of file and class members alphabetically by member 638 | # name. If set to NO, the members will appear in declaration order. 639 | # The default value is: YES. 640 | 641 | SORT_MEMBER_DOCS = YES 642 | 643 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 644 | # descriptions of file, namespace and class members alphabetically by member 645 | # name. If set to NO, the members will appear in declaration order. Note that 646 | # this will also influence the order of the classes in the class list. 647 | # The default value is: NO. 648 | 649 | SORT_BRIEF_DOCS = NO 650 | 651 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 652 | # (brief and detailed) documentation of class members so that constructors and 653 | # destructors are listed first. If set to NO the constructors will appear in the 654 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 655 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 656 | # member documentation. 657 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 658 | # detailed member documentation. 659 | # The default value is: NO. 660 | 661 | SORT_MEMBERS_CTORS_1ST = NO 662 | 663 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 664 | # of group names into alphabetical order. If set to NO the group names will 665 | # appear in their defined order. 666 | # The default value is: NO. 667 | 668 | SORT_GROUP_NAMES = NO 669 | 670 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 671 | # fully-qualified names, including namespaces. If set to NO, the class list will 672 | # be sorted only by class name, not including the namespace part. 673 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 674 | # Note: This option applies only to the class list, not to the alphabetical 675 | # list. 676 | # The default value is: NO. 677 | 678 | SORT_BY_SCOPE_NAME = NO 679 | 680 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 681 | # type resolution of all parameters of a function it will reject a match between 682 | # the prototype and the implementation of a member function even if there is 683 | # only one candidate or it is obvious which candidate to choose by doing a 684 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 685 | # accept a match between prototype and implementation in such cases. 686 | # The default value is: NO. 687 | 688 | STRICT_PROTO_MATCHING = NO 689 | 690 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 691 | # list. This list is created by putting \todo commands in the documentation. 692 | # The default value is: YES. 693 | 694 | GENERATE_TODOLIST = YES 695 | 696 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 697 | # list. This list is created by putting \test commands in the documentation. 698 | # The default value is: YES. 699 | 700 | GENERATE_TESTLIST = YES 701 | 702 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 703 | # list. This list is created by putting \bug commands in the documentation. 704 | # The default value is: YES. 705 | 706 | GENERATE_BUGLIST = YES 707 | 708 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 709 | # the deprecated list. This list is created by putting \deprecated commands in 710 | # the documentation. 711 | # The default value is: YES. 712 | 713 | GENERATE_DEPRECATEDLIST= YES 714 | 715 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 716 | # sections, marked by \if ... \endif and \cond 717 | # ... \endcond blocks. 718 | 719 | ENABLED_SECTIONS = 720 | 721 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 722 | # initial value of a variable or macro / define can have for it to appear in the 723 | # documentation. If the initializer consists of more lines than specified here 724 | # it will be hidden. Use a value of 0 to hide initializers completely. The 725 | # appearance of the value of individual variables and macros / defines can be 726 | # controlled using \showinitializer or \hideinitializer command in the 727 | # documentation regardless of this setting. 728 | # Minimum value: 0, maximum value: 10000, default value: 30. 729 | 730 | MAX_INITIALIZER_LINES = 30 731 | 732 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 733 | # the bottom of the documentation of classes and structs. If set to YES, the 734 | # list will mention the files that were used to generate the documentation. 735 | # The default value is: YES. 736 | 737 | SHOW_USED_FILES = YES 738 | 739 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 740 | # will remove the Files entry from the Quick Index and from the Folder Tree View 741 | # (if specified). 742 | # The default value is: YES. 743 | 744 | SHOW_FILES = YES 745 | 746 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 747 | # page. This will remove the Namespaces entry from the Quick Index and from the 748 | # Folder Tree View (if specified). 749 | # The default value is: YES. 750 | 751 | SHOW_NAMESPACES = YES 752 | 753 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 754 | # doxygen should invoke to get the current version for each file (typically from 755 | # the version control system). Doxygen will invoke the program by executing (via 756 | # popen()) the command command input-file, where command is the value of the 757 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 758 | # by doxygen. Whatever the program writes to standard output is used as the file 759 | # version. For an example see the documentation. 760 | 761 | FILE_VERSION_FILTER = 762 | 763 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 764 | # by doxygen. The layout file controls the global structure of the generated 765 | # output files in an output format independent way. To create the layout file 766 | # that represents doxygen's defaults, run doxygen with the -l option. You can 767 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 768 | # will be used as the name of the layout file. See also section "Changing the 769 | # layout of pages" for information. 770 | # 771 | # Note that if you run doxygen from a directory containing a file called 772 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 773 | # tag is left empty. 774 | 775 | LAYOUT_FILE = 776 | 777 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 778 | # the reference definitions. This must be a list of .bib files. The .bib 779 | # extension is automatically appended if omitted. This requires the bibtex tool 780 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 781 | # For LaTeX the style of the bibliography can be controlled using 782 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 783 | # search path. See also \cite for info how to create references. 784 | 785 | CITE_BIB_FILES = 786 | 787 | #--------------------------------------------------------------------------- 788 | # Configuration options related to warning and progress messages 789 | #--------------------------------------------------------------------------- 790 | 791 | # The QUIET tag can be used to turn on/off the messages that are generated to 792 | # standard output by doxygen. If QUIET is set to YES this implies that the 793 | # messages are off. 794 | # The default value is: NO. 795 | 796 | QUIET = NO 797 | 798 | # The WARNINGS tag can be used to turn on/off the warning messages that are 799 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 800 | # this implies that the warnings are on. 801 | # 802 | # Tip: Turn warnings on while writing the documentation. 803 | # The default value is: YES. 804 | 805 | WARNINGS = YES 806 | 807 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 808 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 809 | # will automatically be disabled. 810 | # The default value is: YES. 811 | 812 | WARN_IF_UNDOCUMENTED = YES 813 | 814 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 815 | # potential errors in the documentation, such as documenting some parameters in 816 | # a documented function twice, or documenting parameters that don't exist or 817 | # using markup commands wrongly. 818 | # The default value is: YES. 819 | 820 | WARN_IF_DOC_ERROR = YES 821 | 822 | # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete 823 | # function parameter documentation. If set to NO, doxygen will accept that some 824 | # parameters have no documentation without warning. 825 | # The default value is: YES. 826 | 827 | WARN_IF_INCOMPLETE_DOC = YES 828 | 829 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 830 | # are documented, but have no documentation for their parameters or return 831 | # value. If set to NO, doxygen will only warn about wrong parameter 832 | # documentation, but not about the absence of documentation. If EXTRACT_ALL is 833 | # set to YES then this flag will automatically be disabled. See also 834 | # WARN_IF_INCOMPLETE_DOC 835 | # The default value is: NO. 836 | 837 | WARN_NO_PARAMDOC = NO 838 | 839 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 840 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 841 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 842 | # at the end of the doxygen process doxygen will return with a non-zero status. 843 | # Possible values are: NO, YES and FAIL_ON_WARNINGS. 844 | # The default value is: NO. 845 | 846 | WARN_AS_ERROR = NO 847 | 848 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 849 | # can produce. The string should contain the $file, $line, and $text tags, which 850 | # will be replaced by the file and line number from which the warning originated 851 | # and the warning text. Optionally the format may contain $version, which will 852 | # be replaced by the version of the file (if it could be obtained via 853 | # FILE_VERSION_FILTER) 854 | # The default value is: $file:$line: $text. 855 | 856 | WARN_FORMAT = "$file:$line: $text" 857 | 858 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 859 | # messages should be written. If left blank the output is written to standard 860 | # error (stderr). 861 | 862 | WARN_LOGFILE = 863 | 864 | #--------------------------------------------------------------------------- 865 | # Configuration options related to the input files 866 | #--------------------------------------------------------------------------- 867 | 868 | # The INPUT tag is used to specify the files and/or directories that contain 869 | # documented source files. You may enter file names like myfile.cpp or 870 | # directories like /usr/src/myproject. Separate the files or directories with 871 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 872 | # Note: If this tag is empty the current directory is searched. 873 | 874 | INPUT = ..\Runtime 875 | 876 | # This tag can be used to specify the character encoding of the source files 877 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 878 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 879 | # documentation (see: 880 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. 881 | # The default value is: UTF-8. 882 | 883 | INPUT_ENCODING = UTF-8 884 | 885 | # If the value of the INPUT tag contains directories, you can use the 886 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 887 | # *.h) to filter out the source-files in the directories. 888 | # 889 | # Note that for custom extensions or not directly supported extensions you also 890 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 891 | # read by doxygen. 892 | # 893 | # Note the list of default checked file patterns might differ from the list of 894 | # default file extension mappings. 895 | # 896 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 897 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 898 | # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, 899 | # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C 900 | # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, 901 | # *.vhdl, *.ucf, *.qsf and *.ice. 902 | 903 | FILE_PATTERNS = *.c \ 904 | *.cc \ 905 | *.cxx \ 906 | *.cpp \ 907 | *.c++ \ 908 | *.java \ 909 | *.ii \ 910 | *.ixx \ 911 | *.ipp \ 912 | *.i++ \ 913 | *.inl \ 914 | *.idl \ 915 | *.ddl \ 916 | *.odl \ 917 | *.h \ 918 | *.hh \ 919 | *.hxx \ 920 | *.hpp \ 921 | *.h++ \ 922 | *.l \ 923 | *.cs \ 924 | *.d \ 925 | *.php \ 926 | *.php4 \ 927 | *.php5 \ 928 | *.phtml \ 929 | *.inc \ 930 | *.m \ 931 | *.markdown \ 932 | *.md \ 933 | *.mm \ 934 | *.dox \ 935 | *.py \ 936 | *.pyw \ 937 | *.f90 \ 938 | *.f95 \ 939 | *.f03 \ 940 | *.f08 \ 941 | *.f18 \ 942 | *.f \ 943 | *.for \ 944 | *.vhd \ 945 | *.vhdl \ 946 | *.ucf \ 947 | *.qsf \ 948 | *.ice 949 | 950 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 951 | # be searched for input files as well. 952 | # The default value is: NO. 953 | 954 | RECURSIVE = YES 955 | 956 | # The EXCLUDE tag can be used to specify files and/or directories that should be 957 | # excluded from the INPUT source files. This way you can easily exclude a 958 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 959 | # 960 | # Note that relative paths are relative to the directory from which doxygen is 961 | # run. 962 | 963 | EXCLUDE = 964 | 965 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 966 | # directories that are symbolic links (a Unix file system feature) are excluded 967 | # from the input. 968 | # The default value is: NO. 969 | 970 | EXCLUDE_SYMLINKS = NO 971 | 972 | # If the value of the INPUT tag contains directories, you can use the 973 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 974 | # certain files from those directories. 975 | # 976 | # Note that the wildcards are matched against the file with absolute path, so to 977 | # exclude all test directories for example use the pattern */test/* 978 | 979 | EXCLUDE_PATTERNS = 980 | 981 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 982 | # (namespaces, classes, functions, etc.) that should be excluded from the 983 | # output. The symbol name can be a fully qualified name, a word, or if the 984 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 985 | # AClass::ANamespace, ANamespace::*Test 986 | # 987 | # Note that the wildcards are matched against the file with absolute path, so to 988 | # exclude all test directories use the pattern */test/* 989 | 990 | EXCLUDE_SYMBOLS = 991 | 992 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 993 | # that contain example code fragments that are included (see the \include 994 | # command). 995 | 996 | EXAMPLE_PATH = 997 | 998 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 999 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 1000 | # *.h) to filter out the source-files in the directories. If left blank all 1001 | # files are included. 1002 | 1003 | EXAMPLE_PATTERNS = * 1004 | 1005 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 1006 | # searched for input files to be used with the \include or \dontinclude commands 1007 | # irrespective of the value of the RECURSIVE tag. 1008 | # The default value is: NO. 1009 | 1010 | EXAMPLE_RECURSIVE = NO 1011 | 1012 | # The IMAGE_PATH tag can be used to specify one or more files or directories 1013 | # that contain images that are to be included in the documentation (see the 1014 | # \image command). 1015 | 1016 | IMAGE_PATH = 1017 | 1018 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 1019 | # invoke to filter for each input file. Doxygen will invoke the filter program 1020 | # by executing (via popen()) the command: 1021 | # 1022 | # 1023 | # 1024 | # where is the value of the INPUT_FILTER tag, and is the 1025 | # name of an input file. Doxygen will then use the output that the filter 1026 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 1027 | # will be ignored. 1028 | # 1029 | # Note that the filter must not add or remove lines; it is applied before the 1030 | # code is scanned, but not when the output code is generated. If lines are added 1031 | # or removed, the anchors will not be placed correctly. 1032 | # 1033 | # Note that for custom extensions or not directly supported extensions you also 1034 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1035 | # properly processed by doxygen. 1036 | 1037 | INPUT_FILTER = 1038 | 1039 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1040 | # basis. Doxygen will compare the file name with each pattern and apply the 1041 | # filter if there is a match. The filters are a list of the form: pattern=filter 1042 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1043 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1044 | # patterns match the file name, INPUT_FILTER is applied. 1045 | # 1046 | # Note that for custom extensions or not directly supported extensions you also 1047 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1048 | # properly processed by doxygen. 1049 | 1050 | FILTER_PATTERNS = 1051 | 1052 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1053 | # INPUT_FILTER) will also be used to filter the input files that are used for 1054 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1055 | # The default value is: NO. 1056 | 1057 | FILTER_SOURCE_FILES = NO 1058 | 1059 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1060 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1061 | # it is also possible to disable source filtering for a specific pattern using 1062 | # *.ext= (so without naming a filter). 1063 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1064 | 1065 | FILTER_SOURCE_PATTERNS = 1066 | 1067 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1068 | # is part of the input, its contents will be placed on the main page 1069 | # (index.html). This can be useful if you have a project on for instance GitHub 1070 | # and want to reuse the introduction page also for the doxygen output. 1071 | 1072 | USE_MDFILE_AS_MAINPAGE = 1073 | 1074 | #--------------------------------------------------------------------------- 1075 | # Configuration options related to source browsing 1076 | #--------------------------------------------------------------------------- 1077 | 1078 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1079 | # generated. Documented entities will be cross-referenced with these sources. 1080 | # 1081 | # Note: To get rid of all source code in the generated output, make sure that 1082 | # also VERBATIM_HEADERS is set to NO. 1083 | # The default value is: NO. 1084 | 1085 | SOURCE_BROWSER = YES 1086 | 1087 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1088 | # classes and enums directly into the documentation. 1089 | # The default value is: NO. 1090 | 1091 | INLINE_SOURCES = NO 1092 | 1093 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1094 | # special comment blocks from generated source code fragments. Normal C, C++ and 1095 | # Fortran comments will always remain visible. 1096 | # The default value is: YES. 1097 | 1098 | STRIP_CODE_COMMENTS = YES 1099 | 1100 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1101 | # entity all documented functions referencing it will be listed. 1102 | # The default value is: NO. 1103 | 1104 | REFERENCED_BY_RELATION = NO 1105 | 1106 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1107 | # all documented entities called/used by that function will be listed. 1108 | # The default value is: NO. 1109 | 1110 | REFERENCES_RELATION = NO 1111 | 1112 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1113 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1114 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1115 | # link to the documentation. 1116 | # The default value is: YES. 1117 | 1118 | REFERENCES_LINK_SOURCE = YES 1119 | 1120 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1121 | # source code will show a tooltip with additional information such as prototype, 1122 | # brief description and links to the definition and documentation. Since this 1123 | # will make the HTML file larger and loading of large files a bit slower, you 1124 | # can opt to disable this feature. 1125 | # The default value is: YES. 1126 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1127 | 1128 | SOURCE_TOOLTIPS = YES 1129 | 1130 | # If the USE_HTAGS tag is set to YES then the references to source code will 1131 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1132 | # source browser. The htags tool is part of GNU's global source tagging system 1133 | # (see https://www.gnu.org/software/global/global.html). You will need version 1134 | # 4.8.6 or higher. 1135 | # 1136 | # To use it do the following: 1137 | # - Install the latest version of global 1138 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1139 | # - Make sure the INPUT points to the root of the source tree 1140 | # - Run doxygen as normal 1141 | # 1142 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1143 | # tools must be available from the command line (i.e. in the search path). 1144 | # 1145 | # The result: instead of the source browser generated by doxygen, the links to 1146 | # source code will now point to the output of htags. 1147 | # The default value is: NO. 1148 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1149 | 1150 | USE_HTAGS = NO 1151 | 1152 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1153 | # verbatim copy of the header file for each class for which an include is 1154 | # specified. Set to NO to disable this. 1155 | # See also: Section \class. 1156 | # The default value is: YES. 1157 | 1158 | VERBATIM_HEADERS = YES 1159 | 1160 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1161 | # clang parser (see: 1162 | # http://clang.llvm.org/) for more accurate parsing at the cost of reduced 1163 | # performance. This can be particularly helpful with template rich C++ code for 1164 | # which doxygen's built-in parser lacks the necessary type information. 1165 | # Note: The availability of this option depends on whether or not doxygen was 1166 | # generated with the -Duse_libclang=ON option for CMake. 1167 | # The default value is: NO. 1168 | 1169 | CLANG_ASSISTED_PARSING = NO 1170 | 1171 | # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS 1172 | # tag is set to YES then doxygen will add the directory of each input to the 1173 | # include path. 1174 | # The default value is: YES. 1175 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1176 | 1177 | CLANG_ADD_INC_PATHS = YES 1178 | 1179 | # If clang assisted parsing is enabled you can provide the compiler with command 1180 | # line options that you would normally use when invoking the compiler. Note that 1181 | # the include paths will already be set by doxygen for the files and directories 1182 | # specified with INPUT and INCLUDE_PATH. 1183 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1184 | 1185 | CLANG_OPTIONS = 1186 | 1187 | # If clang assisted parsing is enabled you can provide the clang parser with the 1188 | # path to the directory containing a file called compile_commands.json. This 1189 | # file is the compilation database (see: 1190 | # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the 1191 | # options used when the source files were built. This is equivalent to 1192 | # specifying the -p option to a clang tool, such as clang-check. These options 1193 | # will then be passed to the parser. Any options specified with CLANG_OPTIONS 1194 | # will be added as well. 1195 | # Note: The availability of this option depends on whether or not doxygen was 1196 | # generated with the -Duse_libclang=ON option for CMake. 1197 | 1198 | CLANG_DATABASE_PATH = 1199 | 1200 | #--------------------------------------------------------------------------- 1201 | # Configuration options related to the alphabetical class index 1202 | #--------------------------------------------------------------------------- 1203 | 1204 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1205 | # compounds will be generated. Enable this if the project contains a lot of 1206 | # classes, structs, unions or interfaces. 1207 | # The default value is: YES. 1208 | 1209 | ALPHABETICAL_INDEX = YES 1210 | 1211 | # In case all classes in a project start with a common prefix, all classes will 1212 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1213 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1214 | # while generating the index headers. 1215 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1216 | 1217 | IGNORE_PREFIX = 1218 | 1219 | #--------------------------------------------------------------------------- 1220 | # Configuration options related to the HTML output 1221 | #--------------------------------------------------------------------------- 1222 | 1223 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1224 | # The default value is: YES. 1225 | 1226 | GENERATE_HTML = YES 1227 | 1228 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1229 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1230 | # it. 1231 | # The default directory is: html. 1232 | # This tag requires that the tag GENERATE_HTML is set to YES. 1233 | 1234 | HTML_OUTPUT = html 1235 | 1236 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1237 | # generated HTML page (for example: .htm, .php, .asp). 1238 | # The default value is: .html. 1239 | # This tag requires that the tag GENERATE_HTML is set to YES. 1240 | 1241 | HTML_FILE_EXTENSION = .html 1242 | 1243 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1244 | # each generated HTML page. If the tag is left blank doxygen will generate a 1245 | # standard header. 1246 | # 1247 | # To get valid HTML the header file that includes any scripts and style sheets 1248 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1249 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1250 | # default header using 1251 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1252 | # YourConfigFile 1253 | # and then modify the file new_header.html. See also section "Doxygen usage" 1254 | # for information on how to generate the default header that doxygen normally 1255 | # uses. 1256 | # Note: The header is subject to change so you typically have to regenerate the 1257 | # default header when upgrading to a newer version of doxygen. For a description 1258 | # of the possible markers and block names see the documentation. 1259 | # This tag requires that the tag GENERATE_HTML is set to YES. 1260 | 1261 | HTML_HEADER = 1262 | 1263 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1264 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1265 | # footer. See HTML_HEADER for more information on how to generate a default 1266 | # footer and what special commands can be used inside the footer. See also 1267 | # section "Doxygen usage" for information on how to generate the default footer 1268 | # that doxygen normally uses. 1269 | # This tag requires that the tag GENERATE_HTML is set to YES. 1270 | 1271 | HTML_FOOTER = 1272 | 1273 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1274 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1275 | # the HTML output. If left blank doxygen will generate a default style sheet. 1276 | # See also section "Doxygen usage" for information on how to generate the style 1277 | # sheet that doxygen normally uses. 1278 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1279 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1280 | # obsolete. 1281 | # This tag requires that the tag GENERATE_HTML is set to YES. 1282 | 1283 | HTML_STYLESHEET = 1284 | 1285 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1286 | # cascading style sheets that are included after the standard style sheets 1287 | # created by doxygen. Using this option one can overrule certain style aspects. 1288 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1289 | # standard style sheet and is therefore more robust against future updates. 1290 | # Doxygen will copy the style sheet files to the output directory. 1291 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1292 | # style sheet in the list overrules the setting of the previous ones in the 1293 | # list). For an example see the documentation. 1294 | # This tag requires that the tag GENERATE_HTML is set to YES. 1295 | 1296 | HTML_EXTRA_STYLESHEET = doxygen-awesome/doxygen-awesome.css \ 1297 | doxygen-awesome/doxygen-awesome-darkmode-toggle.js \ 1298 | doxygen-awesome/doxygen-awesome-sidebar-only.css \ 1299 | doxygen-awesome/doxygen-awesome-sidebar-only-darkmode-toggle.css 1300 | 1301 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1302 | # other source files which should be copied to the HTML output directory. Note 1303 | # that these files will be copied to the base HTML output directory. Use the 1304 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1305 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1306 | # files will be copied as-is; there are no commands or markers available. 1307 | # This tag requires that the tag GENERATE_HTML is set to YES. 1308 | 1309 | HTML_EXTRA_FILES = 1310 | 1311 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1312 | # will adjust the colors in the style sheet and background images according to 1313 | # this color. Hue is specified as an angle on a color-wheel, see 1314 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1315 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1316 | # purple, and 360 is red again. 1317 | # Minimum value: 0, maximum value: 359, default value: 220. 1318 | # This tag requires that the tag GENERATE_HTML is set to YES. 1319 | 1320 | HTML_COLORSTYLE_HUE = 220 1321 | 1322 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1323 | # in the HTML output. For a value of 0 the output will use gray-scales only. A 1324 | # value of 255 will produce the most vivid colors. 1325 | # Minimum value: 0, maximum value: 255, default value: 100. 1326 | # This tag requires that the tag GENERATE_HTML is set to YES. 1327 | 1328 | HTML_COLORSTYLE_SAT = 100 1329 | 1330 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1331 | # luminance component of the colors in the HTML output. Values below 100 1332 | # gradually make the output lighter, whereas values above 100 make the output 1333 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1334 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1335 | # change the gamma. 1336 | # Minimum value: 40, maximum value: 240, default value: 80. 1337 | # This tag requires that the tag GENERATE_HTML is set to YES. 1338 | 1339 | HTML_COLORSTYLE_GAMMA = 80 1340 | 1341 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1342 | # page will contain the date and time when the page was generated. Setting this 1343 | # to YES can help to show when doxygen was last run and thus if the 1344 | # documentation is up to date. 1345 | # The default value is: NO. 1346 | # This tag requires that the tag GENERATE_HTML is set to YES. 1347 | 1348 | HTML_TIMESTAMP = NO 1349 | 1350 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1351 | # documentation will contain a main index with vertical navigation menus that 1352 | # are dynamically created via JavaScript. If disabled, the navigation index will 1353 | # consists of multiple levels of tabs that are statically embedded in every HTML 1354 | # page. Disable this option to support browsers that do not have JavaScript, 1355 | # like the Qt help browser. 1356 | # The default value is: YES. 1357 | # This tag requires that the tag GENERATE_HTML is set to YES. 1358 | 1359 | HTML_DYNAMIC_MENUS = YES 1360 | 1361 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1362 | # documentation will contain sections that can be hidden and shown after the 1363 | # page has loaded. 1364 | # The default value is: NO. 1365 | # This tag requires that the tag GENERATE_HTML is set to YES. 1366 | 1367 | HTML_DYNAMIC_SECTIONS = NO 1368 | 1369 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1370 | # shown in the various tree structured indices initially; the user can expand 1371 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1372 | # such a level that at most the specified number of entries are visible (unless 1373 | # a fully collapsed tree already exceeds this amount). So setting the number of 1374 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1375 | # representing an infinite number of entries and will result in a full expanded 1376 | # tree by default. 1377 | # Minimum value: 0, maximum value: 9999, default value: 100. 1378 | # This tag requires that the tag GENERATE_HTML is set to YES. 1379 | 1380 | HTML_INDEX_NUM_ENTRIES = 100 1381 | 1382 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1383 | # generated that can be used as input for Apple's Xcode 3 integrated development 1384 | # environment (see: 1385 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1386 | # create a documentation set, doxygen will generate a Makefile in the HTML 1387 | # output directory. Running make will produce the docset in that directory and 1388 | # running make install will install the docset in 1389 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1390 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1391 | # genXcode/_index.html for more information. 1392 | # The default value is: NO. 1393 | # This tag requires that the tag GENERATE_HTML is set to YES. 1394 | 1395 | GENERATE_DOCSET = NO 1396 | 1397 | # This tag determines the name of the docset feed. A documentation feed provides 1398 | # an umbrella under which multiple documentation sets from a single provider 1399 | # (such as a company or product suite) can be grouped. 1400 | # The default value is: Doxygen generated docs. 1401 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1402 | 1403 | DOCSET_FEEDNAME = "Doxygen generated docs" 1404 | 1405 | # This tag specifies a string that should uniquely identify the documentation 1406 | # set bundle. This should be a reverse domain-name style string, e.g. 1407 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1408 | # The default value is: org.doxygen.Project. 1409 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1410 | 1411 | DOCSET_BUNDLE_ID = org.doxygen.Project 1412 | 1413 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1414 | # the documentation publisher. This should be a reverse domain-name style 1415 | # string, e.g. com.mycompany.MyDocSet.documentation. 1416 | # The default value is: org.doxygen.Publisher. 1417 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1418 | 1419 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1420 | 1421 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1422 | # The default value is: Publisher. 1423 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1424 | 1425 | DOCSET_PUBLISHER_NAME = Publisher 1426 | 1427 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1428 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1429 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1430 | # on Windows. In the beginning of 2021 Microsoft took the original page, with 1431 | # a.o. the download links, offline the HTML help workshop was already many years 1432 | # in maintenance mode). You can download the HTML help workshop from the web 1433 | # archives at Installation executable (see: 1434 | # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo 1435 | # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). 1436 | # 1437 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1438 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1439 | # files are now used as the Windows 98 help format, and will replace the old 1440 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1441 | # HTML files also contain an index, a table of contents, and you can search for 1442 | # words in the documentation. The HTML workshop also contains a viewer for 1443 | # compressed HTML files. 1444 | # The default value is: NO. 1445 | # This tag requires that the tag GENERATE_HTML is set to YES. 1446 | 1447 | GENERATE_HTMLHELP = NO 1448 | 1449 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1450 | # file. You can add a path in front of the file if the result should not be 1451 | # written to the html output directory. 1452 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1453 | 1454 | CHM_FILE = 1455 | 1456 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1457 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1458 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1459 | # The file has to be specified with full path. 1460 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1461 | 1462 | HHC_LOCATION = 1463 | 1464 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1465 | # (YES) or that it should be included in the main .chm file (NO). 1466 | # The default value is: NO. 1467 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1468 | 1469 | GENERATE_CHI = NO 1470 | 1471 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1472 | # and project file content. 1473 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1474 | 1475 | CHM_INDEX_ENCODING = 1476 | 1477 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1478 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1479 | # enables the Previous and Next buttons. 1480 | # The default value is: NO. 1481 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1482 | 1483 | BINARY_TOC = NO 1484 | 1485 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1486 | # the table of contents of the HTML help documentation and to the tree view. 1487 | # The default value is: NO. 1488 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1489 | 1490 | TOC_EXPAND = NO 1491 | 1492 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1493 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1494 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1495 | # (.qch) of the generated HTML documentation. 1496 | # The default value is: NO. 1497 | # This tag requires that the tag GENERATE_HTML is set to YES. 1498 | 1499 | GENERATE_QHP = NO 1500 | 1501 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1502 | # the file name of the resulting .qch file. The path specified is relative to 1503 | # the HTML output folder. 1504 | # This tag requires that the tag GENERATE_QHP is set to YES. 1505 | 1506 | QCH_FILE = 1507 | 1508 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1509 | # Project output. For more information please see Qt Help Project / Namespace 1510 | # (see: 1511 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1512 | # The default value is: org.doxygen.Project. 1513 | # This tag requires that the tag GENERATE_QHP is set to YES. 1514 | 1515 | QHP_NAMESPACE = org.doxygen.Project 1516 | 1517 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1518 | # Help Project output. For more information please see Qt Help Project / Virtual 1519 | # Folders (see: 1520 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1521 | # The default value is: doc. 1522 | # This tag requires that the tag GENERATE_QHP is set to YES. 1523 | 1524 | QHP_VIRTUAL_FOLDER = doc 1525 | 1526 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1527 | # filter to add. For more information please see Qt Help Project / Custom 1528 | # Filters (see: 1529 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1530 | # This tag requires that the tag GENERATE_QHP is set to YES. 1531 | 1532 | QHP_CUST_FILTER_NAME = 1533 | 1534 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1535 | # custom filter to add. For more information please see Qt Help Project / Custom 1536 | # Filters (see: 1537 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1538 | # This tag requires that the tag GENERATE_QHP is set to YES. 1539 | 1540 | QHP_CUST_FILTER_ATTRS = 1541 | 1542 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1543 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1544 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1545 | # This tag requires that the tag GENERATE_QHP is set to YES. 1546 | 1547 | QHP_SECT_FILTER_ATTRS = 1548 | 1549 | # The QHG_LOCATION tag can be used to specify the location (absolute path 1550 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1551 | # run qhelpgenerator on the generated .qhp file. 1552 | # This tag requires that the tag GENERATE_QHP is set to YES. 1553 | 1554 | QHG_LOCATION = 1555 | 1556 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1557 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1558 | # install this plugin and make it available under the help contents menu in 1559 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1560 | # to be copied into the plugins directory of eclipse. The name of the directory 1561 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1562 | # After copying Eclipse needs to be restarted before the help appears. 1563 | # The default value is: NO. 1564 | # This tag requires that the tag GENERATE_HTML is set to YES. 1565 | 1566 | GENERATE_ECLIPSEHELP = NO 1567 | 1568 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1569 | # the directory name containing the HTML and XML files should also have this 1570 | # name. Each documentation set should have its own identifier. 1571 | # The default value is: org.doxygen.Project. 1572 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1573 | 1574 | ECLIPSE_DOC_ID = org.doxygen.Project 1575 | 1576 | # If you want full control over the layout of the generated HTML pages it might 1577 | # be necessary to disable the index and replace it with your own. The 1578 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1579 | # of each HTML page. A value of NO enables the index and the value YES disables 1580 | # it. Since the tabs in the index contain the same information as the navigation 1581 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1582 | # The default value is: NO. 1583 | # This tag requires that the tag GENERATE_HTML is set to YES. 1584 | 1585 | DISABLE_INDEX = NO 1586 | 1587 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1588 | # structure should be generated to display hierarchical information. If the tag 1589 | # value is set to YES, a side panel will be generated containing a tree-like 1590 | # index structure (just like the one that is generated for HTML Help). For this 1591 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1592 | # (i.e. any modern browser). Windows users are probably better off using the 1593 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1594 | # further fine tune the look of the index (see "Fine-tuning the output"). As an 1595 | # example, the default style sheet generated by doxygen has an example that 1596 | # shows how to put an image at the root of the tree instead of the PROJECT_NAME. 1597 | # Since the tree basically has the same information as the tab index, you could 1598 | # consider setting DISABLE_INDEX to YES when enabling this option. 1599 | # The default value is: NO. 1600 | # This tag requires that the tag GENERATE_HTML is set to YES. 1601 | 1602 | GENERATE_TREEVIEW = YES 1603 | 1604 | # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the 1605 | # FULL_SIDEBAR option determines if the side bar is limited to only the treeview 1606 | # area (value NO) or if it should extend to the full height of the window (value 1607 | # YES). Setting this to YES gives a layout similar to 1608 | # https://docs.readthedocs.io with more room for contents, but less room for the 1609 | # project logo, title, and description. If either GENERATOR_TREEVIEW or 1610 | # DISABLE_INDEX is set to NO, this option has no effect. 1611 | # The default value is: NO. 1612 | # This tag requires that the tag GENERATE_HTML is set to YES. 1613 | 1614 | FULL_SIDEBAR = NO 1615 | 1616 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1617 | # doxygen will group on one line in the generated HTML documentation. 1618 | # 1619 | # Note that a value of 0 will completely suppress the enum values from appearing 1620 | # in the overview section. 1621 | # Minimum value: 0, maximum value: 20, default value: 4. 1622 | # This tag requires that the tag GENERATE_HTML is set to YES. 1623 | 1624 | ENUM_VALUES_PER_LINE = 4 1625 | 1626 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1627 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1628 | # Minimum value: 0, maximum value: 1500, default value: 250. 1629 | # This tag requires that the tag GENERATE_HTML is set to YES. 1630 | 1631 | TREEVIEW_WIDTH = 250 1632 | 1633 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1634 | # external symbols imported via tag files in a separate window. 1635 | # The default value is: NO. 1636 | # This tag requires that the tag GENERATE_HTML is set to YES. 1637 | 1638 | EXT_LINKS_IN_WINDOW = NO 1639 | 1640 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1641 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1642 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1643 | # the HTML output. These images will generally look nicer at scaled resolutions. 1644 | # Possible values are: png (the default) and svg (looks nicer but requires the 1645 | # pdf2svg or inkscape tool). 1646 | # The default value is: png. 1647 | # This tag requires that the tag GENERATE_HTML is set to YES. 1648 | 1649 | HTML_FORMULA_FORMAT = png 1650 | 1651 | # Use this tag to change the font size of LaTeX formulas included as images in 1652 | # the HTML documentation. When you change the font size after a successful 1653 | # doxygen run you need to manually remove any form_*.png images from the HTML 1654 | # output directory to force them to be regenerated. 1655 | # Minimum value: 8, maximum value: 50, default value: 10. 1656 | # This tag requires that the tag GENERATE_HTML is set to YES. 1657 | 1658 | FORMULA_FONTSIZE = 10 1659 | 1660 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1661 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1662 | # supported properly for IE 6.0, but are supported on all modern browsers. 1663 | # 1664 | # Note that when changing this option you need to delete any form_*.png files in 1665 | # the HTML output directory before the changes have effect. 1666 | # The default value is: YES. 1667 | # This tag requires that the tag GENERATE_HTML is set to YES. 1668 | 1669 | FORMULA_TRANSPARENT = YES 1670 | 1671 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1672 | # to create new LaTeX commands to be used in formulas as building blocks. See 1673 | # the section "Including formulas" for details. 1674 | 1675 | FORMULA_MACROFILE = 1676 | 1677 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1678 | # https://www.mathjax.org) which uses client side JavaScript for the rendering 1679 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1680 | # installed or if you want to formulas look prettier in the HTML output. When 1681 | # enabled you may also need to install MathJax separately and configure the path 1682 | # to it using the MATHJAX_RELPATH option. 1683 | # The default value is: NO. 1684 | # This tag requires that the tag GENERATE_HTML is set to YES. 1685 | 1686 | USE_MATHJAX = NO 1687 | 1688 | # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. 1689 | # Note that the different versions of MathJax have different requirements with 1690 | # regards to the different settings, so it is possible that also other MathJax 1691 | # settings have to be changed when switching between the different MathJax 1692 | # versions. 1693 | # Possible values are: MathJax_2 and MathJax_3. 1694 | # The default value is: MathJax_2. 1695 | # This tag requires that the tag USE_MATHJAX is set to YES. 1696 | 1697 | MATHJAX_VERSION = MathJax_2 1698 | 1699 | # When MathJax is enabled you can set the default output format to be used for 1700 | # the MathJax output. For more details about the output format see MathJax 1701 | # version 2 (see: 1702 | # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 1703 | # (see: 1704 | # http://docs.mathjax.org/en/latest/web/components/output.html). 1705 | # Possible values are: HTML-CSS (which is slower, but has the best 1706 | # compatibility. This is the name for Mathjax version 2, for MathJax version 3 1707 | # this will be translated into chtml), NativeMML (i.e. MathML. Only supported 1708 | # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This 1709 | # is the name for Mathjax version 3, for MathJax version 2 this will be 1710 | # translated into HTML-CSS) and SVG. 1711 | # The default value is: HTML-CSS. 1712 | # This tag requires that the tag USE_MATHJAX is set to YES. 1713 | 1714 | MATHJAX_FORMAT = HTML-CSS 1715 | 1716 | # When MathJax is enabled you need to specify the location relative to the HTML 1717 | # output directory using the MATHJAX_RELPATH option. The destination directory 1718 | # should contain the MathJax.js script. For instance, if the mathjax directory 1719 | # is located at the same level as the HTML output directory, then 1720 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1721 | # Content Delivery Network so you can quickly see the result without installing 1722 | # MathJax. However, it is strongly recommended to install a local copy of 1723 | # MathJax from https://www.mathjax.org before deployment. The default value is: 1724 | # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 1725 | # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 1726 | # This tag requires that the tag USE_MATHJAX is set to YES. 1727 | 1728 | MATHJAX_RELPATH = 1729 | 1730 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1731 | # extension names that should be enabled during MathJax rendering. For example 1732 | # for MathJax version 2 (see 1733 | # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): 1734 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1735 | # For example for MathJax version 3 (see 1736 | # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): 1737 | # MATHJAX_EXTENSIONS = ams 1738 | # This tag requires that the tag USE_MATHJAX is set to YES. 1739 | 1740 | MATHJAX_EXTENSIONS = 1741 | 1742 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1743 | # of code that will be used on startup of the MathJax code. See the MathJax site 1744 | # (see: 1745 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1746 | # example see the documentation. 1747 | # This tag requires that the tag USE_MATHJAX is set to YES. 1748 | 1749 | MATHJAX_CODEFILE = 1750 | 1751 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1752 | # the HTML output. The underlying search engine uses javascript and DHTML and 1753 | # should work on any modern browser. Note that when using HTML help 1754 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1755 | # there is already a search function so this one should typically be disabled. 1756 | # For large projects the javascript based search engine can be slow, then 1757 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1758 | # search using the keyboard; to jump to the search box use + S 1759 | # (what the is depends on the OS and browser, but it is typically 1760 | # , /