Tracktion / tracktion_engine

Tracktion Engine module
Other
1.19k stars 151 forks source link

Fix all doxygen engine doc and also python script crashing because juce module header build/juce.h is not found #28

Closed fab672000 closed 2 years ago

fab672000 commented 3 years ago

and gracefully indicate that the module header (i.e. the juce dependency) is skipped.

Also adds a convenient debug launch.json vscode python config file to allow debugging python script(s). In order to use vscode to build/debug python just install in vscode the "Python" and "Python for VSCode" extensions then open a python file.

In future, we should be able to generate the modules grouping directly from source and therefore not duplicate the full source code to the build folder, this seems unnecessary and slows down significantly the documentation process. The usual approach for adding modules groups is to ask each class to add itself to a group (using the @addgroup statement) so that doxygen will automatically discover them eliminating the need for the script, while preserving complete genericity to that process.

For now keep using the script and focus of the documentation content.

fab672000 commented 3 years ago

For legal concerns: I am aware and agree that any material improvement that I provide in this PR for the project (and also future ones if any here) can be freely used both non-commercially and commercially in accordance with the tracktion engine dual license.

drowaudio commented 2 years ago

Added these here: https://github.com/Tracktion/tracktion_engine/commit/7acaf7933e5b8e607a67f2dcbe4f5ab943b3cb12

github-actions[bot] commented 2 years ago

Unit Test Results

       3 files  ±       0         3 suites  ±0   0s :stopwatch: ±0s    154 tests +   127     154 :heavy_check_mark: +   128  0 :zzz: ±0  0 :x:  - 1  6 072 runs  +5 967  6 072 :heavy_check_mark: +5 970  0 :zzz: ±0  0 :x:  - 3 

Results for commit 7acaf793. ± Comparison against base commit 6c26c213.

github-actions[bot] commented 2 years ago

Performance Test Results

0 files  ±0  0 suites  ±0   0s :stopwatch: ±0s 0 tests ±0  0 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit 7acaf793. ± Comparison against base commit 6c26c213.