search

ros2 / rosidl_typesupport

Packages which provide the typesupport for ROS messages and services
Apache License 2.0
13 stars 34 forks source link

API documentation for public functions #64

Closed brawner closed 4 years ago

brawner commented 4 years ago

As part of the effort to increase these packages to QL 1, this PR adds API documentation to the public functions and types.

brawner commented 4 years ago

Ready for review

brawner commented 4 years ago

I knew I was forgetting something! I added Doxyfiles and a couple of small READMEs to serve as landing pages.

brawner commented 4 years ago

we don't use them anywhere

Doxygen files are currently included in each package for which we are generating api docs on docs.ros2.org. It's all part of a large batch job for each release, and they are required by the Makefile below.

Packages that currently have api docs can be seen here: https://github.com/ros2/docs.ros2.org/blob/doc_gen/Makefile#L5-L14

brawner commented 4 years ago

@dirk-thomas Ready for review

brawner commented 4 years ago

Ok, comment is fixed. Running CI for linters.

ahcorde commented 4 years ago

Rebuiling in MACOS, OpenSSL issue

brawner commented 4 years ago

@dirk-thomas Ready for review again.