How to find functions in Doxygen file? (or some where else?)

Hi,

usually I want to find how to use a function or which functions do we
have. So I read the file here:
http://www.ece.jhu.edu/~cooper/SWRadio/Simple-Gnuradio-User-Manual-v1.0.pdf
or look at this website:
http://gnuradio.org/doc/doxygen/hierarchy.html

But in the first one, the description is not so detailed and in the
second, sometimes I can’t find some functions. For Example: dqpsk_mod()
in blks2 sub pakage.

Could anyone please tell me how to use these websites better or
there is some better guiding source?

Thanks in advance for any help.

Van.

Hi,

The official GnuRadio documentation at [
http://gnuradio.org/doc/doxygen/hierarchy.html ] is old and not updated
from
a very long time.

Also the un-official GnuRadio documentation at
[http://www.ece.jhu.edu/~cooper/SWRadio/Simple-Gnuradio-User-Manual-v1.0.pdf]
is old too and not updated from a long time.

To generate up-to-date documentation that includes both C++ and python
function do:

  1. Install Doxygen in your machine.

  2. Download latest Gnuradio revision from the trunk to a temporary
    folder
    (ex: doc-gnuradio)
    svn co http://gnuradio.org/svn/gnuradio/trunk doc-gnuradio

  3. cd to doc-gnuradio

  4. ./bootstrap

  5. ./configure --enable-doxygen

  6. cd gnuradio-core/doc

  7. make doc

An html folder will be created in this folder. In this html folder look
for
index.html open and bookmark it in your browser.

To generate USRP documentation too:

  1. cd to usrp/doc

  2. make

in usrp/doc/html folder, look for index.html open and bookmark it in
your
browser.

To save space, optionally you can delete all doc-gnuradio folders
except
gnuradio-core/doc and usrp/doc folders

Regards,

Firas


View this message in context:
http://www.nabble.com/How-to-find-functions-in-Doxygen-file--(or-some-where-else-)-tp18201004p18209453.html
Sent from the GnuRadio mailing list archive at Nabble.com.

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