Re: Perl bindings docstrings Re: svn commit: r1488693 - /subversion/trunk/subversion/bindings/swig/perl/native/Client.pm

On Sun, Jul 7, 2013 at 7:33 PM, Daniel Shahaf <danielsh_at_apache.org> wrote:

> Or perhaps we should look into a way to generate
> the Perl bindings' docstrings from the C API docstrings?
>

I'll have a look at how the Perl bindings for Gtk+ do this
(http://gtk2-perl.sourceforge.net/) Does anybody know of other examples?

On the other hand, there's not a one-to-one correspondence of
Perl vs C level parameters, e.g.:
- editor (or callback) + baton pairs in C are replaced by
  a single Perl callback (typically a closure) in Perl
- svn_opt_revision_t arguments in C may be actually
  specified as numbers, strings ("HEAD"), date strings ("{12-04-2013}")
  or (unlikely) as _p_svn_opt_revision_t objects in Perl
So it's as simple as "extract docstring from C header and reformat as POD".

Cheers, Roderich
Received on 2013-07-08 16:27:57 CEST