Tasks #1301

Adapt documentation of rst.vision.SimpleXYZImage to new conventions

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

Status:ResolvedStart date:12/14/2012
Priority:LowDue date:
Assignee:A. Swadzba% Done:

100%

Category:documentation
Target version:Robotics Service Bus - rsb-0.9

Description

All types in the master branch use a doxygen-inspired syntax for documentation (for an example, see source:proto/sandbox/rst/geometry/AxisAlignedBoundingBox3DFloat.proto, and the corresponding generated documenation).


Related issues

Related to Robotics Systems Types - Feature #1200: Add SimpleXYZImage Resolved 10/11/2012

Associated revisions

Revision 9b0f23bf
Added by J. Moringen over 11 years ago

Initial documentation in proto/sandbox/rst/vision/SimpleXYZImage.proto

refs #1301

Note: The documentation is still incomplete and has to be extended by
the original authoress.

  • proto/sandbox/rst/vision/SimpleXYZImage.proto: added initial
    documentation, constraints and units

Revision 0a7d255a
Added by A. Swadzba over 11 years ago

Extended documentation of SimpleXYZImage.proto

fixes #1301

  • SimpleXYZImage.proto: filled in missing parts of the message and
    field documentation strings

Signed-off-by: Jan Moringen <>

Revision 06f4c881
Added by J. Moringen over 11 years ago

Fixed indentation in proto/sandbox/rst/vision/SimpleXYZImage.proto

refs #1301

  • proto/sandbox/rst/vision/SimpleXYZImage.proto: fixed indentation of
    docstring for field SimpleXYZImage.x

History

#1 Updated by A. Swadzba over 11 years ago

  • Status changed from New to Resolved
  • % Done changed from 0 to 100

Applied in changeset rst-proto|commit:0a7d255afdf4a50305a0f85fe509e034faf16fc5.

Also available in: Atom PDF