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

Make all methods show in java API #6626

Merged
merged 2 commits into from
Mar 8, 2023
Merged

Conversation

BramVerb
Copy link
Contributor

@BramVerb BramVerb commented Mar 7, 2023

Some methods did not show up in the java documentation, for example the mkUnaryMinus and mkDiv, making the methods final made them show up for me in the documentation.

I do not know if this was intentional, but I do think that these methods should show up in the documentation, as they are also available in the Java API

@NikolajBjorner
Copy link
Contributor

mkPower doesn't show up.
Perhaps all the ones with public <... are not understood by doxygen.

@BramVerb
Copy link
Contributor Author

BramVerb commented Mar 7, 2023

There are way more methods that do not show up, and indeed, they all seem to include the generics syntax with <>.

@NikolajBjorner
Copy link
Contributor

NikolajBjorner commented Mar 8, 2023

either update them all because "final" has some semantic merit or if Doxygen has an approach use it

@NikolajBjorner
Copy link
Contributor

Bing chat gives a summary:
According to some web sources12, Doxygen may have some issues with documenting Java generic methods. One possible workaround is to use static modifiers for your generic methods1, as this seems to make Doxygen accept arbitrary strings as return type modifiers. Another possible workaround is to use a different version of Doxygen that may have fixed this bug3.

I hope this helps. Do you want me to show you how to use static modifiers for your generic methods or how to install a different version of Doxygen?

@BramVerb
Copy link
Contributor Author

BramVerb commented Mar 8, 2023

@microsoft-github-policy-service agree

@BramVerb
Copy link
Contributor Author

BramVerb commented Mar 8, 2023

I did a search and replace for all generic methods, so it works now for the Context.java class.
I don't think this is the nicest solution, but I hope this PR for doxygen will be merged at some point to resolve the issue.

@NikolajBjorner NikolajBjorner merged commit 1612b57 into Z3Prover:master Mar 8, 2023
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

Successfully merging this pull request may close these issues.

None yet

2 participants