[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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

From: Richard Bell
Subject: Re: [Discuss-gnuradio] Compiling Documentation with an OOT
Date: Wed, 30 Mar 2016 13:54:55 -0700

I've asked this question a few times now on the mailing list, and each time I hope a different answer comes through. Each time though it's the answer Ron gave, which never works for me. I can't figure it out. So I've always resorted to the xml tags to get documentation into GRC, but for the reasons Tom just mentioned, would rather not do that. Hoping someday I figure this out.


On Wed, Mar 30, 2016 at 7:50 AM, Tom Rondeau <address@hidden> wrote:

On Mon, Mar 28, 2016 at 9:25 PM, Tom McDermott <address@hidden> wrote:
Hi Richard -

When you say 'propagate through to GRC'  do you mean 'How to display on the GRC documentation tab in the open block properties window'? (select block,  double-click, or rt-click-properties).

I do that by putting text between:
in the module's XML file (manually pasted text, with some characters not allowed...).

-- Tom, N5EG

I would recommend against using the <doc> tags in the GRC XML files. You're just duplicating text, so if anything is ever updated, you now need to remember to update it in two places.

As Ron Economos showed in his response, exporting from his public .h files works fine.

This might be a question for Sebastian, who I think has gone through a couple of iterations of grabbing those docs strings into GRC.


On Mon, Mar 28, 2016 at 5:30 PM, Richard Bell <address@hidden> 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?


Discuss-gnuradio mailing list

reply via email to

[Prev in Thread] Current Thread [Next in Thread]