Re: [Discuss-gnuradio] Fwd: Documentation for out-of-tree module

On Thu, Feb 6, 2014 at 10:31 AM, Martin Braun <martin.braun@ettus.com> wrote:

On 06.02.2014 03:04, Tom Rondeau wrote:

Just want to confirm that in the current way gr_modtool generates a new OOT
module,
no matter what content we put on the "docs" directory, this will not result
in an invocation of doxygen, and thus it will not generate ANY kind of
manual
(not necessarily from header files, but even , say, a intro page for the
module).

Can you confirm that.

thanks again
Achilleas

Achilleas,

Correct. There is no doxygen build support in OOT modules built from
gr_modtool. We plan to fix this, though.

See  http://gnuradio.org/redmine/issues/646.

MB

I believe that particular issue is due to the CMakeLists.txt essentially being lifted from the main GNURadio docs CMakeLists.txt (minus the Sphinx-related bits), and toplevel GNURadio allows ENABLE_DOXYGEN to be set, and OOT modules do not. So there is a conditional check on ENABLE_DOXYGEN that will never be true, and so the <gr-oot>/docs/doxygen directory never gets included in the build. I've attached a patch to issue 646 that just disables this check, but I don't know what the effect will be on systems that don't actually have doxygen installed: i.e. if the find_packages(doxygen) in docs/CMakeLists.txt fails.

 Doug

--
Doug Geiger
doug.geiger@bioradiation.net