jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add support for manual %docstrings, so users can provide texinfo help for wrapped functions.

Browse source 
Add some support for autodoc feature, so otherwise undocumented functions at least get prototype.
Fix bug in argument number check.



git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@10341 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Xavier Delacour 2008-04-03 13:22:19 +00:00
commit 05097de0ff
3 changed files with 191 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Lib/octave/octave.swg
View file

@ -4,3 +4,5 @@
%include <octuserdir.swg>
%include <octtypemaps.swg>
%include <octopers.swg>
%define %docstring %feature("docstring") %enddef

22
Lib/octave/octrun.swg
View file

@ -4,7 +4,7 @@ SWIGRUNTIME bool SWIG_check_num_args(const char *func_name, int num_args, int ma
if (num_args > max_args && !varargs)
error("function %s takes at most %i arguments", func_name, max_args);
else if (num_args < min_args)
error("function %s requires at least %i arguments", func_name, max_args);
error("function %s requires at least %i arguments", func_name, min_args);
else
return true;
return false;
@ -172,6 +172,7 @@ namespace {
swig_type_info **type;
int director;
octave_func constructor;
const char *constructor_doc;
octave_func destructor;
const swig_octave_member *members;
const char **base_names;
@ -385,6 +386,14 @@ namespace {
return (long) this;
return (long) types[0].second.ptr;
}
const char* help_text() const {
if (!types.size())
return 0;
if (!types[0].first->clientdata)
return 0;
swig_octave_class *c = (swig_octave_class *) types[0].first->clientdata;
return c->constructor_doc;
}
std::string swig_type_name() const {
// * need some way to manually name subclasses.
@ -420,10 +429,19 @@ namespace {
for (member_map::const_iterator it = members.begin(); it != members.end(); ++it) {
if (it->second.first && it->second.first->method)
install_builtin_function(it->second.first->method, it->first,
/*it->second.first->doc?it->second.first->doc:*/std::string());
it->second.first->doc?it->second.first->doc:std::string());
else if (it->second.second.is_defined()) {
link_to_global_variable(curr_sym_tab->lookup(it->first, true));
set_global_value(it->first, it->second.second);
octave_swig_type *ost = Swig::swig_value_deref(it->second.second);
if (ost) {
const char* h = ost->help_text();
if (h) {
symbol_record *sr = global_sym_tab->lookup (it->first, true);
sr->document(h);
}
}
}
}
}