Skip to content

Commit

Permalink
Update the C++ docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Wumpf
Wumpf committed Jan 31, 2025
1 parent c3a24e3 commit 1193f5e
Show file tree
Hide file tree
Showing 96 changed files with 3,608 additions and 3,397 deletions.
2 changes: 1 addition & 1 deletion docs/cpp/main/archetypes_2annotation__context_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="comment"></span> <span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">struct </span>AsComponents&lt;archetypes::<a class="code hl_struct" href="structrerun_1_1archetypes_1_1AnnotationContext.html">AnnotationContext</a>&gt; {<span class="comment"></span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="comment"> /// Serialize all set component batches.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;std::vector&lt;ComponentBatch&gt;</a>&gt; serialize(</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;Collection&lt;ComponentBatch&gt;</a>&gt; as_batches(</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1archetypes_1_1AnnotationContext.html">archetypes::AnnotationContext</a>&amp; archetype</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> );</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> };</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/cpp/main/archetypes_2near__clip__plane_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"></span> <span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">struct </span>AsComponents&lt;blueprint::<a class="code hl_struct" href="structrerun_1_1blueprint_1_1archetypes_1_1NearClipPlane.html">archetypes::NearClipPlane</a>&gt; {<span class="comment"></span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> /// Serialize all set component batches.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;std::vector&lt;ComponentBatch&gt;</a>&gt; serialize(</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;Collection&lt;ComponentBatch&gt;</a>&gt; as_batches(</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1blueprint_1_1archetypes_1_1NearClipPlane.html">blueprint::archetypes::NearClipPlane</a>&amp; archetype</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> );</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> };</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/cpp/main/archetypes_2scalar_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"> /// // Serialize to columns and send.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> /// rec.send_columns(</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> /// &quot;scalars&quot;,</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> /// rerun::TimeColumn::from_sequence_points(&quot;step&quot;, std::move(times)),</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> /// rerun::TimeColumn::from_sequence(&quot;step&quot;, std::move(times)),</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> /// rerun::Scalar().with_many_scalar(std::move(scalar_data)).columns()</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> /// );</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"> /// }</span></div>
Expand Down Expand Up @@ -262,7 +262,7 @@
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span><span class="comment"></span> <span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> <span class="keyword">struct </span>AsComponents&lt;archetypes::<a class="code hl_struct" href="structrerun_1_1archetypes_1_1Scalar.html">Scalar</a>&gt; {<span class="comment"></span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span><span class="comment"> /// Serialize all set component batches.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;std::vector&lt;ComponentBatch&gt;</a>&gt; serialize(<span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1archetypes_1_1Scalar.html">archetypes::Scalar</a>&amp; archetype);</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;Collection&lt;ComponentBatch&gt;</a>&gt; as_batches(<span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1archetypes_1_1Scalar.html">archetypes::Scalar</a>&amp; archetype);</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> };</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span>} <span class="comment">// namespace rerun</span></div>
<div class="ttc" id="aclassrerun_1_1Collection_html"><div class="ttname"><a href="classrerun_1_1Collection.html">rerun::Collection</a></div><div class="ttdoc">Generic collection of elements that are roughly contiguous in memory.</div><div class="ttdef"><b>Definition</b> collection.hpp:49</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/cpp/main/archetypes_2view__coordinates_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno"> 383</span><span class="comment"></span> <span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span> <span class="keyword">struct </span>AsComponents&lt;archetypes::<a class="code hl_struct" href="structrerun_1_1archetypes_1_1ViewCoordinates.html">ViewCoordinates</a>&gt; {<span class="comment"></span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span><span class="comment"> /// Serialize all set component batches.</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;std::vector&lt;ComponentBatch&gt;</a>&gt; serialize(</div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;Collection&lt;ComponentBatch&gt;</a>&gt; as_batches(</div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span> <span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1archetypes_1_1ViewCoordinates.html">archetypes::ViewCoordinates</a>&amp; archetype</div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span> );</div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span> };</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/cpp/main/archetypes_2visual__bounds2d_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"></span> <span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">struct </span>AsComponents&lt;blueprint::<a class="code hl_struct" href="structrerun_1_1blueprint_1_1archetypes_1_1VisualBounds2D.html">archetypes::VisualBounds2D</a>&gt; {<span class="comment"></span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> /// Serialize all set component batches.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;std::vector&lt;ComponentBatch&gt;</a>&gt; serialize(</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;Collection&lt;ComponentBatch&gt;</a>&gt; as_batches(</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1blueprint_1_1archetypes_1_1VisualBounds2D.html">blueprint::archetypes::VisualBounds2D</a>&amp; archetype</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> );</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> };</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/cpp/main/arrows2d_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span><span class="comment"></span> <span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> <span class="keyword">struct </span>AsComponents&lt;archetypes::<a class="code hl_struct" href="structrerun_1_1archetypes_1_1Arrows2D.html">Arrows2D</a>&gt; {<span class="comment"></span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span><span class="comment"> /// Serialize all set component batches.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;std::vector&lt;ComponentBatch&gt;</a>&gt; serialize(<span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1archetypes_1_1Arrows2D.html">archetypes::Arrows2D</a>&amp; archetype);</div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;Collection&lt;ComponentBatch&gt;</a>&gt; as_batches(<span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1archetypes_1_1Arrows2D.html">archetypes::Arrows2D</a>&amp; archetype);</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span> };</div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span>} <span class="comment">// namespace rerun</span></div>
<div class="ttc" id="aclassrerun_1_1Collection_html"><div class="ttname"><a href="classrerun_1_1Collection.html">rerun::Collection</a></div><div class="ttdoc">Generic collection of elements that are roughly contiguous in memory.</div><div class="ttdef"><b>Definition</b> collection.hpp:49</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/cpp/main/arrows3d_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span><span class="comment"></span> <span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> <span class="keyword">struct </span>AsComponents&lt;archetypes::<a class="code hl_struct" href="structrerun_1_1archetypes_1_1Arrows3D.html">Arrows3D</a>&gt; {<span class="comment"></span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span><span class="comment"> /// Serialize all set component batches.</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;std::vector&lt;ComponentBatch&gt;</a>&gt; serialize(<span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1archetypes_1_1Arrows3D.html">archetypes::Arrows3D</a>&amp; archetype);</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span><span class="comment"></span> <span class="keyword">static</span> <a class="code hl_class" href="classrerun_1_1Result.html">Result&lt;Collection&lt;ComponentBatch&gt;</a>&gt; as_batches(<span class="keyword">const</span> <a class="code hl_struct" href="structrerun_1_1archetypes_1_1Arrows3D.html">archetypes::Arrows3D</a>&amp; archetype);</div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> };</div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span>} <span class="comment">// namespace rerun</span></div>
<div class="ttc" id="aclassrerun_1_1Collection_html"><div class="ttname"><a href="classrerun_1_1Collection.html">rerun::Collection</a></div><div class="ttdoc">Generic collection of elements that are roughly contiguous in memory.</div><div class="ttdef"><b>Definition</b> collection.hpp:49</div></div>
Expand Down
Loading

0 comments on commit 1193f5e

Please sign in to comment.