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.

Sign up for GitHub

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

Jump to bottom

Avoid duplicate documentation for proc function pointers #315

Open
kainino0x opened this issue Jul 23, 2024 · 0 comments
Open

Avoid duplicate documentation for proc function pointers #315

kainino0x opened this issue Jul 23, 2024 · 0 comments
Labels
needs docs Non-trivial API contract needs to be documented. Orthogonal to open vs closed; remove when doc'd. non-breaking Does not require a breaking change (that would block V1.0)

Comments

@kainino0x
Copy link
Collaborator

kainino0x commented Jul 23, 2024 •
edited
Loading

Currently the C header generator will output the same docs twice for methods: once for the function declaration, once for the proc function pointer type definition.

We could use Doxygen's @copydoc to avoid this in the source, but it would still be duplicated in the generated documentation.

Not sure if it would be better to do this, or to just link to the non-proc version.
@kainino0x kainino0x added needs docs Non-trivial API contract needs to be documented. Orthogonal to open vs closed; remove when doc'd. non-breaking Does not require a breaking change (that would block V1.0) labels Jul 23, 2024
@kainino0x kainino0x mentioned this issue Jul 23, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
needs docs Non-trivial API contract needs to be documented. Orthogonal to open vs closed; remove when doc'd. non-breaking Does not require a breaking change (that would block V1.0)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kainino0x