Package grc_gnuradio.utils.extract_docs

Functions
def	extract_txt
def	is_match
def	extract
Variables
string	DOCS_DIR = '/usr/local/share/doc/grc_gnuradio_docs/'
string	DOXYGEN_NAME_XPATH = '/doxygen/compounddef/compoundname'
string	DOXYGEN_BRIEFDESC_GR_XPATH = '/doxygen/compounddef/briefdescription'
string	DOXYGEN_DETAILDESC_GR_XPATH = '/doxygen/compounddef/detaileddescription'
string	DOXYGEN_BRIEFDESC_BLKS2_XPATH = '/doxygen/compounddef/sectiondef[@kind="public-func"]/memberdef/briefdescription'
string	DOXYGEN_DETAILDESC_BLKS2_XPATH = '/doxygen/compounddef/sectiondef[@kind="public-func"]/memberdef/detaileddescription'

---

Detailed Description

Extract documentation from the gnuradio doxygen files.

Author:

Josh Blum

---

Function Documentation

def grc_gnuradio.utils.extract_docs.extract

(

key

)

Extract the documentation from the doxygen generated xml files. If multiple files match, combine the docs.

Parameters:

key

the block key

Returns:

a string with documentation

Definition at line 65 of file extract_docs.py.

def grc_gnuradio.utils.extract_docs.extract_txt

(

xml

)

Recursivly pull the text out of an xml tree.

Parameters:

xml

the xml tree

Returns:

a string

Definition at line 33 of file extract_docs.py.

def grc_gnuradio.utils.extract_docs.is_match	(		key,
			file
	)

Is the block key a match for the given file name?

Parameters:

	key	block key
	file	the xml file name

Returns:

true if matches

Definition at line 43 of file extract_docs.py.

---

Variable Documentation

string grc_gnuradio::utils::extract_docs.DOCS_DIR = '/usr/local/share/doc/grc_gnuradio_docs/' [static]

Definition at line 26 of file extract_docs.py.

string grc_gnuradio::utils::extract_docs.DOXYGEN_BRIEFDESC_BLKS2_XPATH = '/doxygen/compounddef/sectiondef[@kind="public-func"]/memberdef/briefdescription' [static]

Definition at line 30 of file extract_docs.py.

string grc_gnuradio::utils::extract_docs.DOXYGEN_BRIEFDESC_GR_XPATH = '/doxygen/compounddef/briefdescription' [static]

Definition at line 28 of file extract_docs.py.

string grc_gnuradio::utils::extract_docs.DOXYGEN_DETAILDESC_BLKS2_XPATH = '/doxygen/compounddef/sectiondef[@kind="public-func"]/memberdef/detaileddescription' [static]

Definition at line 31 of file extract_docs.py.

string grc_gnuradio::utils::extract_docs.DOXYGEN_DETAILDESC_GR_XPATH = '/doxygen/compounddef/detaileddescription' [static]

Definition at line 29 of file extract_docs.py.

string grc_gnuradio::utils::extract_docs.DOXYGEN_NAME_XPATH = '/doxygen/compounddef/compoundname' [static]

Definition at line 27 of file extract_docs.py.

---