Document keywords that appear only in the source code.
Motivation
There are some special string and keywords, such as "gazebo-entity", used in the code base. These should be documented somewhere so that users and contributors know of their existence, when to use them, and when to create new keywords.
The documentation page(s) could also include other topics like transport topics and services, environment variables, etc.
osrf-migration
commented
4 years ago
Original report (archived issue) by Nate Koenig (Bitbucket: Nathan Koenig).
Summary
Document keywords that appear only in the source code.
Motivation
There are some special string and keywords, such as "gazebo-entity", used in the code base. These should be documented somewhere so that users and contributors know of their existence, when to use them, and when to create new keywords.
The documentation page(s) could also include other topics like transport topics and services, environment variables, etc.