-
-
Notifications
You must be signed in to change notification settings - Fork 44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update /relocate VSE/engine /doxygen.config #705
Comments
Python code should use Sphinx; but we do need to refactor the general structure some. For one, I'd like to pull CMakeLists.txt up to the project root which would make a bunch of things easier overall; I'd also like to modularize it more for easier maintenance across all the branches. Doxygen should be integrated into CMake too. |
My thought would be a {app-name} dir and an (app-name}.read-me, so no matter what you use you can place for VS/local scripts and output |
Here is anupdated doxygenConfig. REQUIRES: doxygen and graphvis for graphics |
Oh BTW, if you add {relative path to Assets} after "INPUT = ./engine/( ../Assets-Production-0.8.x/). doxygen will run through assets as well |
@LifWirser this would be something good to add to master as it'd be a new feature as far as our releases go. |
This is still a work in progress. I found 2 examples of how to incorperate into Cmake, but haven't yet worked on. Many options are available, I've been considering a mune driven script to select doxygen options - , but for now the basic doxygenconfig wiil need hand editing. BTW when I ul-ed doxygenConfig I had to add ".txt" to filename for gh issues to accept file and did not edit post to reflect this 8^( I'll git master and put in a pull req for the doxygen.config and maybee gdb scripts as well. . Dont expect any work untill week or two after 4th. |
hand editing the config is just fine; we don't need anything fancy in there right now; integration with cmake is more important so it works with the rest of our tool chain. |
PR #719 contains the basics for implementing. There is/are file for incorperating doxygen into cmake build systems - a seperate issue should be written when ready to be worked on |
further news isee PR #719 |
In VSE-0.8.x /engine/doxygen.config is out of date (corrected by " doxygen -u doxygen.config" . Also in [VSE_dir]/doc/ DOCUMENTATION doxygen is refered to with no links or other info.
Seperately I'd like to move "doxygen.config to doc dir as well as resulting output. This requires editing doxygen appropiately to adjust relative dirs.
finally it seema possible to use doxyged on python code and xml in assets pkg. so adding these files to doxygen.config may be usefull.
keeping setup files for other profilers/debuggers in /doc (at least seperate from code helps keep code/data filetrees clean).
The text was updated successfully, but these errors were encountered: