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

Create documentation for C bindings #53

Open
awvwgk opened this issue Mar 12, 2022 · 1 comment
Open

Create documentation for C bindings #53

awvwgk opened this issue Mar 12, 2022 · 1 comment
Labels
bindings: C Export of C API via bind(c) documentation Improvements or additions to documentation

Comments

@awvwgk
Copy link
Member

awvwgk commented Mar 12, 2022

The C bindings are currently not documented outside of the comments in the header. Maybe we can make use of doxygen to create API docs for those.
@awvwgk awvwgk added documentation Improvements or additions to documentation bindings: C Export of C API via bind(c) labels Mar 12, 2022
@ivan-pi
Copy link
Member

ivan-pi commented Mar 13, 2022

Does Sphinx support multi-programming-language documentation? I recall browsing some API docs, where the user could select the programming language via a drop-down menu. PLplot also has something like this for the examples.

On the other side doxygen has the benefit that C users are already accustomed to it's layout.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bindings: C Export of C API via bind(c) documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ivan-pi @awvwgk