README.doxyxml
1The process of updating and exporting the Doxygen document strings
2into Python consists of a few steps.
3
41. Make sure the 'docs' component will be built, which requires
5Doxygen.
6
72. Build the project like normal, which will run Doxygen and store the
8 XML files into $(top_builddir).
9
103. In $(top_srcdir)/docs/doxygen, run the command:
11
12 $ python swig_doc.py \
13 $(top_builddir)/docstrings/docs/doxygen/xml \
14 $(top_srcdir)/gnuradio-runtime/swig/swig_doc.i
15
16 This uses the XML output of Doxygen to to rebuild a SWIG file that
17 contains all of the current Doxygen markups.
18
194. Rebuild the GNU Radio libraries. Since gnuradio.i is included in
20 all of the GNU Radio components, and gnuradio.i includes
21 swig_doc.i, when the libraries are rebuilt, they will now include
22 the documentation strings in Python.
23
245. Install GNU Radio. Now, when you run help() in Python on a GNU
25 Radio block, you will get the full documentation.
26
27