search

IFL-CAMP / simple

S.I.M.P.L.E. - Smart Intuitive Messaging Platform with Less Effort. A Cross-Platform C++ Library to Exchange Data Across Network.
Mozilla Public License 2.0
22 stars 5 forks source link

Doxygen documentation #34

Closed SalvoVirga closed 6 years ago

SalvoVirga commented 6 years ago

This PR adds Doxygen style documentation to the library and provides its automatic generation via CMake (setting SIMPLE_BUILD_DOC to ON/TRUE).

Fixes #19 and #20

codecov-io commented 6 years ago

Codecov Report

Merging #34 into master will increase coverage by 0.07%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #34      +/-   ##
==========================================
+ Coverage   99.71%   99.79%   +0.07%     
==========================================
  Files          57       57              
  Lines        3891     3888       -3     
==========================================
  Hits         3880     3880              
+ Misses         11        8       -3
Impacted Files Coverage Δ
msgs/include/simple_msgs/rotation_matrix_stamped.h 100% <ø> (ø) :arrow_up:
msgs/src/pose.cpp 100% <ø> (ø) :arrow_up:
include/simple/context_manager.hpp 100% <ø> (ø) :arrow_up:
msgs/include/simple_msgs/point.h 100% <ø> (ø) :arrow_up:
include/simple/client.hpp 100% <ø> (ø) :arrow_up:
msgs/include/simple_msgs/rotation_matrix.h 100% <ø> (ø) :arrow_up:
msgs/src/string.cpp 97.43% <ø> (ø) :arrow_up:
msgs/include/simple_msgs/double.hpp 100% <ø> (ø) :arrow_up:
msgs/include/simple_msgs/quaternion_stamped.h 100% <ø> (ø) :arrow_up:
msgs/src/quaternion_stamped.cpp 100% <ø> (ø) :arrow_up:
... and 29 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 41cc251...6280429. Read the comment docs.