> Yes they are. I need to add comments to that affect in each of them.
I think that I have a better approach than just comments on the files.
For my project, I need meta-information on the world files.
I've already added the name, description and now license on every world file
of current CVS, so you don't need to do the boring work :) (I send you the
patch if interested)
And here you have my proposal, It's just documentation, as the server don't
need to support it (world. cc should be the right place):
/// @addtogroup models
/** @defgroup world_meta World Metainformation
The @c meta:Global tag is used to specify metainformation on the
world file. E.g:
<name>my first world</name>
<author>Your name here</author>
Meta atributes will be ignored by gazebo server in the simulation and can
be used to save user-defined data in the world files.
As Gazebo will ignore this atributes, any tag can be used but there are
some standarized useful tags:
- name (string)
- Name of this world file
- author (string)
- Name or names of authors, separated by commas
- description (string)
- Description of the world file
- version (string)
- Version of the world file
- license (string)
- Name of the license (GPL, BSD ...)