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

Document some static functions as non-static #1149

Open
mglisse opened this issue Oct 26, 2024 · 0 comments
Open

Document some static functions as non-static #1149

mglisse opened this issue Oct 26, 2024 · 0 comments

Comments

@mglisse
Copy link
Member

mglisse commented Oct 26, 2024

static Simplex_key key(Simplex_handle sh) {
The fact that the function is static is an implementation detail, because it does not use this, but we still want users to call the function with st.key(sh), not ST::key(sh), so we should document that.
Other projects use #ifdef DOXYGEN_RUNNING to enable different code with doxygen vs a real compiler.

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

1 participant