Skip to content

Commit

Permalink
Turn on autodoc so that help messages are available in python
Browse files Browse the repository at this point in the history
  • Loading branch information
tnipen committed Nov 29, 2023
1 parent 8023fd7 commit 7157875
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions swig/titanlib.i
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@
%apply int& OUTPUT { int& X2_out };
%apply int& OUTPUT { int& Y2_out };

// This turns on automatic description of function arguments in the python package. The
// problem is that it doesn't fetch any of the comments in the header file describing each
// parameter, so only the type is shown.
// A different approach is to use -doxygen with swig
%feature("autodoc", "2");

%{
#include "titanlib.h"
%}
Expand Down

0 comments on commit 7157875

Please sign in to comment.