Re: [Discuss-gnuradio] documentation of the gnuradio python modules

[Martin Braun]

On Mon, Mar 23, 2009 at 12:42:04PM +0000, feldmaus wrote:
> Hi All,
> 
> i only want to say,it would be nice to have a clearer and
> more comprehensive gnuradio python modules documentation with
> examples.
> 
> This would solve many basic problems !
> 

Hi Markus,

as explained in
http://gnuradio.org/trac/wiki/Tutorials/WritePythonApplications, the
Doxygen generated docs are also very useful for Python development,
since the functions which export the blocks to the Python domain are
always mapped in the same way (e.g. gr_make_sig_source_f becomes
gr.sig_source_f etc.). I always have a browser window open with my local
copy of the Doxygen files when developing GR and I find it very easy to
jump straight to the correct block documentation thanks to the
categories of signal processing blocks.
The only disadvantage I see is that default arguments don't show up in
the doxy-docs - but as the source code is always linked into the
documentation, this is very easy to find if necessary.

I admit this might be a bit cumbersome for people who don't want to
touch the C++ domain at all, but for someone who at least knows how to
read the code it doesn't take much getting used to.

As for examples, between the unit tests and the files in
gnuradio-examples and gr-utils, there really is loads of stuff to choose
from regarding examples. grep and find are your friends.

I'm sorry that this answer doesn't exactly give you what you asked for -
but even though I agree that documentation is not GNU Radio's strongest
point, I must say the way the code is organised makes it extremely easy
to find oneself's way around without too much of a hassle. Just give it
a try, I doubt you'll find it that hard yourself.

Cheers
MB

-- 
Dipl.-Ing. Martin Braun           Phone: +49-(0)721-608 3790
Institut fuer Nachrichtentechnik  Fax:   +49-(0)721-608 6071
Universitaet Karlsruhe (TH)       http://www.int.uni-karlsruhe.de/

pgpYcQlCZp4JF.pgp
Description: PGP signature