Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.16 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.16 KB

YAML common

build status

A ROS package with helper functions to parse and manipulate YAML data

Dependencies

To build without geometry_common, execute

catkin build yaml_common -DBUILD_WITH_GEOMETRY_COMMON=OFF

Documentation

We use Doxygen for code documentation.

Note: Building the documentation is disabled by default.

  • To build the code documentation, Doxygen needs to be installed. On debian based systems, this can be achieved with

    sudo apt install doxygen
  • Documentation can be built using the flag -DBUILD_DOC=ON

    catkin build yaml_common -DBUILD_DOC=ON
  • The documentation will be generated at <YOUR_CATKIN_WS>/build/yaml_common/docs/html/index.html

Test

Run unit tests with

catkin test --this

Note: Requires GTest package (sudo apt install libgtest-dev)