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

doxygen documentation online is out of date #80

Closed
tjhei opened this issue Jul 22, 2020 · 6 comments
Closed

doxygen documentation online is out of date #80

tjhei opened this issue Jul 22, 2020 · 6 comments

Comments

@tjhei
Copy link
Contributor

tjhei commented Jul 22, 2020

The doxygen online documentation at https://p4est.github.io/api/index.html is still at 1.1. Maybe it is worth updating?

@cburstedde
Copy link
Owner

Yes, good point. Let me look into updating it.

@cburstedde
Copy link
Owner

We'll get to this when the current incremental improvements are stabilizing and v2.3.2 is released.

@cburstedde
Copy link
Owner

Very true this needs to be updated. Picking up work again to bump the docs for both libsc and p4est.

@cburstedde
Copy link
Owner

I did a major tag, abi version and docyxgen update. Please let me know if anything seems out of date.

@cburstedde
Copy link
Owner

We should be getting close to bumping with the next patch version.

I might ask @hannesbrandt if he'd like to update the documentation of p{4,8}est_mesh_get_neighbors to match its behaviour exactly even though we'll be retiring this function with one of the next minor versions.

@cburstedde
Copy link
Owner

Ok with the new release 2.8.6 we have updated all of doxygen.
It is reachable from p4est.org and reproducible by `make doxygen'.

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

No branches or pull requests

2 participants