Re: [Swig-user] a way to generate python __doc__ strings?

[Philipp K. <oe...@gm...>]

Dear Rich,
sorry for my late reply, but I was travelling.
I'm not sure how it works with macros, but generally I include first the
documentation and then the interface. It looks as you are doing it the other
way round. Have you tried that already?
Try:
%include "../doc/xml/sms_doxy.i"
%include "../src/sms.h"

instead of :
%include "../src/sms.h"
%include "../doc/xml/sms_doxy.i"


Philipp


>
>There is no error.  It seems to produce the docstrings as I mentioned
>above.  I just don't see them in python. For example:
>
>In [2]: ?pysms.SMS_VERSION
>Type:		float
>Base Class:	<type 'float'>
>String Form:	1.0
>Namespace:	Interactive
>Docstring:
>    float(x) -> floating point number
>
>    Convert a string or number to a floating point number, if possible.
>
>
>Whereas, I have SMS_VERSION declared in my header file as:
>
>#define SMS_VERSION 1.0 /*!< \brief version control number */
>
>
>
>
>On Mon, Dec 8, 2008 at 2:29 PM, Mathieu Malaterre
><mat...@gm...> wrote:
>> What is the error report when you run:
>>
>>  $ python doxy2swig.py path/to/index.xml
>>
>> On Mon, Dec 8, 2008 at 2:25 PM, Rich E <rea...@gm...> wrote:
>>> This is the "nice script" that I mentioned in my last post :)  But, it
>>> isn't working out of the box or I have an error in my code.
>>>
>>> On Mon, Dec 8, 2008 at 1:39 PM, Mathieu Malaterre
>>> <mat...@gm...> wrote:
>>>> As mentionned before, this works out of the box:
>>>>
>>>> http://www.aero.iitb.ac.in/~prabhu/software/code/python/doxy2swig.py
>>>>
>>>> 2cts
>>>>
>>>> On Thu, Dec 4, 2008 at 11:12 PM, William S Fulton
>>>> <ws...@fu...> wrote:
>>>>> Cheryl Foil started a summer of code 2008 project to extract Doxygen
>>>>> comments  from the c/c++ source. The initial target language was for
>>>>> Java. It was enhanced by Jamie Kirkpatrick in September this year for
>>>>> Python. The code lives in the gsoc2008-cherylfoil branch. I'm not sure
>>>>> of the exact status of it, but when it is shown to be polished off, I
>>>>> would like to see it integrated into the main SWIG distribution.
>>>>>
>>>>> William
>>>>>
>>>>> Rich E wrote:
>>>>>> I'd also like to get the doxygen I wrote in C files into my SWIG
>>>>>> wrappers, but can't yet get it to work.  I used this nice script that
>>>>>> you linked to to produce a file "sms_doxy.i", which I see includes
>>>>>>
>>>>>> %feature("docstring") sms_FUNCTIONNAME
>>>>>>
>>>>>> for every function I have declared in my main header, sms.h.  I then
>>>>>> have the following sms.i file that is used to create my wrapper c
>>>>>> file:
>>>>>>
>>>>>> %module sms
>>>>>> %{
>>>>>> #define SWIG_FILE_WITH_INIT
>>>>>> #include "../src/sms.h"
>>>>>> %}
>>>>>>
>>>>>> %include "../src/sms.h"
>>>>>> %include "../doc/xml/sms_doxy.i"
>>>>>>
>>>>>> It all compiles, I import the library into ipython, but there are
>>>>>> still no docstrings.. anyone know why?
>>>>>>
>>>>>> regards,
>>>>>> Rich
>>>>>>
>>>>>>
>>>>>> On Tue, Aug 12, 2008 at 7:52 PM, Philipp Kraft <oe...@gm...>
wrote:
>>>>>>> Hi Jack,
>>>>>>>
>>>>>>> generally it ist he %feature("docstring") and %feauter("autodoc")
line you
>>>>>>> can use. It is documented in Section 30.10 in the SWIG 1.3 doc. But
if you
>>>>>>> are using doxygen for API doc generation there is a python script by
Prabhu
>>>>>>> Ramachandran (thanks for that), that is generating docstrings from
>>>>>>> doxygen-XML output. You will find it here:
>>>>>>>
http://trac.tuebingen.mpg.de/shogun/browser/branches/structure/src/.doxy2swi
>>>>>>> g.py?rev=3227
>>>>>>>
>>>>>>> Philipp
>>>>>>>
>>>>>>>> Hello,
>>>>>>>>
>>>>>>>> Is there a flag to make swig generate __doc__ strings in python?
>>>>>>>>
>>>>>>>> If not, it seems like it would be easy to add (maybe when swig is
>>>>>>> generating
>>>>>>>> the python wrapper, grab the documentation system string and stick
it in
>>>>>>>> between the triple quotes at the beginning of the function
declaration).
>>>>>>>>
>>>>>>>> Also, sorry if this has been asked already. Google wasn't helping
and
>>>>>>>> sourceforge search is down for some reason. I know one guy posted
this
>>>>>>>> question in 2001.
>>>>>>>>
>>>>>>>> Thanks!
>>>>>>>> Jack
>>>>>>>
>>>>>>>
-------------------------------------------------------------------------
>>>>>>> This SF.Net email is sponsored by the Moblin Your Move Developer's
challenge
>>>>>>> Build the coolest Linux based applications with Moblin SDK & win
great prizes
>>>>>>> Grand prize is a trip for two to an Open Source event anywhere in
the world
>>>>>>> http://moblin-contest.org/redirect.php?banner_id=100&url=/
>>>>>>> _______________________________________________
>>>>>>> Swig-user mailing list
>>>>>>> Swi...@li...
>>>>>>> https://lists.sourceforge.net/lists/listinfo/swig-user
>>>>>>>
>>>>>>
>>>>>>
-------------------------------------------------------------------------
>>>>>> This SF.Net email is sponsored by the Moblin Your Move Developer's
challenge
>>>>>> Build the coolest Linux based applications with Moblin SDK & win
great prizes
>>>>>> Grand prize is a trip for two to an Open Source event anywhere in the
world
>>>>>> http://moblin-contest.org/redirect.php?banner_id=100&url=/
>>>>>> _______________________________________________
>>>>>> Swig-user mailing list
>>>>>> Swi...@li...
>>>>>> https://lists.sourceforge.net/lists/listinfo/swig-user
>>>>>>
>>>>>
>>>>>
>>>>>
----------------------------------------------------------------------------
--
>>>>> SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas,
Nevada.
>>>>> The future of the web can't happen without you.  Join us at MIX09 to
help
>>>>> pave the way to the Next Web now. Learn more and register at
>>>>>
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
>>>>> _______________________________________________
>>>>> Swig-user mailing list
>>>>> Swi...@li...
>>>>> https://lists.sourceforge.net/lists/listinfo/swig-user
>>>>>
>>>>
>>>>
>>>>
>>>> --
>>>> Mathieu
>>>>
>>>
>>
>>
>>
>> --
>> Mathieu
>>
>>