how-to-document-modules.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml-stylesheet type="text/xsl" href="yarpmanifest.xsl"?>

<module>
  <name>how-to-document-modules</name>
  <doxygen-group></doxygen-group>
  <description>Short description of your work.</description>
  <copypolicy> License terms, for example: released under the terms of the GNU GPL v2.0 .</copypolicy>
  <version> version of your code</version>

  <description-long>
   Here you can provide a detailed description of what your module does, how it is structured, how it works, how to use it and so on.
  </description-long>

  <arguments>
    <param default="default-value-0" desc="Describe the meaning and effect of parameter no. 0">parameter-0</param>
    <param default="default-value-1" desc="Describe the meaning and effect of parameter no. 1">parameter-1</param>
  </arguments>

  <authors>
    <author email="your-email@email.org"> Name Surname </author>
  </authors>

  <data>
      <input>
          <type>data type</type>
          <port carrier="tcp/udp/..">/how-to-document-modules/data:i</port>
          <description>
            Short description of your port behaviour.
          </description>
      </input>
      <output>
          <type>data type</type>
          <port carrier="tcp/udp/..">/how-to-document-modules/data:o</port>
          <description>
            Short description of your port behaviour.
          </description>
      </output>
  </data>

  <services>
    <server>
      <type>howToDocument_IDL</type>
      <idl>idl.thrift</idl>
      <port>/how-to-document-modules/rpc</port>
      <description>service port</description>
    </server>
  </services>

</module>