4.3.9 Commenting on messages

The ASAM OSI® reference documentation is created using Doxygen. The content of the reference documentation is generated from comments in the .proto files. Follow these steps when creating comments on messages to keep the documentation style consistent.

Prerequisites

  • You have created a new message.

Steps

  1. Add a brief description using the \brief keyword followed by an empty comment line.

  2. Optionally, add an image using the \image html keyword followed by an empty comment line. The image must be stored at ./open-simulation-interface/docs/images

  3. Optionally, add a detailed description spanning multiple lines followed by an empty comment line.

  4. Optionally, add notes using the keyword \note.

Example

// \brief The conditions of the environment.
//
// \image html EnvironmentalConditions.svg
//
// Definition of light, weather conditions and other environmental conditions.
//
// \note These conditions apply locally around the host vehicle.
//
message EnvironmentalConditions
{
}