#93 Improve typemap docs in autodoc docstring

open
nobody
None
5
2014-10-27
2013-12-16
Chris Long
No

It would be really nice if the Python docstring created by the autodoc feature included info about typemaps that were applied. My specific case is a function returning a value via a pointer, where I use an OUTPUT typemap on it, similar to:

%apply int *OUTPUT { int *result };
int add(int x, int y, int *result); // return value is 0 or an error code

The docstring generated by autodoc doesn't list result as a parameter, so that's good. But it doesn't list result as part of the return value, either. I'd like it to show that result gets returned.

Discussion


Log in to post a comment.