search

robotology / yarp-device-realsense2

realsense2 device for YARP (https://www.yarp.it/)
Other
7 stars 10 forks source link

Move realsense2 documentation from YARP as README.md #2

Closed drdanz closed 3 years ago

drdanz commented 3 years ago

Original author: @aikolina

As discussed in robotology/yarp#2371

drdanz commented 3 years ago

CC @traversaro

Nicogene commented 3 years ago

In this way we lost the doxy documentation am I right?

In particular, I think that this table is very important to have it in the documentation:

https://github.com/robotology/yarp-device-realsense2/blob/33a3ed204dac65bab2b7cafe183c6983a0cfdb5d/src/devices/realsense2/realsense2Driver.h#L39-L79

Nicogene commented 3 years ago

PS: I think that we have also to setup the code-ownership as was inside yarp in order to be automatically mentioned as reviewers

drdanz commented 3 years ago

The generated page is this: http://yarp.it/classrealsense2Driver.html (the link will disappear when we remove the driver for YARP) We can either run doxygen in this repository as well, or port it to markdown (in the README.md or in a separate file)

Anyway, the important thing right now is that the documentation is in the same repository as the code...

drdanz commented 3 years ago

PS: I think that we have also to setup the code-ownership as was inside yarp in order to be automatically mentioned as reviewers

@Nicogene You won the ownership! :smile: Here's the CODEOWNERS file