Skip to content

Commit cba1e89

Browse files
etan-statusetan-status
committed
update docs for ym-header
1 parent 3205171 commit cba1e89

Some content is hidden

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

84 files changed

+59201
-0
lines changed

‎ym-header/dochack.js

+2,036
Large diffs are not rendered by default.

‎ym-header/libp2p.html

+270
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
1+
<?xml version="1.0" encoding="utf-8" ?>
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
<!-- This file is generated by Nim. -->
5+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
9+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
10+
11+
<!-- Favicon -->
12+
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
13+
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
14+
15+
<!-- Google fonts -->
16+
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
17+
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
18+
19+
<!-- CSS -->
20+
<title>libp2p</title>
21+
<link rel="stylesheet" type="text/css" href="nimdoc.out.css">
22+
23+
<script type="text/javascript" src="dochack.js"></script>
24+
25+
<script type="text/javascript">
26+
function main() {
27+
var pragmaDots = document.getElementsByClassName("pragmadots");
28+
for (var i = 0; i < pragmaDots.length; i++) {
29+
pragmaDots[i].onclick = function(event) {
30+
// Hide tease
31+
event.target.parentNode.style.display = "none";
32+
// Show actual
33+
event.target.parentNode.nextElementSibling.style.display = "inline";
34+
}
35+
}
36+
37+
function switchTheme(e) {
38+
if (e.target.checked) {
39+
document.documentElement.setAttribute('data-theme', 'dark');
40+
localStorage.setItem('theme', 'dark');
41+
} else {
42+
document.documentElement.setAttribute('data-theme', 'light');
43+
localStorage.setItem('theme', 'light');
44+
}
45+
}
46+
47+
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
48+
if (toggleSwitch !== null) {
49+
toggleSwitch.addEventListener('change', switchTheme, false);
50+
}
51+
52+
var currentTheme = localStorage.getItem('theme');
53+
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
54+
currentTheme = 'dark';
55+
}
56+
if (currentTheme) {
57+
document.documentElement.setAttribute('data-theme', currentTheme);
58+
59+
if (currentTheme === 'dark' && toggleSwitch !== null) {
60+
toggleSwitch.checked = true;
61+
}
62+
}
63+
}
64+
65+
window.addEventListener('DOMContentLoaded', main);
66+
</script>
67+
68+
</head>
69+
<body>
70+
<div class="document" id="documentId">
71+
<div class="container">
72+
<h1 class="title">libp2p</h1>
73+
<div class="row">
74+
<div class="three columns">
75+
<div class="theme-switch-wrapper">
76+
<label class="theme-switch" for="checkbox">
77+
<input type="checkbox" id="checkbox" />
78+
<div class="slider round"></div>
79+
</label>
80+
&nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
81+
</div>
82+
<div id="global-links">
83+
<ul class="simple">
84+
<li>
85+
<a href="theindex.html">Index</a>
86+
</li>
87+
</ul>
88+
</div>
89+
<div id="searchInputDiv">
90+
Search: <input type="text" id="searchInput"
91+
onkeyup="search()" />
92+
</div>
93+
<div>
94+
Group by:
95+
<select onchange="groupBy(this.value)">
96+
<option value="section">Section</option>
97+
<option value="type">Type</option>
98+
</select>
99+
</div>
100+
<script type="text/javascript">
101+
function main2() {
102+
// Create the slider
103+
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
104+
var newSlider = document.createRange().createContextualFragment(`
105+
<div class="theme-switch-wrapper">
106+
<label class="theme-switch" for="internalcheckbox">
107+
<input type="checkbox" id="internalcheckbox">
108+
<div class="slider round"></div>
109+
</label>
110+
&nbsp;&nbsp;&nbsp; <em>Internal</em>
111+
</div>
112+
`);
113+
114+
var sliderInst = firstSlider.after(newSlider);
115+
116+
// Restore slider state from storage
117+
var currentMode = localStorage.getItem('privateMode');
118+
if (currentMode == "private") {
119+
document.getElementById("internalcheckbox").checked = true;
120+
} else {
121+
hidePrivateProcs();
122+
}
123+
124+
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
125+
}
126+
127+
function hidePrivateProcs() {
128+
var toHide = document.getElementsByClassName("tohide");
129+
for (var i = 0; i < toHide.length; i++) {
130+
var pragmas = toHide[i].querySelectorAll("span.Identifier");
131+
var public = false;
132+
for (var z = 0; z < pragmas.length; z++) {
133+
if (pragmas[z].innerText == "public") {
134+
public = true;
135+
break;
136+
}
137+
}
138+
if (public == false) {
139+
toHide[i].style.display = "none";
140+
toHide[i].classList.add("hidden");
141+
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
142+
for (var y = 0; y < links.length; y++) {
143+
links[y].parentNode.style.display = "none";
144+
links[y].parentNode.classList.add("hidden");
145+
}
146+
}
147+
}
148+
149+
// TOC
150+
var nestedSections = document.getElementsByClassName("nested-toc-section");
151+
for (var i = 0; i < nestedSections.length; i++) {
152+
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
153+
nestedSections[i].style.display = "none";
154+
nestedSections[i].classList.add("hidden");
155+
}
156+
}
157+
158+
var sections = document.getElementsByClassName("simple-toc-section");
159+
for (var i = 0; i < sections.length; i++) {
160+
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
161+
sections[i].parentNode.style.display = "none";
162+
sections[i].parentNode.classList.add("hidden");
163+
}
164+
165+
}
166+
167+
// Sections
168+
var sections = document.getElementsByClassName("section");
169+
for (var i = 0; i < sections.length; i++) {
170+
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
171+
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
172+
sections[i].style.display = "none";
173+
sections[i].classList.add("hidden");
174+
}
175+
176+
}
177+
}
178+
179+
function showPrivateProcs() {
180+
var toHide = Array.from(document.getElementsByClassName("hidden"));
181+
for (var i = 0; i < toHide.length; i++) {
182+
toHide[i].style.display = "";
183+
toHide[i].classList.remove("hidden");
184+
}
185+
}
186+
187+
function togglePrivateProcs() {
188+
if (document.getElementById("internalcheckbox").checked) {
189+
localStorage.setItem('privateMode', 'private');
190+
showPrivateProcs();
191+
} else {
192+
localStorage.setItem('privateMode', 'public');
193+
hidePrivateProcs();
194+
}
195+
}
196+
window.addEventListener("DOMContentLoaded", main2);
197+
</script>
198+
<ul class="simple simple-toc" id="toc-list">
199+
<li>
200+
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
201+
<ul class="simple simple-toc-section">
202+
203+
</ul>
204+
</li>
205+
<li>
206+
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
207+
<ul class="simple simple-toc-section">
208+
<ul class="simple nested-toc-section">dummyPrivateProc
209+
<li><a class="reference" href="#dummyPrivateProc"
210+
title="dummyPrivateProc()">dummyPrivateProc()</a></li>
211+
212+
</ul>
213+
214+
</ul>
215+
</li>
216+
217+
</ul>
218+
219+
</div>
220+
&nbsp;&nbsp;<a
221+
href="https://github.com/status-im/nim-libp2p/tree/ym-header/libp2p.nim#L1"
222+
class="link-seesrc" target="_blank">Source</a>
223+
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
224+
225+
<div class="nine columns" id="content">
226+
<div id="tocRoot"></div>
227+
228+
<p class="module-desc"><p>Welcome to the nim-libp2p reference!</p>
229+
<p>On the left, you'll find a switch that allows you to see private procedures. By default, you'll only see the public one (marked with <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">public</span><span class="Operator">.</span><span class="Punctuation">}</span></span></tt>)</p>
230+
<p>The difference between public and private procedures is that public procedure stay backward compatible during the Major version, whereas private ones can change at each new Minor version.</p>
231+
<p>If you're new to nim-libp2p, you can find a tutorial <a class="reference external" href="https://status-im.github.io/nim-libp2p/docs/tutorial_1_connect/">here</a> that can help you get started.</p>
232+
</p>
233+
<div class="section" id="6">
234+
<h1><a class="toc-backref" href="#6">Imports</a></h1>
235+
<dl class="item">
236+
<a class="reference external" href="libp2p/protobuf/minprotobuf.html">libp2p/protobuf/minprotobuf</a>, <a class="reference external" href="libp2p/switch.html">libp2p/switch</a>, <a class="reference external" href="libp2p/stream/lpstream.html">libp2p/stream/lpstream</a>, <a class="reference external" href="libp2p/builders.html">libp2p/builders</a>, <a class="reference external" href="libp2p/transports/tcptransport.html">libp2p/transports/tcptransport</a>, <a class="reference external" href="libp2p/transports/wstransport.html">libp2p/transports/wstransport</a>, <a class="reference external" href="libp2p/protocols/ping.html">libp2p/protocols/ping</a>, <a class="reference external" href="libp2p/protocols/pubsub.html">libp2p/protocols/pubsub</a>, <a class="reference external" href="libp2p/peerid.html">libp2p/peerid</a>, <a class="reference external" href="libp2p/peerinfo.html">libp2p/peerinfo</a>, <a class="reference external" href="libp2p/peerstore.html">libp2p/peerstore</a>, <a class="reference external" href="libp2p/multiaddress.html">libp2p/multiaddress</a>
237+
</dl></div>
238+
<div class="section" id="12">
239+
<h1><a class="toc-backref" href="#12">Procs</a></h1>
240+
<dl class="item">
241+
<div id="dummyPrivateProc" class="tohide">
242+
<dt><pre><span class="Keyword">proc</span> <a href="#dummyPrivateProc"><span class="Identifier">dummyPrivateProc</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
243+
<dd>
244+
245+
A private proc example
246+
&nbsp;&nbsp;<a
247+
href="https://github.com/status-im/nim-libp2p/tree/ym-header/libp2p.nim#L38"
248+
class="link-seesrc" target="_blank">Source</a>
249+
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
250+
251+
</dd>
252+
</div>
253+
254+
</dl></div>
255+
256+
</div>
257+
</div>
258+
259+
<div class="row">
260+
<div class="twelve-columns footer">
261+
<span class="nim-sprite"></span>
262+
<br/>
263+
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-15 17:00:19 UTC</small>
264+
</div>
265+
</div>
266+
</div>
267+
</div>
268+
269+
</body>
270+
</html>

0 commit comments

Comments
 (0)