Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
timschwartz committed Nov 25, 2018
1 parent cc55ff9 commit 1832c41
Show file tree
Hide file tree
Showing 67 changed files with 3,009 additions and 1,163 deletions.
2 changes: 1 addition & 1 deletion docs/_r_e_a_d_m_e_8md_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="title">README.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="_r_e_a_d_m_e_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;# crazines</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;Nintendo emulator</div></div><!-- fragment --></div><!-- contents -->
<a href="_r_e_a_d_m_e_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;# craziNES</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;Nintendo emulator</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;## Documentation</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;https://timschwartz.github.io/craziNES/</div></div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
Expand Down
10 changes: 5 additions & 5 deletions docs/class_main_window.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/class_memory_window.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classnes_1_1_mapper.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae40df7de3483c59d00186a2f

<p class="reference">References <a class="el" href="mapper_8h_source.html#l00012">nes::memory_section::addr</a>, <a class="el" href="classnes_1_1_mapper.html#aecfbac80aec4b7c59b9101a1ce88fc01">get_section()</a>, <a class="el" href="mapper_8h_source.html#l00013">nes::memory_section::offset</a>, <a class="el" href="mapper_8h_source.html#l00014">nes::memory_section::ptr</a>, and <a class="el" href="mapper_8h_source.html#l00016">nes::memory_section::read_handler</a>.</p>

<p class="reference">Referenced by <a class="el" href="cpu__6502_8cpp_source.html#l00269">nes::cpu_6502::and_ind_x()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00285">nes::cpu_6502::bit_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00152">nes::cpu_6502::brk()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00732">nes::cpu_6502::dec_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00694">nes::cpu_6502::dec_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00622">nes::cpu_6502::lda_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00670">nes::cpu_6502::lda_abs_x()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00588">nes::cpu_6502::lda_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00650">nes::cpu_6502::lda_zp_x()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00600">nes::cpu_6502::ldx_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00911">nes::cpu_6502::load_rom()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00136">nes::cpu_6502::nmi()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00966">nes::opcode_t::opcode_t()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00042">nes::cpu_6502::pop8()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00213">nes::cpu_6502::slo_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00172">nes::cpu_6502::slo_zp()</a>, and <a class="el" href="cpu__6502_8cpp_source.html#l00546">nes::cpu_6502::sta_ind_y()</a>.</p>
<p class="reference">Referenced by <a class="el" href="cpu__6502_8cpp_source.html#l00269">nes::cpu_6502::and_ind_x()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00285">nes::cpu_6502::bit_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00152">nes::cpu_6502::brk()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00694">nes::cpu_6502::cmp_ind_x()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00750">nes::cpu_6502::dec_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00712">nes::cpu_6502::dec_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00622">nes::cpu_6502::lda_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00670">nes::cpu_6502::lda_abs_x()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00588">nes::cpu_6502::lda_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00650">nes::cpu_6502::lda_zp_x()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00600">nes::cpu_6502::ldx_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00930">nes::cpu_6502::load_rom()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00136">nes::cpu_6502::nmi()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00985">nes::opcode_t::opcode_t()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00042">nes::cpu_6502::pop8()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00213">nes::cpu_6502::slo_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00172">nes::cpu_6502::slo_zp()</a>, and <a class="el" href="cpu__6502_8cpp_source.html#l00546">nes::cpu_6502::sta_ind_y()</a>.</p>
<div class="fragment"><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; {</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <a class="code" href="namespacenes.html#ad9986ccb3b7e5aed6ba3c62ac4a48a97">memory_section</a> s;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="keywordflow">try</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; s = <a class="code" href="classnes_1_1_mapper.html#aecfbac80aec4b7c59b9101a1ce88fc01">get_section</a>(addr);</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; }</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keywordflow">catch</span>(std::string e)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordflow">throw</span> e;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; }</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keywordflow">if</span>(s.read_handler != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; uint8_t result;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordflow">try</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; result = s.read_handler(s.ptr, addr);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">catch</span>(std::string e)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">throw</span> e;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; }</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; uint8_t *p = (uint8_t *)s.ptr;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">return</span> p[s.addr - s.offset];</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; }</div><div class="ttc" id="namespacenes_html_ad9986ccb3b7e5aed6ba3c62ac4a48a97"><div class="ttname"><a href="namespacenes.html#ad9986ccb3b7e5aed6ba3c62ac4a48a97">nes::memory_section</a></div><div class="ttdeci">struct nes::memory_section memory_section</div></div>
<div class="ttc" id="classnes_1_1_mapper_html_aecfbac80aec4b7c59b9101a1ce88fc01"><div class="ttname"><a href="classnes_1_1_mapper.html#aecfbac80aec4b7c59b9101a1ce88fc01">nes::Mapper::get_section</a></div><div class="ttdeci">virtual memory_section get_section(uint16_t addr)=0</div></div>
</div><!-- fragment -->
Expand Down Expand Up @@ -191,7 +191,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9ad35fb6085bb493a89c5fca

<p class="reference">References <a class="el" href="mapper_8h_source.html#l00012">nes::memory_section::addr</a>, <a class="el" href="classnes_1_1_mapper.html#aecfbac80aec4b7c59b9101a1ce88fc01">get_section()</a>, <a class="el" href="mapper_8h_source.html#l00013">nes::memory_section::offset</a>, <a class="el" href="mapper_8h_source.html#l00014">nes::memory_section::ptr</a>, and <a class="el" href="mapper_8h_source.html#l00015">nes::memory_section::write_handler</a>.</p>

<p class="reference">Referenced by <a class="el" href="cpu__6502_8cpp_source.html#l00732">nes::cpu_6502::dec_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00694">nes::cpu_6502::dec_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00035">nes::cpu_6502::push8()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00213">nes::cpu_6502::slo_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00172">nes::cpu_6502::slo_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00513">nes::cpu_6502::sta_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00546">nes::cpu_6502::sta_ind_y()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00484">nes::cpu_6502::sta_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00521">nes::cpu_6502::stx_abs()</a>, and <a class="el" href="cpu__6502_8cpp_source.html#l00493">nes::cpu_6502::stx_zp()</a>.</p>
<p class="reference">Referenced by <a class="el" href="cpu__6502_8cpp_source.html#l00750">nes::cpu_6502::dec_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00712">nes::cpu_6502::dec_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00035">nes::cpu_6502::push8()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00213">nes::cpu_6502::slo_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00172">nes::cpu_6502::slo_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00513">nes::cpu_6502::sta_abs()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00546">nes::cpu_6502::sta_ind_y()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00484">nes::cpu_6502::sta_zp()</a>, <a class="el" href="cpu__6502_8cpp_source.html#l00521">nes::cpu_6502::stx_abs()</a>, and <a class="el" href="cpu__6502_8cpp_source.html#l00493">nes::cpu_6502::stx_zp()</a>.</p>
<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="structnes_1_1memory__section.html">nes::memory_section</a> s;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">try</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; s = <a class="code" href="classnes_1_1_mapper.html#aecfbac80aec4b7c59b9101a1ce88fc01">get_section</a>(addr);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">catch</span>(std::string e)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">throw</span> e;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">if</span>(s.<a class="code" href="structnes_1_1memory__section.html#a01a4145775b18acafa4dcc6d18c9caf3">write_handler</a> != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">try</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; s.<a class="code" href="structnes_1_1memory__section.html#a01a4145775b18acafa4dcc6d18c9caf3">write_handler</a>(s.<a class="code" href="structnes_1_1memory__section.html#a670affcc954678f783010ac09b78fa30">ptr</a>, addr, value);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">catch</span>(std::string e)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">throw</span> e;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordflow">return</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint8_t *p = (uint8_t *)s.<a class="code" href="structnes_1_1memory__section.html#a670affcc954678f783010ac09b78fa30">ptr</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; p[s.<a class="code" href="structnes_1_1memory__section.html#adf95ead77e708b0ed06da403d11fd0fc">addr</a> - s.<a class="code" href="structnes_1_1memory__section.html#a15cc5e7acbf5c6508576c46946198239">offset</a>] = value;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div><div class="ttc" id="structnes_1_1memory__section_html_a15cc5e7acbf5c6508576c46946198239"><div class="ttname"><a href="structnes_1_1memory__section.html#a15cc5e7acbf5c6508576c46946198239">nes::memory_section::offset</a></div><div class="ttdeci">uint16_t offset</div><div class="ttdef"><b>Definition:</b> <a href="mapper_8h_source.html#l00013">mapper.h:13</a></div></div>
<div class="ttc" id="structnes_1_1memory__section_html_adf95ead77e708b0ed06da403d11fd0fc"><div class="ttname"><a href="structnes_1_1memory__section.html#adf95ead77e708b0ed06da403d11fd0fc">nes::memory_section::addr</a></div><div class="ttdeci">uint16_t addr</div><div class="ttdef"><b>Definition:</b> <a href="mapper_8h_source.html#l00012">mapper.h:12</a></div></div>
<div class="ttc" id="structnes_1_1memory__section_html_a01a4145775b18acafa4dcc6d18c9caf3"><div class="ttname"><a href="structnes_1_1memory__section.html#a01a4145775b18acafa4dcc6d18c9caf3">nes::memory_section::write_handler</a></div><div class="ttdeci">void(* write_handler)(void *, uint16_t, uint8_t)</div><div class="ttdef"><b>Definition:</b> <a href="mapper_8h_source.html#l00015">mapper.h:15</a></div></div>
Expand Down
Loading

0 comments on commit 1832c41

Please sign in to comment.