Add libhal-arm-mcu main API documentation

Author: libhal-bot

libhal-arm-mcu/main/.doctrees/cortex_m/interrupt.doctree

@@ -555,7 +555,7 @@ <h2>NVIC (Nested Vector Interrupt Controller)<a class="headerlink" href="#nvic-n
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N3hal8cortex_m29revert_interrupt_vector_tableEv">
 <span id="_CPPv3N3hal8cortex_m29revert_interrupt_vector_tableEv"></span><span id="_CPPv2N3hal8cortex_m29revert_interrupt_vector_tableEv"></span><span id="hal::cortex_m::revert_interrupt_vector_table"></span><span class="target" id="namespacehal_1_1cortex__m_1a947c5affbc17522beb2ed778d9cfe903"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">revert_interrupt_vector_table</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3hal8cortex_m29revert_interrupt_vector_tableEv" title="Link to this definition">#</a><br /></dt>
-<dd><p>Sets the interrupt vector table back to a form where it can be initialized again(). </p>
+<dd><p>Sets the interrupt vector table back to a form where it can be initialized <a class="reference internal" href="system_control.html#namespacehal_1_1cortex__m_1a1f0421e03f922c823364d51f5decea5c"><span class="std std-ref">again()</span></a>. </p>
 <p>Recommended to never call this function in your application. If it is called, it should be well documented why this choice was necessary.</p>
 <p>Will clear all pending interrupts and sets the internal state to uninitialized. This call is dangerous and should only be done before any drivers depend on their interrupts to function. </p>
 </dd></dl>
@@ -783,7 +783,7 @@ <h2>NVIC (Nested Vector Interrupt Controller)<a class="headerlink" href="#nvic-n
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N3hal8cortex_m23initialize_data_sectionEv">
 <span id="_CPPv3N3hal8cortex_m23initialize_data_sectionEv"></span><span id="_CPPv2N3hal8cortex_m23initialize_data_sectionEv"></span><span id="hal::cortex_m::initialize_data_section"></span><span class="target" id="namespacehal_1_1cortex__m_1afac39d4a10412fa8f81c53511e4759ed"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">initialize_data_section</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3hal8cortex_m23initialize_data_sectionEv" title="Link to this definition">#</a><br /></dt>
-<dd><p>Initialize the data section of RAM. This should be the first thing called in main() before using any global or statically allocated variables. It can also be called in the startup code before main is called. This is not done by crt0.s (C runtime startup code) because with an OS, when the executable is copied to RAM, the data section is also copied and those same locations can be reused for the application, removing the need to copy the data section. This will also happen if one loads an elf file to an MCU using a debugger. Typically the RAM section, but not BSS, is copied over. But in the case of the MCU without a debugger, the MCU will have to manage coping the contents from ROM to RAM itself. Systems should always assume they haven’t been loaded by any means and should set the data section at the start of the application. </p>
+<dd><p>Initialize the data section of RAM. This should be the first thing called in <a class="reference internal" href="system_control.html#namespacehal_1_1cortex__m_1a1f0421e03f922c823364d51f5decea5c"><span class="std std-ref">main()</span></a> before using any global or statically allocated variables. It can also be called in the startup code before main is called. This is not done by crt0.s (C runtime startup code) because with an OS, when the executable is copied to RAM, the data section is also copied and those same locations can be reused for the application, removing the need to copy the data section. This will also happen if one loads an elf file to an MCU using a debugger. Typically the RAM section, but not BSS, is copied over. But in the case of the MCU without a debugger, the MCU will have to manage coping the contents from ROM to RAM itself. Systems should always assume they haven’t been loaded by any means and should set the data section at the start of the application. </p>
 </dd></dl>
 
 <dl class="cpp function">

libhal-arm-mcu/main/.doctrees/cortex_m/startup.doctree

@@ -555,7 +555,7 @@ <h2>ARM Cortex-M Startup Utilities<a class="headerlink" href="#arm-cortex-m-star
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N3hal8cortex_m29revert_interrupt_vector_tableEv">
 <span id="_CPPv3N3hal8cortex_m29revert_interrupt_vector_tableEv"></span><span id="_CPPv2N3hal8cortex_m29revert_interrupt_vector_tableEv"></span><span id="hal::cortex_m::revert_interrupt_vector_table"></span><span class="target" id="namespacehal_1_1cortex__m_1a947c5affbc17522beb2ed778d9cfe903"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">revert_interrupt_vector_table</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
-<dd><p>Sets the interrupt vector table back to a form where it can be initialized again(). </p>
+<dd><p>Sets the interrupt vector table back to a form where it can be initialized <a class="reference internal" href="system_control.html#namespacehal_1_1cortex__m_1a1f0421e03f922c823364d51f5decea5c"><span class="std std-ref">again()</span></a>. </p>
 <p>Recommended to never call this function in your application. If it is called, it should be well documented why this choice was necessary.</p>
 <p>Will clear all pending interrupts and sets the internal state to uninitialized. This call is dangerous and should only be done before any drivers depend on their interrupts to function. </p>
 </dd></dl>
@@ -783,7 +783,7 @@ <h2>ARM Cortex-M Startup Utilities<a class="headerlink" href="#arm-cortex-m-star
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N3hal8cortex_m23initialize_data_sectionEv">
 <span id="_CPPv3N3hal8cortex_m23initialize_data_sectionEv"></span><span id="_CPPv2N3hal8cortex_m23initialize_data_sectionEv"></span><span id="hal::cortex_m::initialize_data_section"></span><span class="target" id="namespacehal_1_1cortex__m_1afac39d4a10412fa8f81c53511e4759ed"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">initialize_data_section</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
-<dd><p>Initialize the data section of RAM. This should be the first thing called in main() before using any global or statically allocated variables. It can also be called in the startup code before main is called. This is not done by crt0.s (C runtime startup code) because with an OS, when the executable is copied to RAM, the data section is also copied and those same locations can be reused for the application, removing the need to copy the data section. This will also happen if one loads an elf file to an MCU using a debugger. Typically the RAM section, but not BSS, is copied over. But in the case of the MCU without a debugger, the MCU will have to manage coping the contents from ROM to RAM itself. Systems should always assume they haven’t been loaded by any means and should set the data section at the start of the application. </p>
+<dd><p>Initialize the data section of RAM. This should be the first thing called in <a class="reference internal" href="system_control.html#namespacehal_1_1cortex__m_1a1f0421e03f922c823364d51f5decea5c"><span class="std std-ref">main()</span></a> before using any global or statically allocated variables. It can also be called in the startup code before main is called. This is not done by crt0.s (C runtime startup code) because with an OS, when the executable is copied to RAM, the data section is also copied and those same locations can be reused for the application, removing the need to copy the data section. This will also happen if one loads an elf file to an MCU using a debugger. Typically the RAM section, but not BSS, is copied over. But in the case of the MCU without a debugger, the MCU will have to manage coping the contents from ROM to RAM itself. Systems should always assume they haven’t been loaded by any means and should set the data section at the start of the application. </p>
 </dd></dl>
 
 <dl class="cpp function">

libhal-arm-mcu/main/.doctrees/cortex_m/system_control.doctree

@@ -555,7 +555,7 @@ <h2>ARM Cortex-M System Control Functions<a class="headerlink" href="#arm-cortex
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N3hal8cortex_m29revert_interrupt_vector_tableEv">
 <span id="_CPPv3N3hal8cortex_m29revert_interrupt_vector_tableEv"></span><span id="_CPPv2N3hal8cortex_m29revert_interrupt_vector_tableEv"></span><span id="hal::cortex_m::revert_interrupt_vector_table"></span><span class="target" id="namespacehal_1_1cortex__m_1a947c5affbc17522beb2ed778d9cfe903"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">revert_interrupt_vector_table</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
-<dd><p>Sets the interrupt vector table back to a form where it can be initialized again(). </p>
+<dd><p>Sets the interrupt vector table back to a form where it can be initialized <a class="reference internal" href="#namespacehal_1_1cortex__m_1a1f0421e03f922c823364d51f5decea5c"><span class="std std-ref">again()</span></a>. </p>
 <p>Recommended to never call this function in your application. If it is called, it should be well documented why this choice was necessary.</p>
 <p>Will clear all pending interrupts and sets the internal state to uninitialized. This call is dangerous and should only be done before any drivers depend on their interrupts to function. </p>
 </dd></dl>
@@ -783,7 +783,7 @@ <h2>ARM Cortex-M System Control Functions<a class="headerlink" href="#arm-cortex
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N3hal8cortex_m23initialize_data_sectionEv">
 <span id="_CPPv3N3hal8cortex_m23initialize_data_sectionEv"></span><span id="_CPPv2N3hal8cortex_m23initialize_data_sectionEv"></span><span id="hal::cortex_m::initialize_data_section"></span><span class="target" id="namespacehal_1_1cortex__m_1afac39d4a10412fa8f81c53511e4759ed"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">initialize_data_section</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
-<dd><p>Initialize the data section of RAM. This should be the first thing called in main() before using any global or statically allocated variables. It can also be called in the startup code before main is called. This is not done by crt0.s (C runtime startup code) because with an OS, when the executable is copied to RAM, the data section is also copied and those same locations can be reused for the application, removing the need to copy the data section. This will also happen if one loads an elf file to an MCU using a debugger. Typically the RAM section, but not BSS, is copied over. But in the case of the MCU without a debugger, the MCU will have to manage coping the contents from ROM to RAM itself. Systems should always assume they haven’t been loaded by any means and should set the data section at the start of the application. </p>
+<dd><p>Initialize the data section of RAM. This should be the first thing called in <a class="reference internal" href="#namespacehal_1_1cortex__m_1a1f0421e03f922c823364d51f5decea5c"><span class="std std-ref">main()</span></a> before using any global or statically allocated variables. It can also be called in the startup code before main is called. This is not done by crt0.s (C runtime startup code) because with an OS, when the executable is copied to RAM, the data section is also copied and those same locations can be reused for the application, removing the need to copy the data section. This will also happen if one loads an elf file to an MCU using a debugger. Typically the RAM section, but not BSS, is copied over. But in the case of the MCU without a debugger, the MCU will have to manage coping the contents from ROM to RAM itself. Systems should always assume they haven’t been loaded by any means and should set the data section at the start of the application. </p>
 </dd></dl>
 
 <dl class="cpp function">