Re: [Discuss-gnuradio] Compiling Documentation with an OOT

[Ron Economos]

No compiler switch required. On my system, even an unmodified .h file shows up in the documentation tab.



Ron

On 03/28/2016 06:02 PM, Richard Bell wrote:

Hey Ron,

That's where I added my documentation, just like you have it there, but I can't get it to propagate through. Do I need to compile it differently for that to happen? Is there a gnuradio setting that needs to be set for documentation to make its way through?

Rich

On Mon, Mar 28, 2016 at 5:52 PM, Ron Economos <address@hidden> wrote:

You put the documentation into the .h file(s) in the gr-<name>/include/<name> directory. Here's an example.

https://github.com/gnuradio/gnuradio/blob/master/gr-dtv/include/gnuradio/dtv/dvbt2_framemapper_cc.h

Ron

On 03/28/2016 05:30 PM, Richard Bell wrote:

Hi all,

I would like to know how I get the comments I add to my public header function to propagate through to the GRC Block documentation tab. Is there a flag I have to add when I compile the OOT?

Thanks,
Rich

_______________________________________________
Discuss-gnuradio mailing list
address@hidden
https://lists.gnu.org/mailman/listinfo/discuss-gnuradio