Documentation improvements

This commit is contained in:
Wayne Venables
2025-08-26 20:47:11 -07:00
parent 4753b270f6
commit faef620629
517 changed files with 8124 additions and 4888 deletions

View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PicoVGA: src/picovga.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,7 +29,7 @@
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PicoVGA
&#160;<span id="projectnumber">1.0-cmake</span>
&#160;<span id="projectnumber">1.2-cmake</span>
</div>
<div id="projectbrief">VGA/TV display on Raspberry Pico</div>
</td>
@@ -38,10 +38,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
@@ -175,7 +175,7 @@ $(document).ready(function(){initNavTree('picovga_8h_source.html',''); initResiz
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="preprocessor">#define BIT(pos) (1UL&lt;&lt;(pos))</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="preprocessor">#define BIGINT 0x40000000 // big int value</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="preprocessor">#define BIGINT 0x40000000 </span><span class="comment">// big int value</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="preprocessor">#define _T(a) a</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
@@ -218,28 +218,26 @@ $(document).ready(function(){initNavTree('picovga_8h_source.html',''); initResiz
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="vga_8h.html">vga.h</a>&quot;</span> <span class="comment">// VGA output</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="avga__vmode_8h_html"><div class="ttname"><a href="vga__vmode_8h.html">vga_vmode.h</a></div><div class="ttdoc">VGA videomodes.</div></div>
<div class="ttc" id="avga_8h_html"><div class="ttname"><a href="vga_8h.html">vga.h</a></div><div class="ttdoc">Video/Library Initialization.</div></div>
<div class="ttc" id="aoverclock_8h_html"><div class="ttname"><a href="overclock_8h.html">overclock.h</a></div><div class="ttdoc">Overclock.</div></div>
<div class="ttc" id="avga__util_8h_html"><div class="ttname"><a href="vga__util_8h.html">vga_util.h</a></div><div class="ttdoc">VGA utilities.</div></div>
<div class="ttc" id="avga__pal_8h_html"><div class="ttname"><a href="vga__pal_8h.html">vga_pal.h</a></div><div class="ttdoc">VGA colors and palettes.</div></div>
<div class="ttc" id="aprint_8h_html"><div class="ttname"><a href="print_8h.html">print.h</a></div><div class="ttdoc">Print to attribute text buffer.</div></div>
<div class="ttc" id="acanvas_8h_html"><div class="ttname"><a href="canvas_8h.html">canvas.h</a></div><div class="ttdoc">Canvas.</div></div>
<div class="ttc" id="adefine_8h_html"><div class="ttname"><a href="define_8h.html">define.h</a></div><div class="ttdoc">VGA common definitions of C and ASM.</div></div>
<div class="ttc" id="amat2d_8h_html"><div class="ttname"><a href="mat2d_8h.html">mat2d.h</a></div><div class="ttdoc">2D Transformation Matrix</div></div>
<div class="ttc" id="aoverclock_8h_html"><div class="ttname"><a href="overclock_8h.html">overclock.h</a></div><div class="ttdoc">Overclock.</div></div>
<div class="ttc" id="aprint_8h_html"><div class="ttname"><a href="print_8h.html">print.h</a></div><div class="ttdoc">Print to attribute text buffer.</div></div>
<div class="ttc" id="apwmsnd_8h_html"><div class="ttname"><a href="pwmsnd_8h.html">pwmsnd.h</a></div><div class="ttdoc">PWM sound output.</div></div>
<div class="ttc" id="arand_8h_html"><div class="ttname"><a href="rand_8h.html">rand.h</a></div><div class="ttdoc">Random number generator.</div></div>
<div class="ttc" id="amat2d_8h_html"><div class="ttname"><a href="mat2d_8h.html">mat2d.h</a></div><div class="ttdoc">2D Transformation Matrix</div></div>
<div class="ttc" id="adefine_8h_html"><div class="ttname"><a href="define_8h.html">define.h</a></div><div class="ttdoc">VGA common definitions of C and ASM.</div></div>
<div class="ttc" id="avga__screen_8h_html"><div class="ttname"><a href="vga__screen_8h.html">vga_screen.h</a></div><div class="ttdoc">VGA screen layout.</div></div>
<div class="ttc" id="avga_8h_html"><div class="ttname"><a href="vga_8h.html">vga.h</a></div><div class="ttdoc">Video/Library Initialization.</div></div>
<div class="ttc" id="avga__layer_8h_html"><div class="ttname"><a href="vga__layer_8h.html">vga_layer.h</a></div><div class="ttdoc">VGA layers.</div></div>
<div class="ttc" id="avga__pal_8h_html"><div class="ttname"><a href="vga__pal_8h.html">vga_pal.h</a></div><div class="ttdoc">VGA colors and palettes.</div></div>
<div class="ttc" id="avga__screen_8h_html"><div class="ttname"><a href="vga__screen_8h.html">vga_screen.h</a></div><div class="ttdoc">VGA screen layout.</div></div>
<div class="ttc" id="avga__util_8h_html"><div class="ttname"><a href="vga__util_8h.html">vga_util.h</a></div><div class="ttdoc">VGA utilities.</div></div>
<div class="ttc" id="avga__vmode_8h_html"><div class="ttname"><a href="vga__vmode_8h.html">vga_vmode.h</a></div><div class="ttdoc">VGA videomodes.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="picovga_8h.html">picovga.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>