Tasks #1258: Change comments in IDL files to doxygen style - Robotics Systems Types - Open Source Collaboration Platform

Tasks #1258

Change comments in IDL files to doxygen style

Added by J. Moringen over 11 years ago. Updated over 11 years ago.

Status:

Resolved

Start date:

11/26/2012

Priority:

Normal

Due date:

Assignee:

% Done:

100%

Category:

documentation

Target version:

Robotics Service Bus - rsb-0.9

Description

This basically means

comments should be formatted like this
```
/**
 * CONTENT
 */
  
```
fields should be documented individually
@author, @todo etc. should be used.

Associated revisions

Revision ef3b1c43
Added by J. Moringen over 11 years ago

Initial comment rewrite in proto/**/*.proto

fixes #1258

Change comment formatting to resemble doxygen comments
Comments now look like this
```
/**
 * CONTENT
     */
```

Added @author markup for messages

Message-level comments now look this

/**
 * ONE-SENTENCE-DESCRIPTION
 *
 * MORE-DETAILS
 *
 * @author NAME &lt;EMAIL&gt;
     */

Added TODOs for missing comments and unknown authorship

Revision 0f629d01
Added by J. Moringen over 11 years ago

Fixed indentation of comments in proto/**/*.proto

refs #1258

proto/sandbox/rst/hri/PersonHypotheses.proto: fixed indentation of
comments
proto/stable/rst/classification/ClassificationResult.proto: likewise
proto/stable/rst/stochastics/MixtureOfGaussian1D.proto: likewise

History

#1 Updated by J. Moringen over 11 years ago

Status changed from In Progress to Resolved
% Done changed from 0 to 100

Applied in changeset rst-proto|commit:ef3b1c43cd9b5e86cb54e830b9ea65581aee1037.

Also available in: Atom PDF