Re: [Swig-user] Please document the "docstring" %feature for the octave module

[William S F. <ws...@fu...>]

On 21/01/11 10:16, Alan W. Irwin wrote:
> On 2011-01-21 07:20-0000 William S Fulton wrote:
>
>> On 19/01/11 19:42, Alan W. Irwin wrote:
>>> I have now completed a project to create Octave bindings for PLplot
>>> using SWIG. The results are superior to what we had before with
>>> matwrapped Octave bindings so this effort with the Octave module for
>>> SWIG has rapidly transitioned from a proof-of-concept idea to
>>> something PLplot developers hope to rely on for the indefinite future.
>>>
>>> The result is we now have four language bindings (Python, Java, Lua,
>>> and now Octave) which we implement with SWIG, and there is some
>>> prospect for more PLplot bindings being generated this way such as
>>> Ruby. So we are very happy that the SWIG project exists, and we thank
>>> the SWIG developers for their on-going efforts.
>>>
>>> One feature of SWIG we rely on is the "docstring" %feature. We use
>>> that to generate a complete description of each PLplot function's use
>>> and arguments for Python and Octave now and potentially Ruby in the
>>> future. However, we only discovered that the SWIG Octave module
>>> supported the "docstring" %feature by looking at the documentation of
>>> the original SWIG Octave module sourceforge project before that module
>>> became an official part of SWIG.
>>>
>>> It concerns the PLplot developers that that "docstring" %feature is
>>> not documented in the official SWIG Octave module. Therefore, we
>>> request that issue be addressed.
>>
>> If you point me to this exact location of this documentation and if we
>> don't have it in the official SWIG repository I'll move it in.
>> Otherwise, I'm quite happy to accept patches to the Octave docs, it is
>> a simple html file in Doc/Manual/Octave.html.
>
> The "documentation" is a sentence at
> http://octave-swig.sourceforge.net that basically says the docstring
> %feature has been implemented. That encouraged the PLplot developers
> to experiment with that %feature of the Octave module with a lot of
> success. We will try to provide more detailed documentation based on
> our experiences as you have requested.
>

I see. A patch to Doc/Manual/Octave.html with a short paragraph about 
this and simple example usage would be ideal.

William