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

Symbols not being documented in Boost.URL #584

Closed
alandefreitas opened this issue May 23, 2024 · 1 comment
Closed

Symbols not being documented in Boost.URL #584

alandefreitas opened this issue May 23, 2024 · 1 comment
Assignees
Labels
Bug Something isn't working Feature Something new that it should do

Comments

@alandefreitas
Copy link
Collaborator

alandefreitas commented May 23, 2024

This issue has been split from #480 (Features missing for Boost.URL) as it turned out to be more complex than we initially thought.

mrdocs doesn't pick up the javadocs for many classes (https://792.urlantora.prtest2.cppalliance.org/site/url/reference/boost/urls/ignore_case.html). Probably because they have some ifdefs involved (https://github.com/boostorg/url/blob/cf2a888c42dedc25f8223dc61d4707e83bd7a22b/include/boost/url/ignore_case.hpp#L31-L37).

The problem here is symbols in header files that end up not being transitively included by source files are not documented because of how we use the compile_commands.json file. standardese proposes a solution to this and doxygen also has a different solution to this problem. We can compare what these other tools do here.

@alandefreitas alandefreitas changed the title Ignored classes are being documented Symbols not being documented in Boost.URL May 23, 2024
@alandefreitas alandefreitas added the Feature Something new that it should do label May 24, 2024
@alandefreitas alandefreitas self-assigned this May 24, 2024
@alandefreitas alandefreitas added the Bug Something isn't working label May 24, 2024
@alandefreitas alandefreitas moved this to Available in MrDocs May 24, 2024
@alandefreitas
Copy link
Collaborator Author

This has fixed itself via other PRs that included the documentation for classes and functions.

@github-project-automation github-project-automation bot moved this from Available to Done in MrDocs Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Feature Something new that it should do
Projects
Status: Done
Development

No branches or pull requests

1 participant