Skip to content

Commit 65af3bd

Browse files
TwoTenPvPTwoTenPvP
authored
docs: Updated API reference (#234)
1 parent c7562d5 commit 65af3bd

File tree

166 files changed

+37045
-34316
lines changed

Some content is hidden

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

166 files changed

+37045
-34316
lines changed

‎docs/_api/Arithmetic.md‎

Lines changed: 7 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -9,112 +9,10 @@ permalink: /api/arithmetic/
99
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Serialization</p>
1010
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1111
</div>
12-
<div>
13-
<h3 markdown="1">Public Fields</h3>
14-
<div style="line-height: 1;">
15-
<h4 markdown="1"><b>public ``long`` SIGN_BIT_64;</b></h4>
16-
</div>
17-
<div style="line-height: 1;">
18-
<h4 markdown="1"><b>public ``int`` SIGN_BIT_32;</b></h4>
19-
</div>
20-
<div style="line-height: 1;">
21-
<h4 markdown="1"><b>public ``short`` SIGN_BIT_16;</b></h4>
22-
</div>
23-
<div style="line-height: 1;">
24-
<h4 markdown="1"><b>public ``sbyte`` SIGN_BIT_8;</b></h4>
25-
</div>
26-
</div>
27-
<br>
12+
<p>Arithmetic helper class</p>
13+
2814
<div>
2915
<h3 markdown="1">Public Static Methods</h3>
30-
<div style="line-height: 1;">
31-
<h4 markdown="1"><b>public static ``ulong`` CeilingExact(``ulong`` u1, ``ulong`` u2);</b></h4>
32-
<h5><b>Parameters</b></h5>
33-
<div>
34-
<p style="font-size: 20px; color: #444;" markdown="1">``ulong`` u1</p>
35-
</div>
36-
<div>
37-
<p style="font-size: 20px; color: #444;" markdown="1">``ulong`` u2</p>
38-
</div>
39-
</div>
40-
<br>
41-
<div style="line-height: 1;">
42-
<h4 markdown="1"><b>public static ``long`` CeilingExact(``long`` u1, ``long`` u2);</b></h4>
43-
<h5><b>Parameters</b></h5>
44-
<div>
45-
<p style="font-size: 20px; color: #444;" markdown="1">``long`` u1</p>
46-
</div>
47-
<div>
48-
<p style="font-size: 20px; color: #444;" markdown="1">``long`` u2</p>
49-
</div>
50-
</div>
51-
<br>
52-
<div style="line-height: 1;">
53-
<h4 markdown="1"><b>public static ``uint`` CeilingExact(``uint`` u1, ``uint`` u2);</b></h4>
54-
<h5><b>Parameters</b></h5>
55-
<div>
56-
<p style="font-size: 20px; color: #444;" markdown="1">``uint`` u1</p>
57-
</div>
58-
<div>
59-
<p style="font-size: 20px; color: #444;" markdown="1">``uint`` u2</p>
60-
</div>
61-
</div>
62-
<br>
63-
<div style="line-height: 1;">
64-
<h4 markdown="1"><b>public static ``int`` CeilingExact(``int`` u1, ``int`` u2);</b></h4>
65-
<h5><b>Parameters</b></h5>
66-
<div>
67-
<p style="font-size: 20px; color: #444;" markdown="1">``int`` u1</p>
68-
</div>
69-
<div>
70-
<p style="font-size: 20px; color: #444;" markdown="1">``int`` u2</p>
71-
</div>
72-
</div>
73-
<br>
74-
<div style="line-height: 1;">
75-
<h4 markdown="1"><b>public static ``ushort`` CeilingExact(``ushort`` u1, ``ushort`` u2);</b></h4>
76-
<h5><b>Parameters</b></h5>
77-
<div>
78-
<p style="font-size: 20px; color: #444;" markdown="1">``ushort`` u1</p>
79-
</div>
80-
<div>
81-
<p style="font-size: 20px; color: #444;" markdown="1">``ushort`` u2</p>
82-
</div>
83-
</div>
84-
<br>
85-
<div style="line-height: 1;">
86-
<h4 markdown="1"><b>public static ``short`` CeilingExact(``short`` u1, ``short`` u2);</b></h4>
87-
<h5><b>Parameters</b></h5>
88-
<div>
89-
<p style="font-size: 20px; color: #444;" markdown="1">``short`` u1</p>
90-
</div>
91-
<div>
92-
<p style="font-size: 20px; color: #444;" markdown="1">``short`` u2</p>
93-
</div>
94-
</div>
95-
<br>
96-
<div style="line-height: 1;">
97-
<h4 markdown="1"><b>public static ``byte`` CeilingExact(``byte`` u1, ``byte`` u2);</b></h4>
98-
<h5><b>Parameters</b></h5>
99-
<div>
100-
<p style="font-size: 20px; color: #444;" markdown="1">``byte`` u1</p>
101-
</div>
102-
<div>
103-
<p style="font-size: 20px; color: #444;" markdown="1">``byte`` u2</p>
104-
</div>
105-
</div>
106-
<br>
107-
<div style="line-height: 1;">
108-
<h4 markdown="1"><b>public static ``sbyte`` CeilingExact(``sbyte`` u1, ``sbyte`` u2);</b></h4>
109-
<h5><b>Parameters</b></h5>
110-
<div>
111-
<p style="font-size: 20px; color: #444;" markdown="1">``sbyte`` u1</p>
112-
</div>
113-
<div>
114-
<p style="font-size: 20px; color: #444;" markdown="1">``sbyte`` u2</p>
115-
</div>
116-
</div>
117-
<br>
11816
<div style="line-height: 1;">
11917
<h4 markdown="1"><b>public static ``ulong`` ZigZagEncode(``long`` value);</b></h4>
12018
<p>ZigZag encodes a signed integer and maps it to a unsigned integer</p>
@@ -161,6 +59,11 @@ permalink: /api/arithmetic/
16159
<br>
16260
<div>
16361
<h3 markdown="1">Inherited Methods</h3>
62+
<div style="line-height: 1;">
63+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
64+
<h5 markdown="1">Inherited from: ``object``</h5>
65+
</div>
66+
<br>
16467
<div style="line-height: 1;">
16568
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
16669
<h5 markdown="1">Inherited from: ``object``</h5>
@@ -179,10 +82,5 @@ permalink: /api/arithmetic/
17982
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
18083
<h5 markdown="1">Inherited from: ``object``</h5>
18184
</div>
182-
<br>
183-
<div style="line-height: 1;">
184-
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
185-
<h5 markdown="1">Inherited from: ``object``</h5>
186-
</div>
18785
</div>
18886
<br>

‎docs/_api/AutoBitWritable.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ permalink: /api/auto-bit-writable/
3737
<br>
3838
<div>
3939
<h3 markdown="1">Inherited Methods</h3>
40+
<div style="line-height: 1;">
41+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
42+
<h5 markdown="1">Inherited from: ``object``</h5>
43+
</div>
44+
<br>
4045
<div style="line-height: 1;">
4146
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
4247
<h5 markdown="1">Inherited from: ``object``</h5>
@@ -55,10 +60,5 @@ permalink: /api/auto-bit-writable/
5560
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
5661
<h5 markdown="1">Inherited from: ``object``</h5>
5762
</div>
58-
<br>
59-
<div style="line-height: 1;">
60-
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
61-
<h5 markdown="1">Inherited from: ``object``</h5>
62-
</div>
6363
</div>
6464
<br>

0 commit comments

Comments
 (0)