[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Discuss-gnuradio] Documentation for 3.0 GNURadio.
From: |
Eric Blossom |
Subject: |
Re: [Discuss-gnuradio] Documentation for 3.0 GNURadio. |
Date: |
Wed, 31 Jan 2007 18:18:08 -0800 |
User-agent: |
Mutt/1.5.9i |
On Wed, Jan 31, 2007 at 02:41:02PM -0800, John Clark 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.
>
> 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 Clark.
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 <your gnuradio tree>
$ 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