search

EnEff-BIM / EnEffBIM-Framework

translating from BIM to BEPS
MIT License
8 stars 0 forks source link

SWIG autodoc docstring #123

Closed thorade closed 7 years ago

thorade commented 8 years ago

SWIG is able to generate docstrings for Python. These docstrings can either be written manually (any text) or automatically (list of parameters, attributes and return values). http://www.swig.org/Doc1.3/Python.html#Python_nn65

@math-boy could you check whether it is easy to enable this feature?

thorade commented 8 years ago

Also see this issue: https://github.com/casadi/casadi/issues/1635

math-boy commented 8 years ago

@thorade Thax for the info. I will check it when my current coding for the mapping rule is totally done.

thorade commented 8 years ago

The above link was to the old SWIG 1.3 documentation, the latest docs are here: http://www.swig.org/Doc3.0/Python.html#Python_nn65 Could you check whether enabling the autodoc feature is easy?