ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange
Ask Your Question

Are there ROS API documents published, and where?

asked 2012-12-16 21:51:44 -0600

HQ gravatar image

updated 2014-01-28 17:14:36 -0600

ngrennan gravatar image

This seems like a stupid question, but I have honestly tried and failed to find any documentation for the ROS APIs. To better clarify, I'm coming from the Java world, where I can go to Oracle's website and look up the API for any class that's in the standard libraries. Not that I'm asking for the same level of documentation, but it seems like there should be something similar and it's just my failure in finding it. Or do I need to get the source code for the particular library I'm wondering about and reference those files directly?

I just posted previous question that I should have been able to answer for myself if I could have located the API documentation for the roscpp library. Can someone please point me in the right direction?

Thanks! Hung

edit retag flag offensive close merge delete


Ah, I see where I went wrong - I started drilling down from the link in the main page, under the section "3. API Reference", and assumed that the link in the top right box for "Package Links" would be the same. Thanks for your patience and quick responses, dornhege and tfoote.

HQ gravatar image HQ  ( 2012-12-17 08:30:31 -0600 )edit

2 Answers

Sort by ยป oldest newest most voted

answered 2012-12-16 22:10:42 -0600

tfoote gravatar image

You'll find API documentation for most packages by visiting their wiki page and clicking on the Code API link in the standard header. For example see the top right of the roscpp wiki page

edit flag offensive delete link more

answered 2012-12-16 22:08:57 -0600

dornhege gravatar image

updated 2012-12-16 22:11:54 -0600

The API is usually auto-generated for all released packages. You can find it on the Wiki page of each package under Code-API.

For example the roscpp API docs are here.

edit flag offensive delete link more

Question Tools


Asked: 2012-12-16 21:51:44 -0600

Seen: 452 times

Last updated: Dec 16 '12