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

Namespaces landing page does not list namespaces if no class/record is defined in the namespace #38

Open
manstetten opened this issue Feb 14, 2023 · 1 comment

Comments

@manstetten
Copy link

Hallo!

you crafted a great tool; just I noticed that (in my case: v.1.4.1 and llvm-14 on ubuntu) the namepaces.html does not list a namespace if no class is defined in the namespace.

PS: The functions are documented as expected in functions.html also including the correct namespaces.

VG, Paul

@hdoc
Copy link
Owner

hdoc commented Feb 23, 2023

Thank you for the kind comments :)

Yes, currently hdoc does not print free functions under the namespace tree, only records (structs, classes, unions) and enums. The main reason for this is that namespaces.html can become quite big even without including free functions, see for example LLVM where namespaces.html is 1.2MiB.

However LLVM's massive size is an edge case and I think it makes sense to add free functions to the namespace tree in the next release. We will work to add it. Thank you for the suggestion!

I took a look around your work on GitHub and it is very interesting! If you are willing to share, we would be interested in seeing how you use hdoc and if there are any other pain points that we could help fix.

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

No branches or pull requests

2 participants