Update docs

BinaryMelodies · Jan 9, 2025 · 12339fd · 12339fd
1 parent cd5d531
commit 12339fd
Show file tree

Hide file tree

Showing 35 changed files with 426 additions and 758 deletions.
diff --git a/docs/aout_8h_source.html b/docs/aout_8h_source.html
@@ -180,7 +180,7 @@
 <div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>        <span class="comment">/* * * Reader * * */</span></div>
 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span> </div>
 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>    <span class="keyword">private</span>:</div>
-<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>        <span class="keywordtype">void</span> GenerateModule(<a class="code hl_class" href="classLinker_1_1Module.html">Linker::Module</a>&amp; module);</div>
+<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>        <span class="keywordtype">void</span> GenerateModule(<a class="code hl_class" href="classLinker_1_1Module.html">Linker::Module</a>&amp; module) <span class="keyword">const</span>;</div>
 <div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span> </div>
 <div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>    <span class="keyword">public</span>:</div>
 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>        <span class="keywordtype">void</span> <a class="code hl_function" href="classAOut_1_1AOutFormat.html#a0323a0b83974707ef47894364c211d7d">ProduceModule</a>(<a class="code hl_class" href="classLinker_1_1Module.html">Linker::Module</a>&amp; module, <a class="code hl_class" href="classLinker_1_1Reader.html">Linker::Reader</a>&amp; rd) <span class="keyword">override</span>;</div>
@@ -236,16 +236,16 @@
 <div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="preprocessor">#endif </span><span class="comment">/* AOUT_H */</span><span class="preprocessor"></span></div>
 <div class="ttc" id="aclassAOut_1_1AOutFormat_1_1Symbol_html"><div class="ttname"><a href="classAOut_1_1AOutFormat_1_1Symbol.html">AOut::AOutFormat::Symbol</a></div><div class="ttdef"><b>Definition</b> aout.h:99</div></div>
 <div class="ttc" id="aclassAOut_1_1AOutFormat_html"><div class="ttname"><a href="classAOut_1_1AOutFormat.html">AOut::AOutFormat</a></div><div class="ttdoc">UNIX/Linux a.out binary file format.</div><div class="ttdef"><b>Definition</b> aout.h:48</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_a0323a0b83974707ef47894364c211d7d"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#a0323a0b83974707ef47894364c211d7d">AOut::AOutFormat::ProduceModule</a></div><div class="ttdeci">void ProduceModule(Linker::Module &amp;module, Linker::Reader &amp;rd) override</div><div class="ttdoc">Reads a file and loads the information into a module object.</div><div class="ttdef"><b>Definition</b> aout.cc:561</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_a4627671f6e551bf3926f244e15f4d235"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#a4627671f6e551bf3926f244e15f4d235">AOut::AOutFormat::WriteFile</a></div><div class="ttdeci">void WriteFile(Linker::Writer &amp;wr) override</div><div class="ttdoc">Stores data in memory to file.</div><div class="ttdef"><b>Definition</b> aout.cc:342</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_a996500d4592ef3fa0b7eed7b1ecb4c98"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#a996500d4592ef3fa0b7eed7b1ecb4c98">AOut::AOutFormat::GetDefaultExtension</a></div><div class="ttdeci">std::string GetDefaultExtension(Linker::Module &amp;module, std::string filename) override</div><div class="ttdoc">Appends a default extension to the filename.</div><div class="ttdef"><b>Definition</b> aout.cc:827</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_ab38bee6d4299b0005cad181172ede2c3"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#ab38bee6d4299b0005cad181172ede2c3">AOut::AOutFormat::GetDefaultMagic</a></div><div class="ttdeci">static magic_type GetDefaultMagic(system_type system)</div><div class="ttdoc">Default magic number associated with the system.</div><div class="ttdef"><b>Definition</b> aout.cc:582</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_ab5bea1d84db8cfeebad9fbfb807f6af7"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#ab5bea1d84db8cfeebad9fbfb807f6af7">AOut::AOutFormat::ProcessModule</a></div><div class="ttdeci">void ProcessModule(Linker::Module &amp;module) override</div><div class="ttdoc">Processes the module object and initializes format fields.</div><div class="ttdef"><b>Definition</b> aout.cc:695</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_aba95a501b20d3244db008021ac058944"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#aba95a501b20d3244db008021ac058944">AOut::AOutFormat::SetOptions</a></div><div class="ttdeci">void SetOptions(std::map&lt; std::string, std::string &gt; &amp;options) override</div><div class="ttdoc">Passes command line parameters as settings over to format object.</div><div class="ttdef"><b>Definition</b> aout.cc:594</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_ac63886fecdf1c9adf140a637fea08e47"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#ac63886fecdf1c9adf140a637fea08e47">AOut::AOutFormat::CalculateValues</a></div><div class="ttdeci">void CalculateValues() override</div><div class="ttdoc">Intermediate step between processing module and generating output file to set up headers and manageme...</div><div class="ttdef"><b>Definition</b> aout.cc:798</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_a0323a0b83974707ef47894364c211d7d"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#a0323a0b83974707ef47894364c211d7d">AOut::AOutFormat::ProduceModule</a></div><div class="ttdeci">void ProduceModule(Linker::Module &amp;module, Linker::Reader &amp;rd) override</div><div class="ttdoc">Reads a file and loads the information into a module object.</div><div class="ttdef"><b>Definition</b> aout.cc:559</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_a4627671f6e551bf3926f244e15f4d235"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#a4627671f6e551bf3926f244e15f4d235">AOut::AOutFormat::WriteFile</a></div><div class="ttdeci">void WriteFile(Linker::Writer &amp;wr) override</div><div class="ttdoc">Stores data in memory to file.</div><div class="ttdef"><b>Definition</b> aout.cc:345</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_a996500d4592ef3fa0b7eed7b1ecb4c98"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#a996500d4592ef3fa0b7eed7b1ecb4c98">AOut::AOutFormat::GetDefaultExtension</a></div><div class="ttdeci">std::string GetDefaultExtension(Linker::Module &amp;module, std::string filename) override</div><div class="ttdoc">Appends a default extension to the filename.</div><div class="ttdef"><b>Definition</b> aout.cc:825</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_ab38bee6d4299b0005cad181172ede2c3"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#ab38bee6d4299b0005cad181172ede2c3">AOut::AOutFormat::GetDefaultMagic</a></div><div class="ttdeci">static magic_type GetDefaultMagic(system_type system)</div><div class="ttdoc">Default magic number associated with the system.</div><div class="ttdef"><b>Definition</b> aout.cc:580</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_ab5bea1d84db8cfeebad9fbfb807f6af7"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#ab5bea1d84db8cfeebad9fbfb807f6af7">AOut::AOutFormat::ProcessModule</a></div><div class="ttdeci">void ProcessModule(Linker::Module &amp;module) override</div><div class="ttdoc">Processes the module object and initializes format fields.</div><div class="ttdef"><b>Definition</b> aout.cc:693</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_aba95a501b20d3244db008021ac058944"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#aba95a501b20d3244db008021ac058944">AOut::AOutFormat::SetOptions</a></div><div class="ttdeci">void SetOptions(std::map&lt; std::string, std::string &gt; &amp;options) override</div><div class="ttdoc">Passes command line parameters as settings over to format object.</div><div class="ttdef"><b>Definition</b> aout.cc:592</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_ac63886fecdf1c9adf140a637fea08e47"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#ac63886fecdf1c9adf140a637fea08e47">AOut::AOutFormat::CalculateValues</a></div><div class="ttdeci">void CalculateValues() override</div><div class="ttdoc">Intermediate step between processing module and generating output file to set up headers and manageme...</div><div class="ttdef"><b>Definition</b> aout.cc:796</div></div>
 <div class="ttc" id="aclassAOut_1_1AOutFormat_html_aeaf8a3d71f995d4c83b6451d234628c1"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#aeaf8a3d71f995d4c83b6451d234628c1">AOut::AOutFormat::ReadFile</a></div><div class="ttdeci">void ReadFile(Linker::Reader &amp;rd) override</div><div class="ttdoc">Loads file into memory.</div><div class="ttdef"><b>Definition</b> aout.cc:145</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_aeb1902b83159431a886aeee6fbb6fc18"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#aeb1902b83159431a886aeee6fbb6fc18">AOut::AOutFormat::OnNewSegment</a></div><div class="ttdeci">void OnNewSegment(std::shared_ptr&lt; Linker::Segment &gt; segment) override</div><div class="ttdoc">Callback function when allocating a new segment When the linker script runs, it creates segments cons...</div><div class="ttdef"><b>Definition</b> aout.cc:601</div></div>
-<div class="ttc" id="aclassAOut_1_1AOutFormat_html_aeb2dca4af06fc91eee3b0ec541a7c2e9"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#aeb2dca4af06fc91eee3b0ec541a7c2e9">AOut::AOutFormat::GenerateFile</a></div><div class="ttdeci">void GenerateFile(std::string filename, Linker::Module &amp;module) override</div><div class="ttdoc">The main function that handles processing, calculating and generating the final image.</div><div class="ttdef"><b>Definition</b> aout.cc:810</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_aeb1902b83159431a886aeee6fbb6fc18"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#aeb1902b83159431a886aeee6fbb6fc18">AOut::AOutFormat::OnNewSegment</a></div><div class="ttdeci">void OnNewSegment(std::shared_ptr&lt; Linker::Segment &gt; segment) override</div><div class="ttdoc">Callback function when allocating a new segment When the linker script runs, it creates segments cons...</div><div class="ttdef"><b>Definition</b> aout.cc:599</div></div>
+<div class="ttc" id="aclassAOut_1_1AOutFormat_html_aeb2dca4af06fc91eee3b0ec541a7c2e9"><div class="ttname"><a href="classAOut_1_1AOutFormat.html#aeb2dca4af06fc91eee3b0ec541a7c2e9">AOut::AOutFormat::GenerateFile</a></div><div class="ttdeci">void GenerateFile(std::string filename, Linker::Module &amp;module) override</div><div class="ttdoc">The main function that handles processing, calculating and generating the final image.</div><div class="ttdef"><b>Definition</b> aout.cc:808</div></div>
 <div class="ttc" id="aclassLinker_1_1InputFormat_html"><div class="ttname"><a href="classLinker_1_1InputFormat.html">Linker::InputFormat</a></div><div class="ttdoc">A class that provides a general interface to loading a module.</div><div class="ttdef"><b>Definition</b> format.h:161</div></div>
 <div class="ttc" id="aclassLinker_1_1LinkerManager_html"><div class="ttname"><a href="classLinker_1_1LinkerManager.html">Linker::LinkerManager</a></div><div class="ttdoc">A helper class to collect sections into segments.</div><div class="ttdef"><b>Definition</b> linker.h:19</div></div>
 <div class="ttc" id="aclassLinker_1_1Module_html"><div class="ttname"><a href="classLinker_1_1Module.html">Linker::Module</a></div><div class="ttdoc">Encodes an object module file as a collection of sections, symbols and relocations.</div><div class="ttdef"><b>Definition</b> module.h:20</div></div>