Re: how to use the autodoc feature of new swig-1.3.22?

On Tue, 7 Sep 2004, Bo Peng wrote:

> I can not agree more with the doxygen idea. I am using doxygen for
> documentation and I have been trying to put doxygen output to the python
> interface. Automatic generation of %feature("docstring") lines from
> doxygen output is the closest solution I can think of but the workload
> is still pretty big. How I wish this feature can be implemented in the
> near future.

You might be interested in something I do in my interface.  I arrange to
have SWIG give all of the proxy classes an extra class method, called
Doxy(), that pops up a web browser window with the doxygen documentation
for the class.  There's also a global function by that name that takes a
string.  So, given a class named CFoo, and

>>> import example
>>> foo = example.CFoo()

each of the following brings up the doxygen documentation for CFoo:

>>> example.CFoo.Doxy()
>>> foo.Doxy()
>>> example.Doxy('CFoo')

I find it quite nice to see this in a graphical web browser, but if you
really want text you could either arrange to use a textual browser such as
lynx, or make the function just dump some text to the screen (e.g., from
file somepath/CFoo.txt) rather than bringing up a url.  It's trivial to
make your own help function that does something like this; I can send the
details of how I attach the function to all the classes and launch a web
browser if you're interested.

Josh

--
Joshua L. Cherry, Ph.D.
NCBI/NLM/NIH (Contractor)
jcherry@xxxxxxxxxxxxxxxx
_______________________________________________
Swig maillist  -  Swig@xxxxxxxxxxxxxxx
http://mailman.cs.uchicago.edu/mailman/listinfo/swig