Skip to content

Commit 9fe053a

Browse files
TwoTenPvPTwoTenPvP
committed
Improved API reference
1 parent dfff69e commit 9fe053a

File tree

86 files changed

+106243
-181
lines changed

Some content is hidden

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

86 files changed

+106243
-181
lines changed

‎docs/_api/Arithmetic.md

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
---
2+
title: Arithmetic
3+
permalink: /api/arithmetic/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">Arithmetic ``class``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Serialization</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<div>
12+
<h3 markdown="1">Public Fields</h3>
13+
<div style="line-height: 1;">
14+
<h4 markdown="1"><b>public ``long`` SIGN_BIT_64;</b></h4>
15+
</div>
16+
<div style="line-height: 1;">
17+
<h4 markdown="1"><b>public ``int`` SIGN_BIT_32;</b></h4>
18+
</div>
19+
<div style="line-height: 1;">
20+
<h4 markdown="1"><b>public ``short`` SIGN_BIT_16;</b></h4>
21+
</div>
22+
<div style="line-height: 1;">
23+
<h4 markdown="1"><b>public ``sbyte`` SIGN_BIT_8;</b></h4>
24+
</div>
25+
</div>
26+
<br>
27+
<div>
28+
<h3 markdown="1">Public Static Methods</h3>
29+
<div style="line-height: 1;">
30+
<h4 markdown="1"><b>public static ``ulong`` CeilingExact(``ulong`` u1, ``ulong`` u2);</b></h4>
31+
<h5><b>Parameters</b></h5>
32+
<div>
33+
<p style="font-size: 20px; color: #444;" markdown="1">``ulong`` u1</p>
34+
</div>
35+
<div>
36+
<p style="font-size: 20px; color: #444;" markdown="1">``ulong`` u2</p>
37+
</div>
38+
</div>
39+
<br>
40+
<div style="line-height: 1;">
41+
<h4 markdown="1"><b>public static ``long`` CeilingExact(``long`` u1, ``long`` u2);</b></h4>
42+
<h5><b>Parameters</b></h5>
43+
<div>
44+
<p style="font-size: 20px; color: #444;" markdown="1">``long`` u1</p>
45+
</div>
46+
<div>
47+
<p style="font-size: 20px; color: #444;" markdown="1">``long`` u2</p>
48+
</div>
49+
</div>
50+
<br>
51+
<div style="line-height: 1;">
52+
<h4 markdown="1"><b>public static ``uint`` CeilingExact(``uint`` u1, ``uint`` u2);</b></h4>
53+
<h5><b>Parameters</b></h5>
54+
<div>
55+
<p style="font-size: 20px; color: #444;" markdown="1">``uint`` u1</p>
56+
</div>
57+
<div>
58+
<p style="font-size: 20px; color: #444;" markdown="1">``uint`` u2</p>
59+
</div>
60+
</div>
61+
<br>
62+
<div style="line-height: 1;">
63+
<h4 markdown="1"><b>public static ``int`` CeilingExact(``int`` u1, ``int`` u2);</b></h4>
64+
<h5><b>Parameters</b></h5>
65+
<div>
66+
<p style="font-size: 20px; color: #444;" markdown="1">``int`` u1</p>
67+
</div>
68+
<div>
69+
<p style="font-size: 20px; color: #444;" markdown="1">``int`` u2</p>
70+
</div>
71+
</div>
72+
<br>
73+
<div style="line-height: 1;">
74+
<h4 markdown="1"><b>public static ``ushort`` CeilingExact(``ushort`` u1, ``ushort`` u2);</b></h4>
75+
<h5><b>Parameters</b></h5>
76+
<div>
77+
<p style="font-size: 20px; color: #444;" markdown="1">``ushort`` u1</p>
78+
</div>
79+
<div>
80+
<p style="font-size: 20px; color: #444;" markdown="1">``ushort`` u2</p>
81+
</div>
82+
</div>
83+
<br>
84+
<div style="line-height: 1;">
85+
<h4 markdown="1"><b>public static ``short`` CeilingExact(``short`` u1, ``short`` u2);</b></h4>
86+
<h5><b>Parameters</b></h5>
87+
<div>
88+
<p style="font-size: 20px; color: #444;" markdown="1">``short`` u1</p>
89+
</div>
90+
<div>
91+
<p style="font-size: 20px; color: #444;" markdown="1">``short`` u2</p>
92+
</div>
93+
</div>
94+
<br>
95+
<div style="line-height: 1;">
96+
<h4 markdown="1"><b>public static ``byte`` CeilingExact(``byte`` u1, ``byte`` u2);</b></h4>
97+
<h5><b>Parameters</b></h5>
98+
<div>
99+
<p style="font-size: 20px; color: #444;" markdown="1">``byte`` u1</p>
100+
</div>
101+
<div>
102+
<p style="font-size: 20px; color: #444;" markdown="1">``byte`` u2</p>
103+
</div>
104+
</div>
105+
<br>
106+
<div style="line-height: 1;">
107+
<h4 markdown="1"><b>public static ``sbyte`` CeilingExact(``sbyte`` u1, ``sbyte`` u2);</b></h4>
108+
<h5><b>Parameters</b></h5>
109+
<div>
110+
<p style="font-size: 20px; color: #444;" markdown="1">``sbyte`` u1</p>
111+
</div>
112+
<div>
113+
<p style="font-size: 20px; color: #444;" markdown="1">``sbyte`` u2</p>
114+
</div>
115+
</div>
116+
<br>
117+
<div style="line-height: 1;">
118+
<h4 markdown="1"><b>public static ``ulong`` ZigZagEncode(``long`` value);</b></h4>
119+
<p>ZigZag encodes a signed integer and maps it to a unsigned integer</p>
120+
<h5><b>Parameters</b></h5>
121+
<div>
122+
<p style="font-size: 20px; color: #444;" markdown="1">``long`` value</p>
123+
<p>The signed integer to encode</p>
124+
</div>
125+
<h5 markdown="1"><b>Returns ``ulong``</b></h5>
126+
<div>
127+
<p>A ZigZag encoded version of the integer</p>
128+
</div>
129+
</div>
130+
<br>
131+
<div style="line-height: 1;">
132+
<h4 markdown="1"><b>public static ``long`` ZigZagDecode(``ulong`` value);</b></h4>
133+
<p>Decides a ZigZag encoded integer back to a signed integer</p>
134+
<h5><b>Parameters</b></h5>
135+
<div>
136+
<p style="font-size: 20px; color: #444;" markdown="1">``ulong`` value</p>
137+
<p>The unsigned integer</p>
138+
</div>
139+
<h5 markdown="1"><b>Returns ``long``</b></h5>
140+
<div>
141+
<p>The signed version of the integer</p>
142+
</div>
143+
</div>
144+
<br>
145+
<div style="line-height: 1;">
146+
<h4 markdown="1"><b>public static ``int`` VarIntSize(``ulong`` value);</b></h4>
147+
<p>Gets the output size in bytes after VarInting a unsigned integer</p>
148+
<h5><b>Parameters</b></h5>
149+
<div>
150+
<p style="font-size: 20px; color: #444;" markdown="1">``ulong`` value</p>
151+
<p>The unsigned integer whose length to get</p>
152+
</div>
153+
<h5 markdown="1"><b>Returns ``int``</b></h5>
154+
<div>
155+
<p>The amount of bytes</p>
156+
</div>
157+
</div>
158+
<br>
159+
</div>
160+
<br>
161+
<div>
162+
<h3 markdown="1">Inherited Methods</h3>
163+
<div style="line-height: 1;">
164+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
165+
<h5 markdown="1">Inherited from: ``object``</h5>
166+
</div>
167+
<br>
168+
<div style="line-height: 1;">
169+
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
170+
<h5 markdown="1">Inherited from: ``object``</h5>
171+
<h5><b>Parameters</b></h5>
172+
<div>
173+
<p style="font-size: 20px; color: #444;" markdown="1">``object`` obj</p>
174+
</div>
175+
</div>
176+
<br>
177+
<div style="line-height: 1;">
178+
<h4 markdown="1"><b>public ``int`` GetHashCode();</b></h4>
179+
<h5 markdown="1">Inherited from: ``object``</h5>
180+
</div>
181+
<br>
182+
<div style="line-height: 1;">
183+
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
184+
<h5 markdown="1">Inherited from: ``object``</h5>
185+
</div>
186+
</div>
187+
<br>

‎docs/_api/BinaryHelpers.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: BinaryHelpers
3+
permalink: /api/binary-helpers/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">BinaryHelpers ``class``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Serialization</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<div>
12+
<h3 markdown="1">Public Static Methods</h3>
13+
<div style="line-height: 1;">
14+
<h4 markdown="1"><b>public static ``uint`` SwapEndian(``uint`` value);</b></h4>
15+
<h5><b>Parameters</b></h5>
16+
<div>
17+
<p style="font-size: 20px; color: #444;" markdown="1">``uint`` value</p>
18+
</div>
19+
</div>
20+
<br>
21+
<div style="line-height: 1;">
22+
<h4 markdown="1"><b>public static ``ulong`` SwapEndian(``ulong`` value);</b></h4>
23+
<h5><b>Parameters</b></h5>
24+
<div>
25+
<p style="font-size: 20px; color: #444;" markdown="1">``ulong`` value</p>
26+
</div>
27+
</div>
28+
<br>
29+
</div>
30+
<br>
31+
<div>
32+
<h3 markdown="1">Inherited Methods</h3>
33+
<div style="line-height: 1;">
34+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
35+
<h5 markdown="1">Inherited from: ``object``</h5>
36+
</div>
37+
<br>
38+
<div style="line-height: 1;">
39+
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
40+
<h5 markdown="1">Inherited from: ``object``</h5>
41+
<h5><b>Parameters</b></h5>
42+
<div>
43+
<p style="font-size: 20px; color: #444;" markdown="1">``object`` obj</p>
44+
</div>
45+
</div>
46+
<br>
47+
<div style="line-height: 1;">
48+
<h4 markdown="1"><b>public ``int`` GetHashCode();</b></h4>
49+
<h5 markdown="1">Inherited from: ``object``</h5>
50+
</div>
51+
<br>
52+
<div style="line-height: 1;">
53+
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
54+
<h5 markdown="1">Inherited from: ``object``</h5>
55+
</div>
56+
</div>
57+
<br>

0 commit comments

Comments
 (0)