mirror of
https://github.com/introlab/rtabmap_ros.git
synced 2026-10-04 16:57:46 +08:00
matlabbe
5207dab7c2
* rtabmap_slam tests and doc * another round of review of the doc * Disable by default use_intra_process_comms on latched/transient publishers * Added test to catch not unlocked mutex from early error exit * updated coverage settings * Using UScopeMutex on all tryLock()
36 lines
1.2 KiB
YAML
36 lines
1.2 KiB
YAML
## Configuration for rosdoc2, the documentation generator used by docs.ros.org.
|
|
## Regenerate the annotated default with:
|
|
## rosdoc2 default_config --package-path rtabmap_slam
|
|
## Build the docs locally with:
|
|
## rosdoc2 build --package-path rtabmap_slam --output-directory doc_output
|
|
|
|
## This 'attic section' self-documents this file's type and version.
|
|
type: 'rosdoc2 config'
|
|
version: 1
|
|
|
|
---
|
|
|
|
settings:
|
|
## Generate the standard index page from package.xml (description, maintainer,
|
|
## license, links) and a table of contents for the builders below.
|
|
generate_package_index: true
|
|
|
|
## This is an ament_cmake package, so doxygen runs on the public headers by
|
|
## default and there are no Python modules to document.
|
|
always_run_doxygen: false
|
|
always_run_sphinx_apidoc: false
|
|
|
|
builders:
|
|
## Doxygen parses the public C++ API out of include/.
|
|
- doxygen: {
|
|
name: 'rtabmap_slam Public C/C++ API',
|
|
output_dir: 'generated/doxygen'
|
|
}
|
|
## Sphinx renders the landing page and pulls the Doxygen XML in through
|
|
## breathe/exhale so the API is browsable alongside the narrative docs.
|
|
- sphinx: {
|
|
name: 'rtabmap_slam',
|
|
doxygen_xml_directory: 'generated/doxygen/xml',
|
|
output_dir: ''
|
|
}
|