search

FFIG / ffig

Generate code to call C++ libraries from other languages
MIT License
29 stars 9 forks source link

Documentation of supported bindings #3

Open jbcoe opened 9 years ago

jbcoe commented 9 years ago

List what is intended to work and what is intended to not work.

petr-tik commented 7 years ago

As part of documenting the API etc, I suggest we agree on a doc generator tool that we can use across different languages. I will then go through functions and document them in terms of input and output.

This should provide us with a good skeleton, which we can expand with system docs

http://www.sphinx-doc.org/en/stable/ https://github.com/doxygen/doxygen

Thoughts?

jbcoe commented 7 years ago

The docs I had in mind are more along the lines of tests:

GIVEN this input WHEN I run FFIG.py THEN I get this cppmodel and these python bindings etc.

I'm not sure that can be generated.

petr-tik commented 7 years ago

Ok, but as a separate issue, is it ok if I go through the codebase adding docstrings to python methods and classes?

jbcoe commented 7 years ago

Please do! That would be really helpful.