Skip to content
This repository was archived by the owner on Jun 27, 2023. It is now read-only.

Commit 5905804

Browse files
committed
Added docstring to the Ad module
1 parent e63b5cc commit 5905804

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

swig/sphinxbase/ad.i

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,23 @@
3535
*
3636
*/
3737

38-
%module ad
38+
%define DOCSTRING
39+
"This documentation was automatically generated using original comments in
40+
Doxygen format. As some C types and data structures cannot be directly mapped
41+
into Python types, some non-trivial type conversion could have place.
42+
Basically a type is replaced with another one that has the closest match, and
43+
sometimes one argument of generated function comprises several arguments of the
44+
original function (usually two).
45+
46+
Functions having error code as the return value and returning effective
47+
value in one of its arguments are transformed so that the effective value is
48+
returned in a regular fashion and run-time exception is being thrown in case of
49+
negative error code."
50+
%enddef
51+
52+
%module(docstring=DOCSTRING) ad
53+
54+
%feature("autodoc", "1");
3955

4056
%include pybuffer.i
4157
%include typemaps.i

0 commit comments

Comments
 (0)