[Documentation] [TitleIndex] [WordIndex

API review

Proposer: Brian Gerkey

Present at review:

Question / concerns / comments

Meeting notes

We have several types of documentation, and two places to put them. We've arrived at the following arrangement:

SVN

Wiki

Library API

X

ROS API

X

Usage

?

?

Tutorial

X

Conceptual

X

Of the X marks above, the one that implies a change is the ROS API: it's currently in the Wiki. The plan is to write a script that converts, en masse, the ROS API documentation that is formatted using ClearSilver templates in the Wiki into some formal spec, to live in the package. The format of this spec is to be defined.

Several other issues were brought up, listed as tasks below.

Two open questions remain:

These questions will be resolved in a future meeting.

Conclusion



2018-09-15 12:20