Skip to content

Commit

Permalink
docs: Update Doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 11, 2024
1 parent fcfa4f3 commit 39684bd
Show file tree
Hide file tree
Showing 23 changed files with 623 additions and 415 deletions.
Binary file added html/ConnectDriveToSubnet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/CreateScreenFromMastercopy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/GetOrCreateSubnet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion html/_general_support_8cs_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> }</div>
</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>}</div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m_html"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m.html">MAC_use_cases.Model.MAC_use_casesEM</a></div><div class="ttdoc">This is the main class in which the workflow starts. Here are all sections for creating or generating...</div><div class="ttdef"><b>Definition</b> <a href="_m_a_c__use__cases_e_m_8cs_source.html#l00020">MAC_use_casesEM.cs:21</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m_html"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m.html">MAC_use_cases.Model.MAC_use_casesEM</a></div><div class="ttdoc">This is the main class in which the workflow starts. Here are all sections for creating or generating...</div><div class="ttdef"><b>Definition</b> <a href="_m_a_c__use__cases_e_m_8cs_source.html#l00021">MAC_use_casesEM.cs:22</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_general_support_html"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_general_support.html">MAC_use_cases.Model.UseCases.GeneralSupport</a></div><div class="ttdoc">This are functions that support you in different ways while using Modular Application Creator.</div><div class="ttdef"><b>Definition</b> <a href="#l00016">GeneralSupport.cs:17</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_general_support_html_a26744e8ae9a7e1ca4b4dd4156f480219"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_general_support.html#a26744e8ae9a7e1ca4b4dd4156f480219">MAC_use_cases.Model.UseCases.GeneralSupport.GetOpennessDeviceItem</a></div><div class="ttdeci">static Siemens.Engineering.HW.DeviceItem GetOpennessDeviceItem(Siemens.Automation.ModularApplicationCreator.Tia.Openness.Device device)</div><div class="ttdoc">This call returns the openness object of the TIA Portal project CPU.</div><div class="ttdef"><b>Definition</b> <a href="#l00034">GeneralSupport.cs:34</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_general_support_html_a3f2fea29eb28d484b25b0d1999eacf11"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_general_support.html#a3f2fea29eb28d484b25b0d1999eacf11">MAC_use_cases.Model.UseCases.GeneralSupport.GetOpennessProject</a></div><div class="ttdeci">static Siemens.Engineering.Project GetOpennessProject(Siemens.Automation.ModularApplicationCreator.Tia.Openness.Project tiaProject)</div><div class="ttdoc">This call returns the openness object of the TIA Portal project.</div><div class="ttdef"><b>Definition</b> <a href="#l00048">GeneralSupport.cs:48</a></div></div>
Expand Down
2 changes: 1 addition & 1 deletion html/_generic_block_creation_8cs_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span> }</div>
</div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span>}</div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m_html"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m.html">MAC_use_cases.Model.MAC_use_casesEM</a></div><div class="ttdoc">This is the main class in which the workflow starts. Here are all sections for creating or generating...</div><div class="ttdef"><b>Definition</b> <a href="_m_a_c__use__cases_e_m_8cs_source.html#l00020">MAC_use_casesEM.cs:21</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m_html"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_m_a_c__use__cases_e_m.html">MAC_use_cases.Model.MAC_use_casesEM</a></div><div class="ttdoc">This is the main class in which the workflow starts. Here are all sections for creating or generating...</div><div class="ttdef"><b>Definition</b> <a href="_m_a_c__use__cases_e_m_8cs_source.html#l00021">MAC_use_casesEM.cs:22</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_generic_block_creation_html"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_generic_block_creation.html">MAC_use_cases.Model.UseCases.GenericBlockCreation</a></div><div class="ttdoc">All the functions to configure and generate Blocks are defined here.</div><div class="ttdef"><b>Definition</b> <a href="#l00017">GenericBlockCreation.cs:18</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_generic_block_creation_html_a04bfdaf6684648c9f6f02aa8203c364d"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_generic_block_creation.html#a04bfdaf6684648c9f6f02aa8203c364d">MAC_use_cases.Model.UseCases.GenericBlockCreation.AddCodeBlockToOB</a></div><div class="ttdeci">static void AddCodeBlockToOB(XmlLogicalBlock codeBlock, ResourceManagement resourceManagement, string languagesettings, PlcDevice plcDevice)</div><div class="ttdoc">This function checks if OB is already in TIA Project and merge the new one into the existing one depe...</div><div class="ttdef"><b>Definition</b> <a href="#l00235">GenericBlockCreation.cs:235</a></div></div>
<div class="ttc" id="aclass_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_generic_block_creation_html_a06b0a6a47508b5048cdcbdd56c46c591"><div class="ttname"><a href="class_m_a_c__use__cases_1_1_model_1_1_use_cases_1_1_generic_block_creation.html#a06b0a6a47508b5048cdcbdd56c46c591">MAC_use_cases.Model.UseCases.GenericBlockCreation.dataType</a></div><div class="ttdeci">static string dataType</div><div class="ttdoc">This is the name of the generated datatype.</div><div class="ttdef"><b>Definition</b> <a href="#l00030">GenericBlockCreation.cs:30</a></div></div>
Expand Down
Loading

0 comments on commit 39684bd

Please sign in to comment.