Functions | |
| def | _msg_srv_tmpl |
| def | _write_to_file |
| utility to write string data to files and handle unicode | |
| def | create_package_template |
| def | generate_doxygen |
| Main entrypoint into creating doxygen files. | |
| def | generate_msg_srv_includes |
| create include files for messages and services | |
| def | get_doxygen_version |
| def | header_template_name |
| def | load_manifest_vars |
| Processes manifest for package and then generates templates for header, footer, and manifest include file. | |
| def | run_doxygen |
| def | run_rxdeps |
Variables | |
| tuple | doxy_template = load_tmpl('doxy.template') |
| tuple | external_template = load_tmpl('external.html') |
| tuple | footer_template = load_tmpl('footer.html') |
| tuple | header_template = load_tmpl(header_template_name()) |
| tuple | manifest_template = load_tmpl('manifest.html') |
| def rosdoc::doxygenator::_msg_srv_tmpl | ( | ext, | ||
| type, | ||||
| text | ||||
| ) | [private] |
| ext | str: extension (msg or srv) | |
| type | str: type name | |
| text | str: full text definition of type |
Definition at line 50 of file doxygenator.py.
| def rosdoc::doxygenator::_write_to_file | ( | f, | ||
| tmpl | ||||
| ) | [private] |
utility to write string data to files and handle unicode
Definition at line 187 of file doxygenator.py.
| def rosdoc::doxygenator::create_package_template | ( | package, | ||
| rd_config, | ||||
| m, | ||||
| path, | ||||
| html_dir, | ||||
| header_filename, | ||||
| footer_filename, | ||||
| example_path | ||||
| ) |
| package | str: package name | |
| rd_config | dict: rosdoc configuration parameters for this doxygen build | |
| m | Manifest : package manifest | |
| html_dir | str: directory to store doxygen files |
Definition at line 75 of file doxygenator.py.
| def rosdoc::doxygenator::generate_doxygen | ( | ctx, | ||
disable_rxdeps = False | ||||
| ) |
Main entrypoint into creating doxygen files.
| disable_rxdeps,: | if True, don't generate rxdeps documenation (note: this parameter is volatile as rxdeps generation will be moved outside of doxygenator) disable_rxdeps: bool |
Definition at line 256 of file doxygenator.py.
| def rosdoc::doxygenator::generate_msg_srv_includes | ( | package, | ||
| tmp, | ||||
| to_delete | ||||
| ) |
create include files for messages and services
Definition at line 61 of file doxygenator.py.
| def rosdoc::doxygenator::get_doxygen_version | ( | ) |
Definition at line 198 of file doxygenator.py.
| def rosdoc::doxygenator::header_template_name | ( | ) |
Definition at line 209 of file doxygenator.py.
| def rosdoc::doxygenator::load_manifest_vars | ( | ctx, | ||
| rd_config, | ||||
| package, | ||||
| path, | ||||
| docdir, | ||||
| package_htmldir, | ||||
| m | ||||
| ) |
Processes manifest for package and then generates templates for header, footer, and manifest include file.
| package,: | package to create templates for package: str | |
| rd_config,: | rosdoc configuration dictionary rd_config: dict | |
| path,: | file path to package path: str | |
| m,: | package manifest or None m: manifest.Manifest |
Definition at line 132 of file doxygenator.py.
| def rosdoc::doxygenator::run_doxygen | ( | package, | ||
| doxygen_file, | ||||
quiet = False | ||||
| ) |
Definition at line 222 of file doxygenator.py.
| def rosdoc::doxygenator::run_rxdeps | ( | package, | ||
| pkg_doc_dir | ||||
| ) |
Definition at line 240 of file doxygenator.py.
| tuple rosdoc::doxygenator::doxy_template = load_tmpl('doxy.template') |
Definition at line 394 of file doxygenator.py.
| tuple rosdoc::doxygenator::external_template = load_tmpl('external.html') |
Definition at line 395 of file doxygenator.py.
| tuple rosdoc::doxygenator::footer_template = load_tmpl('footer.html') |
Definition at line 398 of file doxygenator.py.
| tuple rosdoc::doxygenator::header_template = load_tmpl(header_template_name()) |
Definition at line 397 of file doxygenator.py.
| tuple rosdoc::doxygenator::manifest_template = load_tmpl('manifest.html') |
Definition at line 399 of file doxygenator.py.
