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

Make adiar::internal its own Module in Documentation #586

Open
7 tasks
SSoelvsten opened this issue Nov 28, 2023 · 1 comment
Open
7 tasks

Make adiar::internal its own Module in Documentation #586

SSoelvsten opened this issue Nov 28, 2023 · 1 comment

Comments

@SSoelvsten
Copy link
Owner

SSoelvsten commented Nov 28, 2023

To help developers, we should allow the documentation to be compiled with internal stuff too.

  • Add ADIAR_DOCS_INTERNAL as a CMake option
    • Add docs/internal for a definition of the Internal module and its subgroups.
    • Add files to Doxygen INPUTS (see docs/doxyfile.in)
    • Make each header file in <adiar/internal/...> start out with adding itself to the Doxygen module module__internal.
    • Hide the entire internal module if ADIAR_DOCS_INTERNAL is OFF.
  • Add ADIAR_DOCS_TODO as a CMake option
    • Convert relevant TODO: into \todo

Additional Context

Requested by Erik Funder Carstensen while working on an MSc course project.

@SSoelvsten
Copy link
Owner Author

SSoelvsten commented Dec 13, 2023

Seeing the first draft for the Internal module on the docs/internal branch, it needs much more work. Right now, it just follows the folder structure. But, doing so still leaves every folder as a giant mess of disparate definitions. Especially the internal/algorithms folder is completely impossible to browse.

@SSoelvsten SSoelvsten removed their assignment Jan 16, 2024
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

1 participant