Skip to content

Commit 6eb3b53

Browse files
authored
Add an API reference page to the docs (#314)
There is a doxygen-generated API documentation as part of the ROS package documentation. We should at least link to that.
1 parent ba00e69 commit 6eb3b53

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

doc/api_reference.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
C++ API Reference
2+
=================
3+
4+
There is a generated API documentation as a part of the ROS package documentation:
5+
6+
https://docs.ros.org/en/rolling/p/ur_client_library/generated/index.html
7+
8+
It is generated directly from the source code using Doxygen. Though the documentation is hosted
9+
inside the ROS documentation structure, it is not a ROS-specific API. The API is the same for all
10+
platforms.

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ can be found on `GitHub <https://github.com/UniversalRobots/Universal_Robots_Cli
2020
examples
2121
real_time
2222
migration_notes
23+
api_reference

0 commit comments

Comments
 (0)