Skip to content

Commit 214d9d2

Browse files
azonenbergazonenberg
committed
Updated developer documentation as of scopehal-apps 8421c66842471933303e3660097a3c547a744e05
1 parent 55ee896 commit 214d9d2

File tree

5,854 files changed

+176470
-95097
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

5,854 files changed

+176470
-95097
lines changed

‎devdocs/ACCoupleFilter_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+3d208fe11</span>
24+
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+51fbda87c</span>
2525
</div>
2626
</td>
2727
</tr>

‎devdocs/ACCoupleFilter_8h_source.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+3d208fe11</span>
24+
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+51fbda87c</span>
2525
</div>
2626
</td>
2727
</tr>
@@ -120,8 +120,8 @@
120120
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#endif</span></div>
121121
<div class="ttc" id="aclassACCoupleFilter_html"><div class="ttname"><a href="classACCoupleFilter.html">ACCoupleFilter</a></div><div class="ttdef"><b>Definition:</b> ACCoupleFilter.h:39</div></div>
122122
<div class="ttc" id="aclassACCoupleFilter_html_ab8c9af335786b059ab0278d8ea2595b7"><div class="ttname"><a href="classACCoupleFilter.html#ab8c9af335786b059ab0278d8ea2595b7">ACCoupleFilter::Refresh</a></div><div class="ttdeci">virtual void Refresh() override</div><div class="ttdoc">Evaluates a filter graph node.</div><div class="ttdef"><b>Definition:</b> ACCoupleFilter.cpp:70</div></div>
123-
<div class="ttc" id="aclassFilter_html"><div class="ttname"><a href="classFilter.html">Filter</a></div><div class="ttdoc">Abstract base class for all filters and protocol decoders.</div><div class="ttdef"><b>Definition:</b> Filter.h:82</div></div>
124-
<div class="ttc" id="aclassStreamDescriptor_html"><div class="ttname"><a href="classStreamDescriptor.html">StreamDescriptor</a></div><div class="ttdoc">Descriptor for a single stream coming off a channel.</div><div class="ttdef"><b>Definition:</b> StreamDescriptor.h:44</div></div>
123+
<div class="ttc" id="aclassFilter_html"><div class="ttname"><a href="classFilter.html">Filter</a></div><div class="ttdoc">Abstract base class for all filter graph blocks which are not physical instrument channels.</div><div class="ttdef"><b>Definition:</b> Filter.h:95</div></div>
124+
<div class="ttc" id="aclassStreamDescriptor_html"><div class="ttname"><a href="classStreamDescriptor.html">StreamDescriptor</a></div><div class="ttdoc">Descriptor for a single stream coming off a channel.</div><div class="ttdef"><b>Definition:</b> StreamDescriptor.h:46</div></div>
125125
</div><!-- fragment --></div><!-- contents -->
126126
<!-- start footer part -->
127127
<hr class="footer"/><address class="footer"><small>

‎devdocs/ACRMSMeasurement_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+3d208fe11</span>
24+
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+51fbda87c</span>
2525
</div>
2626
</td>
2727
</tr>

‎devdocs/ACRMSMeasurement_8h_source.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+3d208fe11</span>
24+
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+51fbda87c</span>
2525
</div>
2626
</td>
2727
</tr>
@@ -118,8 +118,8 @@
118118
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#endif</span></div>
119119
<div class="ttc" id="aclassACRMSMeasurement_html"><div class="ttname"><a href="classACRMSMeasurement.html">ACRMSMeasurement</a></div><div class="ttdef"><b>Definition:</b> ACRMSMeasurement.h:39</div></div>
120120
<div class="ttc" id="aclassACRMSMeasurement_html_a1b0c4a900d0245b1d7c3848deb14903b"><div class="ttname"><a href="classACRMSMeasurement.html#a1b0c4a900d0245b1d7c3848deb14903b">ACRMSMeasurement::Refresh</a></div><div class="ttdeci">virtual void Refresh() override</div><div class="ttdoc">Evaluates a filter graph node.</div><div class="ttdef"><b>Definition:</b> ACRMSMeasurement.cpp:76</div></div>
121-
<div class="ttc" id="aclassFilter_html"><div class="ttname"><a href="classFilter.html">Filter</a></div><div class="ttdoc">Abstract base class for all filters and protocol decoders.</div><div class="ttdef"><b>Definition:</b> Filter.h:82</div></div>
122-
<div class="ttc" id="aclassStreamDescriptor_html"><div class="ttname"><a href="classStreamDescriptor.html">StreamDescriptor</a></div><div class="ttdoc">Descriptor for a single stream coming off a channel.</div><div class="ttdef"><b>Definition:</b> StreamDescriptor.h:44</div></div>
121+
<div class="ttc" id="aclassFilter_html"><div class="ttname"><a href="classFilter.html">Filter</a></div><div class="ttdoc">Abstract base class for all filter graph blocks which are not physical instrument channels.</div><div class="ttdef"><b>Definition:</b> Filter.h:95</div></div>
122+
<div class="ttc" id="aclassStreamDescriptor_html"><div class="ttname"><a href="classStreamDescriptor.html">StreamDescriptor</a></div><div class="ttdoc">Descriptor for a single stream coming off a channel.</div><div class="ttdef"><b>Definition:</b> StreamDescriptor.h:46</div></div>
123123
</div><!-- fragment --></div><!-- contents -->
124124
<!-- start footer part -->
125125
<hr class="footer"/><address class="footer"><small>

‎devdocs/ADL5205Decoder_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+3d208fe11</span>
24+
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+51fbda87c</span>
2525
</div>
2626
</td>
2727
</tr>

‎devdocs/ADL5205Decoder_8h_source.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+3d208fe11</span>
24+
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+51fbda87c</span>
2525
</div>
2626
</td>
2727
</tr>
@@ -153,9 +153,9 @@
153153
<div class="ttc" id="aclassADL5205Waveform_html"><div class="ttname"><a href="classADL5205Waveform.html">ADL5205Waveform</a></div><div class="ttdef"><b>Definition:</b> ADL5205Decoder.h:59</div></div>
154154
<div class="ttc" id="aclassADL5205Waveform_html_a0f46364f73546074998c88a525735284"><div class="ttname"><a href="classADL5205Waveform.html#a0f46364f73546074998c88a525735284">ADL5205Waveform::GetColor</a></div><div class="ttdeci">virtual std::string GetColor(size_t) override</div><div class="ttdoc">Returns the displayed color (in HTML #rrggbb or #rrggbbaa notation) of a given protocol sample.</div><div class="ttdef"><b>Definition:</b> ADL5205Decoder.cpp:162</div></div>
155155
<div class="ttc" id="aclassADL5205Waveform_html_a8ee6bebc377393bef5fbbceebcf55d48"><div class="ttname"><a href="classADL5205Waveform.html#a8ee6bebc377393bef5fbbceebcf55d48">ADL5205Waveform::GetText</a></div><div class="ttdeci">virtual std::string GetText(size_t) override</div><div class="ttdoc">Returns the text representation of a given protocol sample.</div><div class="ttdef"><b>Definition:</b> ADL5205Decoder.cpp:167</div></div>
156-
<div class="ttc" id="aclassFilter_html"><div class="ttname"><a href="classFilter.html">Filter</a></div><div class="ttdoc">Abstract base class for all filters and protocol decoders.</div><div class="ttdef"><b>Definition:</b> Filter.h:82</div></div>
157-
<div class="ttc" id="aclassSparseWaveform_html"><div class="ttname"><a href="classSparseWaveform.html">SparseWaveform</a></div><div class="ttdoc">A waveform sampled at irregular intervals.</div><div class="ttdef"><b>Definition:</b> Waveform.h:448</div></div>
158-
<div class="ttc" id="aclassStreamDescriptor_html"><div class="ttname"><a href="classStreamDescriptor.html">StreamDescriptor</a></div><div class="ttdoc">Descriptor for a single stream coming off a channel.</div><div class="ttdef"><b>Definition:</b> StreamDescriptor.h:44</div></div>
156+
<div class="ttc" id="aclassFilter_html"><div class="ttname"><a href="classFilter.html">Filter</a></div><div class="ttdoc">Abstract base class for all filter graph blocks which are not physical instrument channels.</div><div class="ttdef"><b>Definition:</b> Filter.h:95</div></div>
157+
<div class="ttc" id="aclassSparseWaveform_html"><div class="ttname"><a href="classSparseWaveform.html">SparseWaveform</a></div><div class="ttdoc">A waveform sampled at irregular intervals.</div><div class="ttdef"><b>Definition:</b> Waveform.h:460</div></div>
158+
<div class="ttc" id="aclassStreamDescriptor_html"><div class="ttname"><a href="classStreamDescriptor.html">StreamDescriptor</a></div><div class="ttdoc">Descriptor for a single stream coming off a channel.</div><div class="ttdef"><b>Definition:</b> StreamDescriptor.h:46</div></div>
159159
</div><!-- fragment --></div><!-- contents -->
160160
<!-- start footer part -->
161161
<hr class="footer"/><address class="footer"><small>

‎devdocs/AboutDialog_8cpp.html‎

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+3d208fe11</span>
24+
<div id="projectname">ngscopeclient<span id="projectnumber">&#160;0.1-dev+51fbda87c</span>
2525
</div>
2626
</td>
2727
</tr>
@@ -82,56 +82,56 @@
8282
<div class="dyncontent">
8383
<div class="center"><img src="AboutDialog_8cpp__incl.png" border="0" usemap="#asrc_2ngscopeclient_2AboutDialog_8cpp" alt=""/></div>
8484
<map name="asrc_2ngscopeclient_2AboutDialog_8cpp" id="asrc_2ngscopeclient_2AboutDialog_8cpp">
85-
<area shape="rect" title="Implementation of AboutDialog." alt="" coords="2834,5,3081,32"/>
86-
<area shape="rect" href="ngscopeclient_8h_source.html" title=" " alt="" coords="1059,80,1183,107"/>
87-
<area shape="rect" href="AboutDialog_8h.html" title="Declaration of AboutDialog." alt="" coords="2303,80,2417,107"/>
88-
<area shape="rect" href="MainWindow_8h.html" title="Declaration of MainWindow." alt="" coords="2899,80,3016,107"/>
89-
<area shape="rect" title=" " alt="" coords="3041,80,3218,107"/>
90-
<area shape="rect" title=" " alt="" coords="3243,80,3389,107"/>
91-
<area shape="rect" title=" " alt="" coords="1421,162,1587,189"/>
92-
<area shape="rect" title=" " alt="" coords="1612,162,1724,189"/>
93-
<area shape="rect" title=" " alt="" coords="2313,401,2383,427"/>
94-
<area shape="rect" title=" " alt="" coords="1799,162,1975,189"/>
95-
<area shape="rect" title=" " alt="" coords="5,155,165,196"/>
96-
<area shape="rect" title=" " alt="" coords="189,155,349,196"/>
97-
<area shape="rect" title=" " alt="" coords="373,162,440,189"/>
98-
<area shape="rect" title=" " alt="" coords="464,162,579,189"/>
99-
<area shape="rect" href="BERTState_8h.html" title="Declaration of BERTState." alt="" coords="603,162,706,189"/>
100-
<area shape="rect" href="PowerSupplyState_8h.html" title="Declaration of PowerSupplyState." alt="" coords="731,162,883,189"/>
101-
<area shape="rect" href="MultimeterState_8h.html" title="Declaration of MultimeterState." alt="" coords="907,162,1047,189"/>
102-
<area shape="rect" href="LoadState_8h.html" title="Declaration of LoadState." alt="" coords="1072,162,1171,189"/>
103-
<area shape="rect" href="GuiLogSink_8h.html" title="Declaration of GuiLogSink." alt="" coords="1195,162,1301,189"/>
104-
<area shape="rect" href="Event_8h_source.html" title=" " alt="" coords="1326,162,1397,189"/>
105-
<area shape="rect" href="Dialog_8h.html" title="Declaration of Dialog." alt="" coords="2686,244,2762,271"/>
106-
<area shape="rect" title=" " alt="" coords="2667,319,2781,345"/>
107-
<area shape="rect" href="Session_8h.html" title="Declaration of Session." alt="" coords="3426,244,3510,271"/>
108-
<area shape="rect" href="FontManager_8h.html" title="Declaration of FontManager." alt="" coords="2271,319,2390,345"/>
109-
<area shape="rect" href="TextureManager_8h.html" title="Declaration of TextureManager." alt="" coords="2823,319,2961,345"/>
110-
<area shape="rect" href="VulkanWindow_8h.html" title="Declaration of VulkanWindow." alt="" coords="2329,162,2460,189"/>
111-
<area shape="rect" href="WaveformGroup_8h.html" title="Declaration of WaveformGroup." alt="" coords="3228,162,3369,189"/>
112-
<area shape="rect" href="FilterGraphEditor_8h.html" title="Declaration of FilterGraphEditor." alt="" coords="3837,162,3979,189"/>
113-
<area shape="rect" href="ManageInstrumentsDialog_8h.html" title="Declaration of ManageInstrumentsDialog." alt="" coords="2746,162,2953,189"/>
114-
<area shape="rect" href="ProtocolAnalyzerDialog_8h.html" title="Declaration of ProtocolAnalyzerDialog." alt="" coords="3524,162,3711,189"/>
115-
<area shape="rect" title=" " alt="" coords="3535,244,3740,271"/>
116-
<area shape="rect" href="StreamBrowserDialog_8h.html" title="Declaration of StreamBrowserDialog." alt="" coords="2977,162,3153,189"/>
117-
<area shape="rect" href="TimebasePropertiesDialog_8h.html" title="Declaration of TimebasePropertiesDialog." alt="" coords="2100,162,2305,189"/>
118-
<area shape="rect" href="TriggerPropertiesDialog_8h.html" title="Declaration of TriggerPropertiesDialog." alt="" coords="2484,162,2671,189"/>
119-
<area shape="rect" href="Workspace_8h.html" title="Declaration of Workspace." alt="" coords="3393,162,3500,189"/>
120-
<area shape="rect" title=" " alt="" coords="3223,319,3374,345"/>
121-
<area shape="rect" href="HistoryManager_8h.html" title="Declaration of HistoryManager." alt="" coords="3399,319,3537,345"/>
122-
<area shape="rect" href="Marker_8h.html" title="Declaration of Marker." alt="" coords="3469,401,3547,427"/>
123-
<area shape="rect" href="PacketManager_8h.html" title="Declaration of PacketManager." alt="" coords="3613,319,3747,345"/>
124-
<area shape="rect" href="PreferenceManager_8h.html" title="Stores and manages preference values." alt="" coords="2986,319,3147,345"/>
125-
<area shape="rect" href="TriggerGroup_8h.html" title="Declaration of TriggerGroup." alt="" coords="3771,319,3890,345"/>
126-
<area shape="rect" href="PacketDecoder_8h_source.html" title=" " alt="" coords="3613,393,3747,435"/>
127-
<area shape="rect" title=" " alt="" coords="2641,401,2692,427"/>
128-
<area shape="rect" title=" " alt="" coords="3037,401,3096,427"/>
129-
<area shape="rect" href="WaveformArea_8h.html" title="Declaration of WaveformArea." alt="" coords="3229,244,3361,271"/>
130-
<area shape="rect" href="Bijection_8h.html" title="Declaration of Bijection." alt="" coords="3976,244,4067,271"/>
131-
<area shape="rect" title=" " alt="" coords="4091,244,4245,271"/>
132-
<area shape="rect" title=" " alt="" coords="4270,244,4482,271"/>
133-
<area shape="rect" title=" " alt="" coords="3765,244,3841,271"/>
134-
<area shape="rect" title=" " alt="" coords="3865,244,3951,271"/>
85+
<area shape="rect" title="Implementation of AboutDialog." alt="" coords="3022,5,3269,32"/>
86+
<area shape="rect" href="ngscopeclient_8h_source.html" title=" " alt="" coords="1147,229,1271,256"/>
87+
<area shape="rect" href="AboutDialog_8h.html" title="Declaration of AboutDialog." alt="" coords="2209,80,2324,107"/>
88+
<area shape="rect" href="MainWindow_8h.html" title="Declaration of MainWindow." alt="" coords="3087,80,3204,107"/>
89+
<area shape="rect" title=" " alt="" coords="3229,80,3406,107"/>
90+
<area shape="rect" title=" " alt="" coords="3431,80,3577,107"/>
91+
<area shape="rect" title=" " alt="" coords="1905,311,2071,338"/>
92+
<area shape="rect" title=" " alt="" coords="2096,311,2208,338"/>
93+
<area shape="rect" title=" " alt="" coords="1707,393,1778,420"/>
94+
<area shape="rect" title=" " alt="" coords="5,311,181,338"/>
95+
<area shape="rect" title=" " alt="" coords="205,304,365,345"/>
96+
<area shape="rect" title=" " alt="" coords="389,304,549,345"/>
97+
<area shape="rect" href="ImGuiDisabler_8h_source.html" title=" " alt="" coords="574,311,701,338"/>
98+
<area shape="rect" title=" " alt="" coords="776,311,843,338"/>
99+
<area shape="rect" title=" " alt="" coords="867,311,981,338"/>
100+
<area shape="rect" href="BERTState_8h.html" title="Declaration of BERTState." alt="" coords="1006,311,1109,338"/>
101+
<area shape="rect" href="PowerSupplyState_8h.html" title="Declaration of PowerSupplyState." alt="" coords="1133,311,1285,338"/>
102+
<area shape="rect" href="FunctionGeneratorState_8h.html" title="Declaration of FunctionGeneratorState." alt="" coords="1310,311,1498,338"/>
103+
<area shape="rect" href="MultimeterState_8h.html" title="Declaration of MultimeterState." alt="" coords="1522,311,1662,338"/>
104+
<area shape="rect" href="LoadState_8h.html" title="Declaration of LoadState." alt="" coords="1687,311,1785,338"/>
105+
<area shape="rect" href="GuiLogSink_8h.html" title="Declaration of GuiLogSink." alt="" coords="2232,311,2339,338"/>
106+
<area shape="rect" href="Event_8h_source.html" title=" " alt="" coords="1810,311,1881,338"/>
107+
<area shape="rect" href="Marker_8h.html" title="Declaration of Marker." alt="" coords="3195,393,3274,420"/>
108+
<area shape="rect" href="Dialog_8h.html" title="Declaration of Dialog." alt="" coords="2479,229,2555,256"/>
109+
<area shape="rect" title=" " alt="" coords="2363,311,2477,338"/>
110+
<area shape="rect" href="Session_8h.html" title="Declaration of Session." alt="" coords="3038,229,3122,256"/>
111+
<area shape="rect" href="FontManager_8h.html" title="Declaration of FontManager." alt="" coords="3646,155,3765,181"/>
112+
<area shape="rect" href="TextureManager_8h.html" title="Declaration of TextureManager." alt="" coords="3489,311,3628,338"/>
113+
<area shape="rect" href="VulkanWindow_8h.html" title="Declaration of VulkanWindow." alt="" coords="3788,155,3919,181"/>
114+
<area shape="rect" href="WaveformGroup_8h.html" title="Declaration of WaveformGroup." alt="" coords="3429,155,3571,181"/>
115+
<area shape="rect" href="FilterGraphEditor_8h.html" title="Declaration of FilterGraphEditor." alt="" coords="3943,155,4086,181"/>
116+
<area shape="rect" href="ManageInstrumentsDialog_8h.html" title="Declaration of ManageInstrumentsDialog." alt="" coords="2555,155,2762,181"/>
117+
<area shape="rect" href="ProtocolAnalyzerDialog_8h.html" title="Declaration of ProtocolAnalyzerDialog." alt="" coords="2987,155,3173,181"/>
118+
<area shape="rect" title=" " alt="" coords="3208,229,3413,256"/>
119+
<area shape="rect" href="StreamBrowserDialog_8h.html" title="Declaration of StreamBrowserDialog." alt="" coords="2787,155,2963,181"/>
120+
<area shape="rect" href="TimebasePropertiesDialog_8h.html" title="Declaration of TimebasePropertiesDialog." alt="" coords="2064,155,2269,181"/>
121+
<area shape="rect" href="TriggerPropertiesDialog_8h.html" title="Declaration of TriggerPropertiesDialog." alt="" coords="2293,155,2480,181"/>
122+
<area shape="rect" href="Workspace_8h.html" title="Declaration of Workspace." alt="" coords="3248,155,3355,181"/>
123+
<area shape="rect" title=" " alt="" coords="2850,311,3001,338"/>
124+
<area shape="rect" href="HistoryManager_8h.html" title="Declaration of HistoryManager." alt="" coords="2501,311,2640,338"/>
125+
<area shape="rect" href="PacketManager_8h.html" title="Declaration of PacketManager." alt="" coords="3167,311,3302,338"/>
126+
<area shape="rect" href="PreferenceManager_8h.html" title="Stores and manages preference values." alt="" coords="2665,311,2826,338"/>
127+
<area shape="rect" href="TriggerGroup_8h.html" title="Declaration of TriggerGroup." alt="" coords="3025,311,3143,338"/>
128+
<area shape="rect" title=" " alt="" coords="3416,393,3467,420"/>
129+
<area shape="rect" href="WaveformArea_8h.html" title="Declaration of WaveformArea." alt="" coords="3438,229,3570,256"/>
130+
<area shape="rect" href="Bijection_8h.html" title="Declaration of Bijection." alt="" coords="3823,229,3913,256"/>
131+
<area shape="rect" title=" " alt="" coords="3937,229,4092,256"/>
132+
<area shape="rect" title=" " alt="" coords="4117,229,4329,256"/>
133+
<area shape="rect" title=" " alt="" coords="4353,229,4429,256"/>
134+
<area shape="rect" title=" " alt="" coords="3711,229,3798,256"/>
135135
</map>
136136
</div>
137137
</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

0 commit comments

Comments
 (0)