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

Tagfiles #650

Open
alandefreitas opened this issue Jul 25, 2024 · 0 comments · May be fixed by #670
Open

Tagfiles #650

alandefreitas opened this issue Jul 25, 2024 · 0 comments · May be fixed by #670
Assignees

Comments

@alandefreitas
Copy link
Collaborator

Generators should generate tagfiles in the doxygen format. Tagfiles contain a list of symbols and their relative urls. They allow for documentation to refer to symbols in other documentation.

Here are some examples:

https://github.com/alandefreitas/url/blob/update-antora/doc/lib/cpp_tagfiles/cppreference-doxygen-web.tag.xml
https://github.com/alandefreitas/url/tree/update-antora/doc/tagfiles

We already have an Antora extension for the Antora documentation to use these tagfiles. I copied some logic from the collector extension to allow components to set their tagfiles besides tagfiles that might be set in the playbook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

Successfully merging a pull request may close this issue.

2 participants