search

sciapp / gr

GR framework: a graphics library for visualisation applications
Other
329 stars 54 forks source link

Doxygen documentation #75

Closed v0dro closed 5 years ago

v0dro commented 5 years ago

Would be great and extremely useful to have the C API properly documented using the standard Doxygen format. If the contributors are OK with this I can start sending some patches as I build the Ruby bindings.

FlorianRhiem commented 5 years ago

We are using doxygen to generate the API reference with a Doxyfile in the gr-documentation repository. The doxygen XML output is then processed by breathe so we can integrate it with the rest of our documentation. Examples for this can be found in gr.c.

Obviously there are still plenty of undocumented functions in the C API and I'd be happy to see that change. :)

v0dro commented 5 years ago

Great. I'll send some PRs through as I use GR.