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

Generate docs for public headers in build dir #1248

Open
elliotcmorris opened this issue Jan 20, 2024 · 1 comment
Open

Generate docs for public headers in build dir #1248

elliotcmorris opened this issue Jan 20, 2024 · 1 comment

Comments

@elliotcmorris
Copy link
Contributor

[plan] This file (and presumably the export.h files) don't show up in Doxygen docs. Presumably because Doxygen isn't configured to scan the build directory for our generated public headers. We should fix that, especially now we have actual functionality that's going undocumented.

Originally posted by @feltech in #1247 (comment)

We now have export.h and version.hpp in the build directory without docs being generated from them. If you squint, version.hpp does define a public interface due to the macros being useful in pipelines, so it'd be nice to doc em.

In order to do this, we'd need to enable file based documentation in our generated output, which tbh seems like a good idea.

@feltech
Copy link
Member

feltech commented Jan 22, 2024

I think even if we don't enable file based documentation we'll get some docs, at least for the functions. However, I agree that enabling file docs would be good.

@feltech feltech added this to the v1.0.0 milestone Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants