Documentation for 3.0 GNURadio

I’ve been trying to analyze what someone else has done, as well as look
at some better examples
of what I need done…

However, it does not seem that there is a version of documentation for
the 3.0 version of GNURadio
functions online (the wiki seems to be 2.0 or so…) nor did anything
that looks like documentation get
built when I recently made every thing from a recent svn checkout.

Is there some package that needs to be there, and isn’t on my machine,
such that documentation
would be automagically build when I build the main code set?

Thanks,
John C…

On Wed, Jan 31, 2007 at 02:41:02PM -0800, John C. wrote:

I’ve been trying to analyze what someone else has done, as well as look
at some better examples
of what I need done…

However, it does not seem that there is a version of documentation for
the 3.0 version of GNURadio
functions online (the wiki seems to be 2.0 or so…) nor did anything
that looks like documentation get
built when I recently made every thing from a recent svn checkout.

The documentation isn’t built by default.

Use the --enable-doxygen option to configure. Right now it just
builds docs from gnuradio-core. Whenever somebody gets around to
fixing ticket:4, it’ll extract docs from all the code.

This requires that you have doxygen installed. graphvis (dot) is also
nice to have.

Eric

On Wed, Jan 31, 2007 at 02:41:02PM -0800, John C. wrote:

Is there some package that needs to be there, and isn’t on my machine,
such that documentation
would be automagically build when I build the main code set?

Thanks,
John C…

Hi John,

I just checked in some changes (r4351) to the Doxygen configuration
that now have it generate docs for all components, not just the ones
in gnuradio-core. It also reports the correct version in its output.

To generate the New! Improved! docs:

$ cd
$ svn up
$ ./bootstrap
$ ./configure --enable-doxygen
$ (cd gnuradio-core/doc; make clean)
$ make

The top of the documentation tree ends up in

gnuradio-core/doc/html/index.html

The class hierarchy is a good place to start.

Eric

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