How to properly generate documentation, and find the files behind the code?

Howdy,

I want to better understand certain blocks… such as what the
parameters of
optfir.low_pass actually specify, how it’s implemented, that sort of
thing.
But the gnuradio filetree is next to impossible to traverse.

I have been pointed here
/usr/local/share/doc/gnuradio-3.3svn/html/index.html

which is definitely useful, but seems to be generated automatically off
of
header files, and doesn’t link you to the actual source code, which I
cannot
find.

I’m sure this exists, just not sure how to grab it. Thoughts?

Thanks
-Jonathan

On Mon, Aug 10, 2009 at 05:29:27PM -0400, Jonathan C. wrote:

header files, and doesn’t link you to the actual source code, which I cannot
find.

I’m sure this exists, just not sure how to grab it. Thoughts?

Thanks
-Jonathan

If you haven’t downloaded the source code, please do.

http://gnuradio.org/trac/wiki/Download

There are many tools available for browsing source code.
Try grep or etags to start.

Eric

Jonathan C.-2 wrote:

/usr/local/share/doc/gnuradio-3.3svn/html/index.html

which is definitely useful, but seems to be generated automatically off of
header files, and doesn’t link you to the actual source code, which I
cannot
find.

I’m sure this exists, just not sure how to grab it. Thoughts?

the actual C++ code is in the file that you download… good luck.


View this message in context:
http://www.nabble.com/How-to-properly-generate-documentation%2C-and-find-the-files-behind-the-code--tp24907940p24943852.html
Sent from the GnuRadio mailing list archive at Nabble.com.

Hello Jonathan,

I played a little around with find and grep and did this:

q6fd0:~/gnuradio josefvukovic$ find . -name “optfir.*”
./gnuradio-core/src/python/gnuradio/.svn/prop-base/optfir.py.svn-base
./gnuradio-core/src/python/gnuradio/.svn/text-base/optfir.py.svn-base
./gnuradio-core/src/python/gnuradio/optfir.py

So find found optfir.py then I used grep and did:

6fd0:~/gnuradio josefvukovic$ grep ‘low_pass’
./gnuradio-core/src/python/gnuradio/optfir.py
def low_pass (gain, Fs, freq1, freq2, passband_ripple_db,
stopband_atten_db,

and grep found the code of the method optfir.low_pass, so I was able to
view
the entire code with vi.

This is probably not the best way to search for things but it is an
approach.
hope this helps.

cu
Josef V.

2009/8/10 Jonathan C. [email protected]

That’s perfect. I am a recent mac convert and am not as familiar with
the
unix as I should be. Thanks for playing around with that for me!

2009/8/13 Josef V. [email protected]

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs