Skip to content

Commit 7ce91bd

Browse files
updateddocumentation folder
1 parent 7681650 commit 7ce91bd

File tree

112 files changed

+2438
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+2438
-5
lines changed

.gitignore

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ target/
1010
*.pdb
1111

1212
# User included ignores
13-
documentation/release/
14-
documentation/xtensa-esp32-none-elf/release/
15-
documentation/CACHEDIR.TAG
13+
documentation/
14+
15+
# docs is going to be the most up-to-date documentation
16+
docs/release/
17+
docs/xtensa-esp32-none-elf/release/
18+
docs/CACHEDIR.TAG

docs/.rustc_info.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"rustc_fingerprint":2652243571358026184,"outputs":{"13294277788634246273":{"success":true,"status":"","code":0,"stdout":"___.exe\nlib___.rlib\n___.dll\n___.dll\n___.lib\n___.dll\nC:\\Users\\jzuri\\.rustup\\toolchains\\esp\npacked\n___\ndebug_assertions\nfmt_debug=\"full\"\noverflow_checks\npanic=\"unwind\"\nproc_macro\nrelocation_model=\"pic\"\ntarget_abi=\"\"\ntarget_arch=\"x86_64\"\ntarget_endian=\"little\"\ntarget_env=\"msvc\"\ntarget_family=\"windows\"\ntarget_feature=\"cmpxchg16b\"\ntarget_feature=\"fxsr\"\ntarget_feature=\"lahfsahf\"\ntarget_feature=\"sse\"\ntarget_feature=\"sse2\"\ntarget_feature=\"sse3\"\ntarget_has_atomic\ntarget_has_atomic=\"128\"\ntarget_has_atomic=\"16\"\ntarget_has_atomic=\"32\"\ntarget_has_atomic=\"64\"\ntarget_has_atomic=\"8\"\ntarget_has_atomic=\"ptr\"\ntarget_has_atomic_equal_alignment=\"128\"\ntarget_has_atomic_equal_alignment=\"16\"\ntarget_has_atomic_equal_alignment=\"32\"\ntarget_has_atomic_equal_alignment=\"64\"\ntarget_has_atomic_equal_alignment=\"8\"\ntarget_has_atomic_equal_alignment=\"ptr\"\ntarget_has_atomic_load_store\ntarget_has_atomic_load_store=\"128\"\ntarget_has_atomic_load_store=\"16\"\ntarget_has_atomic_load_store=\"32\"\ntarget_has_atomic_load_store=\"64\"\ntarget_has_atomic_load_store=\"8\"\ntarget_has_atomic_load_store=\"ptr\"\ntarget_os=\"windows\"\ntarget_pointer_width=\"64\"\ntarget_thread_local\ntarget_vendor=\"pc\"\nub_checks\nwindows\n","stderr":""},"8187355302092811809":{"success":true,"status":"","code":0,"stdout":"___\nlib___.rlib\nlib___.a\nC:\\Users\\jzuri\\.rustup\\toolchains\\esp\noff\n___\ndebug_assertions\nfmt_debug=\"full\"\noverflow_checks\npanic=\"abort\"\nproc_macro\nrelocation_model=\"static\"\ntarget_abi=\"\"\ntarget_arch=\"xtensa\"\ntarget_endian=\"little\"\ntarget_env=\"\"\ntarget_feature=\"atomctl\"\ntarget_feature=\"bool\"\ntarget_feature=\"coprocessor\"\ntarget_feature=\"debug\"\ntarget_feature=\"dfpaccel\"\ntarget_feature=\"div32\"\ntarget_feature=\"exception\"\ntarget_feature=\"fp\"\ntarget_feature=\"highpriinterrupts\"\ntarget_feature=\"interrupt\"\ntarget_feature=\"loop\"\ntarget_feature=\"mac16\"\ntarget_feature=\"memctl\"\ntarget_feature=\"miscsr\"\ntarget_feature=\"mul32\"\ntarget_feature=\"mul32high\"\ntarget_feature=\"nsa\"\ntarget_feature=\"prid\"\ntarget_feature=\"regprotect\"\ntarget_feature=\"rvector\"\ntarget_feature=\"s32c1i\"\ntarget_feature=\"sext\"\ntarget_feature=\"threadptr\"\ntarget_feature=\"timerint\"\ntarget_feature=\"windowed\"\ntarget_has_atomic\ntarget_has_atomic=\"16\"\ntarget_has_atomic=\"32\"\ntarget_has_atomic=\"8\"\ntarget_has_atomic=\"ptr\"\ntarget_has_atomic_equal_alignment=\"16\"\ntarget_has_atomic_equal_alignment=\"32\"\ntarget_has_atomic_equal_alignment=\"8\"\ntarget_has_atomic_equal_alignment=\"ptr\"\ntarget_has_atomic_load_store\ntarget_has_atomic_load_store=\"16\"\ntarget_has_atomic_load_store=\"32\"\ntarget_has_atomic_load_store=\"8\"\ntarget_has_atomic_load_store=\"ptr\"\ntarget_os=\"none\"\ntarget_pointer_width=\"32\"\ntarget_vendor=\"unknown\"\nub_checks\n","stderr":"warning: dropping unsupported crate type `dylib` for target `xtensa-esp32-none-elf`\n\nwarning: dropping unsupported crate type `cdylib` for target `xtensa-esp32-none-elf`\n\nwarning: dropping unsupported crate type `proc-macro` for target `xtensa-esp32-none-elf`\n\nwarning: 3 warnings emitted\n\n"},"3667494495721335966":{"success":true,"status":"","code":0,"stdout":"___.exe\nlib___.rlib\n___.dll\n___.dll\n___.lib\n___.dll\n","stderr":""},"4323170105781953349":{"success":true,"status":"","code":0,"stdout":"rustc 1.82.0-nightly (a87c0551c 2024-10-30) (1.82.0.3)\nbinary: rustc\ncommit-hash: a87c0551c68304e5e845cab1523db1134eb0a765\ncommit-date: 2024-10-30\nhost: x86_64-pc-windows-msvc\nrelease: 1.82.0-nightly\nLLVM version: 18.1.2\n","stderr":""},"16742381977990382142":{"success":true,"status":"","code":0,"stdout":"___\nlib___.rlib\nlib___.a\n","stderr":"warning: dropping unsupported crate type `dylib` for target `xtensa-esp32-none-elf`\n\nwarning: dropping unsupported crate type `cdylib` for target `xtensa-esp32-none-elf`\n\nwarning: dropping unsupported crate type `proc-macro` for target `xtensa-esp32-none-elf`\n\nwarning: 3 warnings emitted\n\n"}},"successes":{}}

docs/.rustdoc_fingerprint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"rustc_vv":"rustc 1.82.0-nightly (a87c0551c 2024-10-30) (1.82.0.3)\nbinary: rustc\ncommit-hash: a87c0551c68304e5e845cab1523db1134eb0a765\ncommit-date: 2024-10-30\nhost: x86_64-pc-windows-msvc\nrelease: 1.82.0-nightly\nLLVM version: 18.1.2\n"}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Signature: 8a477f597d28d172789f06886806bc55
2+
# This file is a cache directory tag created by cargo.
3+
# For information about cache directory tags see https://bford.info/cachedir/

docs/xtensa-esp32-none-elf/doc/.lock

Whitespace-only changes.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="List of all items in this crate"><title>List of all items in this crate</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="copy_of_main" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (a87c0551c 2024-10-30) (1.82.0.3)" data-channel="nightly" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod sys"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../copy_of_main/index.html">copy_<wbr>of_<wbr>main</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section><ul class="block"><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="fn.__xtensa_lx_rt_main.html">__xtensa_lx_rt_main</a></li><li><a href="lib/neopixel/fn.neopixel_init_buffer.html">lib::neopixel::neopixel_init_buffer</a></li><li><a href="lib/neopixel/fn.neopixel_set_data.html">lib::neopixel::neopixel_set_data</a></li><li><a href="lib/neopixel/fn.neopixel_set_entire_data.html">lib::neopixel::neopixel_set_entire_data</a></li><li><a href="lib/neopixel/fn.spi_dma_send.html">lib::neopixel::spi_dma_send</a></li><li><a href="lib/neopixel/fn.spi_dma_send_breathing.html">lib::neopixel::spi_dma_send_breathing</a></li></ul><h3 id="constants">Constants</h3><ul class="all-items"><li><a href="constant.ADC1_0_GPIO.html">ADC1_0_GPIO</a></li><li><a href="lib/neopixel/constant.ARR_SIZE.html">lib::neopixel::ARR_SIZE</a></li><li><a href="lib/neopixel/constant.NEOPIXEL_LOGIC_0.html">lib::neopixel::NEOPIXEL_LOGIC_0</a></li><li><a href="lib/neopixel/constant.NEOPIXEL_LOGIC_1.html">lib::neopixel::NEOPIXEL_LOGIC_1</a></li><li><a href="lib/neopixel/constant.NUM_LEDS.html">lib::neopixel::NUM_LEDS</a></li><li><a href="lib/neopixel/constant.PACKET_SIZE.html">lib::neopixel::PACKET_SIZE</a></li><li><a href="lib/neopixel/constant.TURN_OFF.html">lib::neopixel::TURN_OFF</a></li></ul></section></div></main></body></html>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ADC1_0_GPIO` constant in crate `copy_of_main`."><title>ADC1_0_GPIO in copy_of_main - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="copy_of_main" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (a87c0551c 2024-10-30) (1.82.0.3)" data-channel="nightly" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc constant"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../copy_of_main/index.html">copy_<wbr>of_<wbr>main</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Constant <a href="index.html">copy_of_main</a>::<wbr><a class="constant" href="#">ADC1_0_GPIO</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/copy_of_main/copy_of_main.rs.html#8">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub(crate) const ADC1_0_GPIO: u8 = 36;</code></pre></section></div></main></body></html>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `__xtensa_lx_rt_main` fn in crate `copy_of_main`."><title>__xtensa_lx_rt_main in copy_of_main - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="copy_of_main" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (a87c0551c 2024-10-30) (1.82.0.3)" data-channel="nightly" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../copy_of_main/index.html">copy_<wbr>of_<wbr>main</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="index.html">copy_of_main</a>::<wbr><a class="fn" href="#">__xtensa_lx_rt_main</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/copy_of_main/copy_of_main.rs.html#32-139">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub(crate) fn __xtensa_lx_rt_main() -&gt; !</code></pre></section></div></main></body></html>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `copy_of_main` crate."><title>copy_of_main - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="copy_of_main" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (a87c0551c 2024-10-30) (1.82.0.3)" data-channel="nightly" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../copy_of_main/index.html">copy_<wbr>of_<wbr>main</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">copy_of_main</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/copy_of_main/copy_of_main.rs.html#1-139">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="lib/index.html" title="mod copy_of_main::lib">lib</a><span title="Restricted Visibility">&nbsp;🔒</span> </div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.ADC1_0_GPIO.html" title="constant copy_of_main::ADC1_0_GPIO">ADC1_<wbr>0_<wbr>GPIO</a><span title="Restricted Visibility">&nbsp;🔒</span> </div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.__xtensa_lx_rt_main.html" title="fn copy_of_main::__xtensa_lx_rt_main">__<wbr>xtensa_<wbr>lx_<wbr>rt_<wbr>main</a><span title="Restricted Visibility">&nbsp;🔒</span> </div></li></ul></section></div></main></body></html>

0 commit comments

Comments
 (0)