From 9bde6059130bde218bb83d79521566aca4890d83 Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Sat, 16 May 2020 19:36:50 -0400 Subject: [PATCH] Update README and tracetools' QD Signed-off-by: Christophe Bedard --- README.md | 2 ++ tracetools/QUALITY_DECLARATION.md | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 91fd86f..73cdc89 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,8 @@ Library to support instrumenting ROS packages, including core packages. This package claims to be in the **Quality Level 3** category, see the [Quality Declaration](./tracetools/QUALITY_DECLARATION.md) for more details. +See the [API documentation](https://micro-ros.gitlab.io/ros_tracing/ros2_tracing-api/). + ### tracetools_launch Package containing tools to enable tracing through launch files. diff --git a/tracetools/QUALITY_DECLARATION.md b/tracetools/QUALITY_DECLARATION.md index 68a2575..8109ef6 100644 --- a/tracetools/QUALITY_DECLARATION.md +++ b/tracetools/QUALITY_DECLARATION.md @@ -73,7 +73,9 @@ It does not currently have a features list with links to the corresponding featu ### Public API Documentation [3.ii] -`tracetools` does not currently have documentation for its public API. +`tracetools` has embedded API documentation which can be generated using doxygen. The latest version can be viewed [here](https://micro-ros.gitlab.io/ros_tracing/ros2_tracing-api/). + +New additions to the public API require documentation before being added. ### License [3.iii] @@ -175,7 +177,7 @@ The table below compares the requirements in REP-2004 with the current state of |2.v| Documentation policy for change requests | ✓ | |3| **Documentation** || |3.i| Per feature documentation | ✓ | -|3.ii| Public API documentation | | +|3.ii| Public API documentation | ✓ | |3.iii| Declared license(s) | ✓ | |3.iv| Copyright in source files | ✓ | |3.v.a| Quality declaration linked to from README | ✓ |