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