I think "that" documentation is written in your xml file from grc folder.
On Tue, Feb 4, 2014 at 6:37 PM, Zhe Feng <[email protected]> wrote: > 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. > > _______________________________________________ > Discuss-gnuradio mailing list > [email protected] > https://lists.gnu.org/mailman/listinfo/discuss-gnuradio > -- Nemanja Savić
_______________________________________________ Discuss-gnuradio mailing list [email protected] https://lists.gnu.org/mailman/listinfo/discuss-gnuradio
