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

Documentation of certain functions is hidden #16142

Open
sairajat opened this issue Oct 15, 2023 · 4 comments
Open

Documentation of certain functions is hidden #16142

sairajat opened this issue Oct 15, 2023 · 4 comments

Comments

@sairajat
Copy link
Contributor

sairajat commented Oct 15, 2023

The documentation of tensor.h is missing a lot of contract functions in the tensor class.
Attached is the screenshot of how the current documentation looks like. It is missing the functions contract, contract2, double_contract, and scalar_product. They are still defined in the tensor.h header file but not documented there.
Is that intentional?

docubyg

@sairajat sairajat changed the title Documentation not showing certain functions Documentation of certain functions is hidden Oct 15, 2023
@bangerth
Copy link
Member

None of these are member functions. Do they show up on a different part of the page?

@sairajat
Copy link
Contributor Author

No, they do not appear anywhere on the page.
https://www.dealii.org/current/doxygen/deal.II/classTensor.html

@sairajat
Copy link
Contributor Author

They donot even show up in the documentation search. Invert is also amongst one of those. The documentation is built incorrectly atleast for the Tensor.h file.

@bangerth
Copy link
Member

I wished I could say what causes this, but doxygen is a bit of a black box to me. One would have to come up with a smaller test case (say only this one file) and play with different ideas of coercing doxygen to include everything as intended.

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