Skip to content

Commit

Permalink
Documentation is updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@lexus2k
lexus2k committed Aug 17, 2018
1 parent e48a0c5 commit 8ac8e12
Show file tree
Hide file tree
Showing 342 changed files with 1,671 additions and 1,062 deletions.
2 changes: 1 addition & 1 deletion docs/_print__internal_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/_print__internal_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
4 changes: 3 additions & 1 deletion docs/_user_settings_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down Expand Up @@ -94,6 +94,8 @@
<tr class="separator:ga879a327dedebec82e853eab3b2f86e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga022279a3f667bcaf983e4bfb0919ac72"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_s_d1306___l_i_b_r_a_r_y___c_o_n_f_i_g.html#ga022279a3f667bcaf983e4bfb0919ac72">CONFIG_PLATFORM_SPI_ENABLE</a></td></tr>
<tr class="separator:ga022279a3f667bcaf983e4bfb0919ac72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacdc84c96cc576f7839a93c71b8e74ef7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_s_d1306___l_i_b_r_a_r_y___c_o_n_f_i_g.html#gacdc84c96cc576f7839a93c71b8e74ef7">CONFIG_SSD1306_UNICODE_ENABLE</a></td></tr>
<tr class="separator:gacdc84c96cc576f7839a93c71b8e74ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p class="">SSD1306 modules configuration. </p>
Expand Down
4 changes: 2 additions & 2 deletions docs/_user_settings_8h_source.html
View file

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions docs/adafruit_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down Expand Up @@ -78,7 +78,6 @@
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="io_8h_source.html">ssd1306_hal/io.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ssd1306_8h_source.html">ssd1306.h</a>&quot;</code><br />
<code>#include &quot;ssd1331_api.h&quot;</code><br />
<code>#include &quot;<a class="el" href="_print__internal_8h_source.html">ssd1306_hal/Print_internal.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="nano__gfx__types_8h_source.html">nano_gfx_types.h</a>&quot;</code><br />
</div>
Expand Down
38 changes: 19 additions & 19 deletions docs/adafruit_8h_source.html
View file

Large diffs are not rendered by default.

16 changes: 9 additions & 7 deletions docs/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down Expand Up @@ -95,12 +95,14 @@
<tr id="row_23_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_app_menu.html" target="_self">SAppMenu</a></td><td class="desc"></td></tr>
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_char_info.html" target="_self">SCharInfo</a></td><td class="desc"></td></tr>
<tr id="row_25_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_fixed_font_info.html" target="_self">SFixedFontInfo</a></td><td class="desc"></td></tr>
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_p_r_i_t_e.html" target="_self">SPRITE</a></td><td class="desc"></td></tr>
<tr id="row_27_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_sprite_pool.html" target="_self">SpritePool</a></td><td class="desc"></td></tr>
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structssd1306__interface__t.html" target="_self">ssd1306_interface_t</a></td><td class="desc"></td></tr>
<tr id="row_29_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structssd1306__lcd__t.html" target="_self">ssd1306_lcd_t</a></td><td class="desc"></td></tr>
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_s_d1306___r_e_c_t.html" target="_self">SSD1306_RECT</a></td><td class="desc"></td></tr>
<tr id="row_31_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_ssd1306_console.html" target="_self">Ssd1306Console</a></td><td class="desc"></td></tr>
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_font_header_record.html" target="_self">SFontHeaderRecord</a></td><td class="desc"></td></tr>
<tr id="row_27_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_p_r_i_t_e.html" target="_self">SPRITE</a></td><td class="desc"></td></tr>
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_sprite_pool.html" target="_self">SpritePool</a></td><td class="desc"></td></tr>
<tr id="row_29_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structssd1306__interface__t.html" target="_self">ssd1306_interface_t</a></td><td class="desc"></td></tr>
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structssd1306__lcd__t.html" target="_self">ssd1306_lcd_t</a></td><td class="desc"></td></tr>
<tr id="row_31_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_s_d1306___r_e_c_t.html" target="_self">SSD1306_RECT</a></td><td class="desc"></td></tr>
<tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_ssd1306_console.html" target="_self">Ssd1306Console</a></td><td class="desc"></td></tr>
<tr id="row_33_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_unicode_block_record.html" target="_self">SUnicodeBlockRecord</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion docs/arduino_2io_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/avr_2arduino_2_arduino_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/avr_2arduino_2_print_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/avr_2arduino_2_wire_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/avr_2io_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/avr_2platform_8c_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/canvas_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
42 changes: 21 additions & 21 deletions docs/canvas_8h_source.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/class_adafruit_canvas1-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
8 changes: 4 additions & 4 deletions docs/class_adafruit_canvas1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down Expand Up @@ -112,7 +112,7 @@
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p class=""><a class="el" href="class_adafruit_canvas1.html">AdafruitCanvas1</a> represents objects for drawing in memory buffer <a class="el" href="class_adafruit_canvas1.html">AdafruitCanvas1</a> represents each pixel as single bit: 0/1 For details refer to SSD1306 datasheet </p>

<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00181">181</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00180">180</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0994709ab240ee5a92fd6ce693bca516"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0994709ab240ee5a92fd6ce693bca516">&#9670;&nbsp;</a></span>blt() <span class="overload">[1/2]</span></h2>
Expand Down Expand Up @@ -157,7 +157,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0994709ab240ee5a92fd6ce6

<p>Implements <a class="el" href="class_adafruit_canvas_base.html#a3ef501a57ac3cb43b4d2425e8a8c0eea">AdafruitCanvasBase&lt; 1 &gt;</a>.</p>

<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00191">191</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00190">190</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -187,7 +187,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aad1117c9a1f350503fbeb68b

<p>Implements <a class="el" href="class_adafruit_canvas_base.html#a749e30a9cf9a29208d30954925f6c678">AdafruitCanvasBase&lt; 1 &gt;</a>.</p>

<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00199">199</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00198">198</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_adafruit_canvas16-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
8 changes: 4 additions & 4 deletions docs/class_adafruit_canvas16.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down Expand Up @@ -112,7 +112,7 @@
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p class=""><a class="el" href="class_adafruit_canvas16.html">AdafruitCanvas16</a> represents objects for drawing in memory buffer <a class="el" href="class_adafruit_canvas16.html">AdafruitCanvas16</a> represents each pixel as two bytes with RGB bits: RRRRRGGG GGGBBBBB. For details refer to SSD1351 datasheet. </p>

<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00289">289</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00288">288</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af9d5a1da0942e7dfd38ed8a0a087869b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9d5a1da0942e7dfd38ed8a0a087869b">&#9670;&nbsp;</a></span>blt() <span class="overload">[1/2]</span></h2>
Expand Down Expand Up @@ -157,7 +157,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af9d5a1da0942e7dfd38ed8a0

<p>Implements <a class="el" href="class_adafruit_canvas_base.html#a3ef501a57ac3cb43b4d2425e8a8c0eea">AdafruitCanvasBase&lt; 16 &gt;</a>.</p>

<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00299">299</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00298">298</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -187,7 +187,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa1d1f393dba27ecdb2c1310d

<p>Implements <a class="el" href="class_adafruit_canvas_base.html#a749e30a9cf9a29208d30954925f6c678">AdafruitCanvasBase&lt; 16 &gt;</a>.</p>

<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00307">307</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="adafruit_8h_source.html#l00306">306</a> of file <a class="el" href="adafruit_8h_source.html">adafruit.h</a>.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/class_adafruit_canvas8-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SSD1306 OLED display driver
&#160;<span id="projectnumber">1.7.2</span>
&#160;<span id="projectnumber">1.7.5</span>
</div>
<div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
</td>
Expand Down
Loading

0 comments on commit 8ac8e12

Please sign in to comment.