On Mon, Mar 28, 2016 at 9:25 PM, Tom McDermott <[email protected]> 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:
> <doc>
> </doc>
> 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.

Tom




> On Mon, Mar 28, 2016 at 5:30 PM, Richard Bell <[email protected]>
> 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
[email protected]
https://lists.gnu.org/mailman/listinfo/discuss-gnuradio

Reply via email to