niklas/ros2_tracing
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch '85-add-api-documentation' into 'master'

Browse source 
Add API documentation for tracetools & tracetools_test

Closes #57 and #85

See merge request micro-ROS/ros_tracing/ros2_tracing!175
This commit is contained in:
Ingo Lütkebohle 2020-05-18 09:18:51 +00:00
commit 031386cf47
14 changed files with 457 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

6
tracetools/QUALITY_DECLARATION.md
View file

@ -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 | ✓ |