Skip to content
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

[Documentation] Doxygen Takes Forever #12255

Open
4 tasks
matekelemen opened this issue Apr 7, 2024 · 0 comments
Open
4 tasks

[Documentation] Doxygen Takes Forever #12255

matekelemen opened this issue Apr 7, 2024 · 0 comments

Comments

@matekelemen
Copy link
Contributor

I tried running doxygen after a good while and noticed that it takes forever to run. I remember something about requiring C++ language parsing (@sunethwarna), but we need to do something about this because it can't even be sped up with multiple threads (by manually overriding NUM_PROC_THREADS).

ToDo

How about this?

Adopt the core/application structure of the source tree: core and each application generate separate doxygen documentations, and produce tag files. If an application depends on another one (or core), link to the related tag file.

  • partition the doxygen doc generation into partitions (core and each application separately)
  • build a dependency graph between applications (this could come from CMake)
  • run each level of doc generation concurrently (core first, then primary apps depending only on core, then secondary apps depending on other apps, etc.)
  • assemble the root docs from core and all apps
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants