Update documentation for master

master/ReleaseNotes.html

@@ -62,6 +62,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datamodel_syntax.html#defining-members">Defining members</a></li>

master/advanced_topics.html

@@ -64,6 +64,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datamodel_syntax.html#defining-members">Defining members</a></li>

master/contributing.html

@@ -62,6 +62,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datamodel_syntax.html#defining-members">Defining members</a></li>

master/cpp_api/api.html

@@ -64,6 +64,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../datamodel_syntax.html#defining-members">Defining members</a></li>

master/cpp_api/class/classpodio_1_1_collection_base.html

@@ -64,6 +64,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../datamodel_syntax.html#defining-members">Defining members</a></li>

master/cpp_api/class/classpodio_1_1_collection_buffer_factory.html

@@ -64,6 +64,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../datamodel_syntax.html#defining-members">Defining members</a></li>
@@ -552,7 +553,7 @@ <h1>Class podio::CollectionBufferFactory<a class="headerlink" href="#class-podio
 <dl class="cpp class">
 <dt class="sig sig-object cpp" id="_CPPv4N5podio23CollectionBufferFactoryE">
 <span id="_CPPv3N5podio23CollectionBufferFactoryE"></span><span id="_CPPv2N5podio23CollectionBufferFactoryE"></span><span id="podio::CollectionBufferFactory"></span><span class="target" id="classpodio_1_1_collection_buffer_factory"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CollectionBufferFactory</span></span></span><a class="headerlink" href="#_CPPv4N5podio23CollectionBufferFactoryE" title="Link to this definition"></a><br /></dt>
-<dd><p>The CollectionBufferFactory allows to create buffers of known datatypes, which can then be populated by e.g. </p>
+<dd><p>The CollectionBufferFactory allows one to create buffers of known datatypes, which can then be populated by e.g. </p>
 <p>readers. In order to support schema evolution, the buffers have a version and this factory will also require a schema version to create buffers.</p>
 <p>It is implemented as a singleton, which is populated at the time a shared datamodel library is loaded. It is assumed that that happens early on in the startup of an application, such that only a single thread will access the factory instance for registering datatypes. Since the necessary creation functions are part of the core datamodel library, this should be very easy to achieve by simply linking to that library. Once the factory is populated it can be safely accessed from multiple threads concurrently to obtain buffers. </p>
 <div class="breathe-sectiondef docutils container">

master/cpp_api/class/classpodio_1_1_collection_i_d_table.html

@@ -64,6 +64,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../datamodel_syntax.html#defining-members">Defining members</a></li>

master/cpp_api/class/classpodio_1_1_datamodel_definition_collector.html

@@ -64,6 +64,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../datamodel_syntax.html#defining-members">Defining members</a></li>

master/cpp_api/class/classpodio_1_1_datamodel_definition_holder.html

@@ -64,6 +64,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../datamodel_syntax.html#defining-members">Defining members</a></li>

master/cpp_api/class/classpodio_1_1_datamodel_registry.html

@@ -64,6 +64,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../datamodel_syntax.html">Data Models and Data Model Definitions</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#basic-concepts-and-supported-features">Basic Concepts and Supported Features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#mandatory-fields">Mandatory fields</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-components">Definition of custom components</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../datamodel_syntax.html#definition-of-custom-data-classes">Definition of custom data classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../datamodel_syntax.html#defining-members">Defining members</a></li>
@@ -589,19 +590,25 @@ <h1>Class podio::DatamodelRegistry<a class="headerlink" href="#class-podio-datam
 <p>If no datamodel with the given name can be found, an empty datamodel definition, i.e. an empty JSON object (“{}”), is returned.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>name</strong> – The name of the datamodel </p>
+<dd class="field-odd"><p><strong>name</strong> – The name of the datamodel</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The high level definition of the datamodel in JSON format </p>
 </dd>
 </dl>
 </dd></dl>
 
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4NK5podio17DatamodelRegistry22getDatamodelDefinitionE6size_t">
 <span id="_CPPv3NK5podio17DatamodelRegistry22getDatamodelDefinitionE6size_t"></span><span id="_CPPv2NK5podio17DatamodelRegistry22getDatamodelDefinitionE6size_t"></span><span id="podio::DatamodelRegistry::getDatamodelDefinition__sC"></span><span class="target" id="classpodio_1_1_datamodel_registry_1ab0ce7673e7e44cbc2dbec355b308e3fb"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getDatamodelDefinition</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">index</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5podio17DatamodelRegistry22getDatamodelDefinitionE6size_t" title="Link to this definition"></a><br /></dt>
-<dd><p>Get the defintion (in JSON format) of the datamodel wth the given index. </p>
+<dd><p>Get the definition (in JSON format) of the datamodel with the given index. </p>
 <p>If no datamodel is found under the given index, an empty datamodel definition, i.e. an empty JSON object (“{}”), is returned.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>index</strong> – The datamodel definition index that can be obtained from each collection </p>
+<dd class="field-odd"><p><strong>index</strong> – The datamodel definition index that can be obtained from each collection</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The high level definition of the datamodel in JSON format </p>
 </dd>
 </dl>
 </dd></dl>
@@ -613,24 +620,30 @@ <h1>Class podio::DatamodelRegistry<a class="headerlink" href="#class-podio-datam
 <p>If no datamodel is found under the given index, an empty string is returned</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>index</strong> – The datamodel definition index that can be obtained from each collection </p>
+<dd class="field-odd"><p><strong>index</strong> – The datamodel definition index that can be obtained from each collection</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The name of the datamodel </p>
 </dd>
 </dl>
 </dd></dl>
 
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N5podio17DatamodelRegistry17registerDatamodelENSt6stringENSt11string_viewERKN5podio19RelationNameMappingE">
 <span id="_CPPv3N5podio17DatamodelRegistry17registerDatamodelENSt6stringENSt11string_viewERKN5podio19RelationNameMappingE"></span><span id="_CPPv2N5podio17DatamodelRegistry17registerDatamodelENSt6stringENSt11string_viewERKN5podio19RelationNameMappingE"></span><span id="podio::DatamodelRegistry::registerDatamodel__ss.std::string_view.podio::RelationNameMappingCR"></span><span class="target" id="classpodio_1_1_datamodel_registry_1a48d84cdd5ae32e8e4470a35c22323bb6"></span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">registerDatamodel</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">name</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">definition</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../file/_collection_base_8h.html#_CPPv45podio" title="podio"><span class="n"><span class="pre">podio</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../file/_datamodel_registry_8h.html#_CPPv4N5podio19RelationNameMappingE" title="podio::RelationNameMapping"><span class="n"><span class="pre">RelationNameMapping</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">relationNames</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5podio17DatamodelRegistry17registerDatamodelENSt6stringENSt11string_viewERKN5podio19RelationNameMappingE" title="Link to this definition"></a><br /></dt>
-<dd><p>Register a datamodel return the index in the registry. </p>
+<dd><p>Register a datamodel and return its index in the registry. </p>
 <p>This is the hook that is called during dynamic loading of an EDM to register information for this EDM. If an EDM has already been registered under this name, than the index to the existing EDM in the registry will be returned.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>name</strong> – The name of the EDM that should be registered </p></li>
 <li><p><strong>definition</strong> – The datamodel definition from which this EDM has been generated in JSON format </p></li>
-<li><p><strong>relationNames</strong> – the names of the relations and vector members for all datatypes that are defined for this EDM </p></li>
+<li><p><strong>relationNames</strong> – the names of the relations and vector members for all datatypes that are defined for this EDM</p></li>
 </ul>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The index of this datamodel in the registry </p>
+</dd>
 </dl>
 </dd></dl>