Documentation for out-of-tree module

Hi all,

I’m working on an out-of-tree module and I want to make the
documentations
which can be shown in the windows when people double click the blocks.

I guess the documentations are written in the header files in
/gr-xx/include/xx. So I tried to modify the header files of blocks which
already exist in gnuradio, for example, the channel_model block in
gr-channel. The documentation was updated after reinstallation. It
confirms
my guess. But when I modify the header file of my own block in
/gr-xx/include/xx, the documentation wasn’t updated after
reinstallation.
The documentations are still something like:

make(xx, xx) -> sptr
Return a shared_ptr to a new instance of xx::xx.
To avoid accidental use of raw pointers, xx::xx constructor is in a
private
implementation class. xx::xx::make is the public interface for creating
new
instances.
Params: (xx, xx)

I searched some previous questions related to documentation on
discussion-gnuradio, someone said documentations should be done by
doxygen
for C++ blocks and by sphinx for python blocks. But I found these are
more
related to these html documentations(maybe I’m wrong).

Did I miss something or do something wrong? Could anyone give me any
suggestions to solve this problem?

Thanks a lot!
Best,
Zhe


View this message in context:
http://gnuradio.4.n7.nabble.com/Documentation-for-out-of-tree-module-tp46127.html
Sent from the GnuRadio mailing list archive at Nabble.com.

I think “that” documentation is written in your xml file from grc
folder.

Hi Nemanja,

I checked the xml files and I didn’t find the “documentations”. By the
way,
I don’t see a tag in xml file.

Did I miss anything?

Thanks!
Zhe


View this message in context:
http://gnuradio.4.n7.nabble.com/Documentation-for-out-of-tree-module-tp46127p46130.html
Sent from the GnuRadio mailing list archive at Nabble.com.

If i understood you well, you wanna see the description of ur block in
GRC.
In version 3.6.5.1 and previous ones I did that by writting block
description under tag in xml GRC file of ur block. For example:

Doceder consists of two sub blocks: blah blah

as for the missing tag , just add it.

best,
Nemanja

Hi Nemanja,

Yes, that’s what I want to do.

I’m using the latest version 3.7.2. When I add the tag in the xml
of a
block, I found the block disappeared after reinstallation. Is it
because of
different version?

Thanks!
Zhe


View this message in context:
http://gnuradio.4.n7.nabble.com/Documentation-for-out-of-tree-module-tp46127p46132.html
Sent from the GnuRadio mailing list archive at Nabble.com.

well, maybe, i don’t know. Still haven’t used 3.7.
But I remember when I wanted to do the same I looked for the
documentation
of standard gnuradio blocks and just copied that.

Best,
Nemanja

Hi Nemanja,

You are right! I didn’t do the in a correct way, so it
didn’t
work for me. With the help of Prof. Anastasopoulos, it works for me now.

Thanks for your suggestion! Really helpful!

Best,
Zhe


View this message in context:
http://gnuradio.4.n7.nabble.com/Documentation-for-out-of-tree-module-tp46127p46136.html
Sent from the GnuRadio mailing list archive at Nabble.com.

Hi Nemanja,

I just went back to version 3.6.5 and had some findings.

  1. block in out-of-tree module don’t have any default
    documentations(description) in it. In version 3.7, it has some default
    descriptions like:

make(xx, xx) -> sptr
Return a shared_ptr to a new instance of xx::xx.
To avoid accidental use of raw pointers, xx::xx constructor is in a
private
implementation class. xx::xx::make is the public interface for creating
new
instances.
Params: (xx, xx)

  1. I’ve tried to add the tag in the xml file again, the same thing
    happened: the block disappeared after reinstallation. I just added the

    description inside … .

Is this how you always do?

Thanks!
Best,
Zhe


View this message in context:
http://gnuradio.4.n7.nabble.com/Documentation-for-out-of-tree-module-tp46127p46134.html
Sent from the GnuRadio mailing list archive at Nabble.com.

On Tue, Feb 4, 2014 at 6:26 PM, Zhe F. [email protected] wrote:

Hi Nemanja,

Yes, that’s what I want to do.

I’m using the latest version 3.7.2. When I add the tag in the xml of a
block, I found the block disappeared after reinstallation. Is it because of
different version?

Thanks!
Zhe

If the block disappears, it’s usually due to a malformed line of XML.
Make sure you have closed all tags properly ().

We have to work on the scrapping of doc information from the public
header file for out-of-tree projects. In the meantime, the tag
should work for you.

Tom

Hell yeah, my first corect answer!

Cheers

Hi Tom,

I found my mistake.
OK, maybe I don’t have to worry about the public header file now.

Thanks!
Best,
Zhe

On Tue, Feb 4, 2014 at 2:06 PM, Tom R. [email protected] wrote:

Tom


Discuss-gnuradio mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/discuss-gnuradio


Zhe F.

Electrical Engineering: System

University of Michigan Ann Arbor

Tel: 734-834-3188

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs