[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Patch-gnuradio] docstring generation
From: |
Ben Reynwar |
Subject: |
[Patch-gnuradio] docstring generation |
Date: |
Mon, 13 Sep 2010 15:11:59 -0700 |
Hi all,
I have a patch to generate docstrings from the doxygen-generated xml files.
It follows the suggestions in gnuradio/docs/doxygen/xml-swig/README.
swig.xsl is based on gnuradio/docs/doxygen/xml-swig/swig.xsl
The funkiness that is gr_swig_block_magic.i meant that I had to modify
the method a little but it's basically the same.
I haven't attempted to incorporate the docstring generation into a
make file, because it wasn't obvious to me how to do so, and I thought
someone who's already played around with those would be able to do it
with much less chance of messing everything up. Anytime a header file
is modified it would require regeneration of the doxygen documentation
and the swig_doc.i file before SWIG is run again.
It currently only works for blocks beginning with "gr_", although not
for any particularly good reason. I've only tested in on docstring
generation for blocks and their methods so it almost certainly won't
generate all the docstrings one would like.
I plan to continue working on this but thought I would submit this
patch, since it does add most docstrings and doesn't appear to break
anything.
Cheers,
Ben
docstrings.patch
Description: Text Data
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Patch-gnuradio] docstring generation,
Ben Reynwar <=