Skip to content

Commit 4f800f0

Browse files
lduchosallduchosal
authored
feat/cleanup-documentation (#353)
* Fix: remove obsolete doc * Feat: docfx generated * Delete .github/workflows/securitycodescan.yml Fix: securitycode scan not compatible * Delete .github/workflows/codacy.yml Fix: Codacy not compatible
1 parent 4547c9d commit 4f800f0

File tree

371 files changed

+23181
-11081
lines changed

Some content is hidden

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

371 files changed

+23181
-11081
lines changed

‎doc/Doxyfile‎

Lines changed: 0 additions & 2384 deletions
This file was deleted.

‎doc/_site/api/System.Net.BigIntegerExtensions.html‎

Lines changed: 358 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,358 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Class BigIntegerExtensions | IPNetwork </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Class BigIntegerExtensions | IPNetwork ">
8+
9+
<meta name="description" content="Extension methods to convert instances to hexadecimal, octal, and binary strings.">
10+
<link rel="icon" href="../favicon.ico">
11+
<link rel="stylesheet" href="../public/docfx.min.css">
12+
<link rel="stylesheet" href="../public/main.css">
13+
<meta name="docfx:navrel" content="../toc.html">
14+
<meta name="docfx:tocrel" content="toc.html">
15+
16+
<meta name="docfx:rel" content="../">
17+
18+
19+
<meta name="docfx:docurl" content="https://github.com/lduchosal/ipnetwork/new/feat/cleanup-documentation/apiSpec/new?filename=System_Net_BigIntegerExtensions.md&amp;value=---%0Auid%3A%20System.Net.BigIntegerExtensions%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
20+
<meta name="loc:inThisArticle" content="In this article">
21+
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
22+
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
23+
<meta name="loc:tocFilter" content="Filter by title">
24+
<meta name="loc:nextArticle" content="Next">
25+
<meta name="loc:prevArticle" content="Previous">
26+
<meta name="loc:themeLight" content="Light">
27+
<meta name="loc:themeDark" content="Dark">
28+
<meta name="loc:themeAuto" content="Auto">
29+
<meta name="loc:changeTheme" content="Change theme">
30+
<meta name="loc:copy" content="Copy">
31+
<meta name="loc:downloadPdf" content="Download PDF">
32+
33+
<script type="module" src="./../public/docfx.min.js"></script>
34+
35+
<script>
36+
const theme = localStorage.getItem('theme') || 'auto'
37+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
38+
</script>
39+
40+
</head>
41+
42+
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
43+
<header class="bg-body border-bottom">
44+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
45+
<div class="container-xxl flex-nowrap">
46+
<a class="navbar-brand" href="../index.html">
47+
<img id="logo" class="svg" src="../logo.svg" alt="IPNetwork">
48+
IPNetwork
49+
</a>
50+
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
51+
<i class="bi bi-three-dots"></i>
52+
</button>
53+
<div class="collapse navbar-collapse" id="navpanel">
54+
<div id="navbar">
55+
<form class="search" role="search" id="search">
56+
<i class="bi bi-search"></i>
57+
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
58+
</form>
59+
</div>
60+
</div>
61+
</div>
62+
</nav>
63+
</header>
64+
65+
<main class="container-xxl">
66+
<div class="toc-offcanvas">
67+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
68+
<div class="offcanvas-header">
69+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
70+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
71+
</div>
72+
<div class="offcanvas-body">
73+
<nav class="toc" id="toc"></nav>
74+
</div>
75+
</div>
76+
</div>
77+
78+
<div class="content">
79+
<div class="actionbar">
80+
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
81+
<i class="bi bi-list"></i>
82+
</button>
83+
84+
<nav id="breadcrumb"></nav>
85+
</div>
86+
87+
<article data-uid="System.Net.BigIntegerExtensions">
88+
89+
90+
91+
<h1 id="System_Net_BigIntegerExtensions" data-uid="System.Net.BigIntegerExtensions" class="text-break">
92+
Class BigIntegerExtensions <a class="header-action link-secondary" title="View source" href="https://github.com/lduchosal/ipnetwork/blob/feat/cleanup-documentation/src/System.Net.IPNetwork/BigIntegerExtensions.cs/#L15"><i class="bi bi-code-slash"></i></a>
93+
</h1>
94+
95+
<div class="facts text-secondary">
96+
<dl><dt>Namespace</dt><dd><a class="xref" href="System.html">System</a>.<a class="xref" href="System.Net.html">Net</a></dd></dl>
97+
<dl><dt>Assembly</dt><dd>System.Net.IPNetwork.dll</dd></dl>
98+
</div>
99+
100+
<div class="markdown summary"><p>Extension methods to convert <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a>
101+
instances to hexadecimal, octal, and binary strings.</p>
102+
</div>
103+
<div class="markdown conceptual"></div>
104+
105+
<div class="codewrapper">
106+
<pre><code class="lang-csharp hljs">[CLSCompliant(true)]
107+
public static class BigIntegerExtensions</code></pre>
108+
</div>
109+
110+
111+
112+
113+
<dl class="typelist inheritance">
114+
<dt>Inheritance</dt>
115+
<dd>
116+
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
117+
<div><span class="xref">BigIntegerExtensions</span></div>
118+
</dd>
119+
</dl>
120+
121+
122+
123+
<dl class="typelist inheritedMembers">
124+
<dt>Inherited Members</dt>
125+
<dd>
126+
<div>
127+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
128+
</div>
129+
<div>
130+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
131+
</div>
132+
<div>
133+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
134+
</div>
135+
<div>
136+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
137+
</div>
138+
<div>
139+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
140+
</div>
141+
<div>
142+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
143+
</div>
144+
<div>
145+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
146+
</div>
147+
</dd></dl>
148+
149+
150+
151+
152+
153+
154+
<h2 class="section" id="methods">Methods
155+
</h2>
156+
157+
158+
<a id="System_Net_BigIntegerExtensions_PositiveReverse_" data-uid="System.Net.BigIntegerExtensions.PositiveReverse*"></a>
159+
160+
<h3 id="System_Net_BigIntegerExtensions_PositiveReverse_System_Numerics_BigInteger_System_Int32_" data-uid="System.Net.BigIntegerExtensions.PositiveReverse(System.Numerics.BigInteger,System.Int32)">
161+
PositiveReverse(BigInteger, int)
162+
<a class="header-action link-secondary" title="View source" href="https://github.com/lduchosal/ipnetwork/blob/feat/cleanup-documentation/src/System.Net.IPNetwork/BigIntegerExtensions.cs/#L154"><i class="bi bi-code-slash"></i></a>
163+
</h3>
164+
165+
<div class="markdown level1 summary"><p>Reverse a Positive BigInteger ONLY
166+
Bitwise ~ operator</p>
167+
<p>Input : FF FF FF FF
168+
Width : 4
169+
Result : 00 00 00 00</p>
170+
<p>Input : 00 00 00 00
171+
Width : 4
172+
Result : FF FF FF FF</p>
173+
<p>Input : FF FF FF FF
174+
Width : 8
175+
Result : FF FF FF FF 00 00 00 00</p>
176+
<p>Input : 00 00 00 00
177+
Width : 8
178+
Result : FF FF FF FF FF FF FF FF.</p>
179+
</div>
180+
<div class="markdown level1 conceptual"></div>
181+
182+
<div class="codewrapper">
183+
<pre><code class="lang-csharp hljs">public static BigInteger PositiveReverse(this BigInteger input, int width)</code></pre>
184+
</div>
185+
186+
<h4 class="section">Parameters</h4>
187+
<dl class="parameters">
188+
<dt><code>input</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a></dt>
189+
<dd><p>The positive number to bitwise reverse.</p>
190+
</dd>
191+
<dt><code>width</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
192+
<dd><p>The width of the parameter.</p>
193+
</dd>
194+
</dl>
195+
196+
<h4 class="section">Returns</h4>
197+
<dl class="parameters">
198+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a></dt>
199+
<dd><p>A number representing the input bitwise reversed.</p>
200+
</dd>
201+
</dl>
202+
203+
204+
205+
206+
207+
208+
209+
210+
211+
212+
213+
<a id="System_Net_BigIntegerExtensions_ToBinaryString_" data-uid="System.Net.BigIntegerExtensions.ToBinaryString*"></a>
214+
215+
<h3 id="System_Net_BigIntegerExtensions_ToBinaryString_System_Numerics_BigInteger_" data-uid="System.Net.BigIntegerExtensions.ToBinaryString(System.Numerics.BigInteger)">
216+
ToBinaryString(BigInteger)
217+
<a class="header-action link-secondary" title="View source" href="https://github.com/lduchosal/ipnetwork/blob/feat/cleanup-documentation/src/System.Net.IPNetwork/BigIntegerExtensions.cs/#L26"><i class="bi bi-code-slash"></i></a>
218+
</h3>
219+
220+
<div class="markdown level1 summary"><p>Converts a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a> to a binary string.</p>
221+
</div>
222+
<div class="markdown level1 conceptual"></div>
223+
224+
<div class="codewrapper">
225+
<pre><code class="lang-csharp hljs">public static string ToBinaryString(this BigInteger bigint)</code></pre>
226+
</div>
227+
228+
<h4 class="section">Parameters</h4>
229+
<dl class="parameters">
230+
<dt><code>bigint</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a></dt>
231+
<dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a>.</p>
232+
</dd>
233+
</dl>
234+
235+
<h4 class="section">Returns</h4>
236+
<dl class="parameters">
237+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
238+
<dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> containing a binary
239+
representation of the supplied <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a>.</p>
240+
</dd>
241+
</dl>
242+
243+
244+
245+
246+
247+
248+
249+
250+
251+
252+
253+
<a id="System_Net_BigIntegerExtensions_ToHexadecimalString_" data-uid="System.Net.BigIntegerExtensions.ToHexadecimalString*"></a>
254+
255+
<h3 id="System_Net_BigIntegerExtensions_ToHexadecimalString_System_Numerics_BigInteger_" data-uid="System.Net.BigIntegerExtensions.ToHexadecimalString(System.Numerics.BigInteger)">
256+
ToHexadecimalString(BigInteger)
257+
<a class="header-action link-secondary" title="View source" href="https://github.com/lduchosal/ipnetwork/blob/feat/cleanup-documentation/src/System.Net.IPNetwork/BigIntegerExtensions.cs/#L63"><i class="bi bi-code-slash"></i></a>
258+
</h3>
259+
260+
<div class="markdown level1 summary"><p>Converts a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a> to a hexadecimal string.</p>
261+
</div>
262+
<div class="markdown level1 conceptual"></div>
263+
264+
<div class="codewrapper">
265+
<pre><code class="lang-csharp hljs">public static string ToHexadecimalString(this BigInteger bigint)</code></pre>
266+
</div>
267+
268+
<h4 class="section">Parameters</h4>
269+
<dl class="parameters">
270+
<dt><code>bigint</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a></dt>
271+
<dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a>.</p>
272+
</dd>
273+
</dl>
274+
275+
<h4 class="section">Returns</h4>
276+
<dl class="parameters">
277+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
278+
<dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> containing a hexadecimal
279+
representation of the supplied <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a>.</p>
280+
</dd>
281+
</dl>
282+
283+
284+
285+
286+
287+
288+
289+
290+
291+
292+
293+
<a id="System_Net_BigIntegerExtensions_ToOctalString_" data-uid="System.Net.BigIntegerExtensions.ToOctalString*"></a>
294+
295+
<h3 id="System_Net_BigIntegerExtensions_ToOctalString_System_Numerics_BigInteger_" data-uid="System.Net.BigIntegerExtensions.ToOctalString(System.Numerics.BigInteger)">
296+
ToOctalString(BigInteger)
297+
<a class="header-action link-secondary" title="View source" href="https://github.com/lduchosal/ipnetwork/blob/feat/cleanup-documentation/src/System.Net.IPNetwork/BigIntegerExtensions.cs/#L76"><i class="bi bi-code-slash"></i></a>
298+
</h3>
299+
300+
<div class="markdown level1 summary"><p>Converts a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a> to a octal string.</p>
301+
</div>
302+
<div class="markdown level1 conceptual"></div>
303+
304+
<div class="codewrapper">
305+
<pre><code class="lang-csharp hljs">public static string ToOctalString(this BigInteger bigint)</code></pre>
306+
</div>
307+
308+
<h4 class="section">Parameters</h4>
309+
<dl class="parameters">
310+
<dt><code>bigint</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a></dt>
311+
<dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a>.</p>
312+
</dd>
313+
</dl>
314+
315+
<h4 class="section">Returns</h4>
316+
<dl class="parameters">
317+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
318+
<dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> containing an octal
319+
representation of the supplied <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.biginteger">BigInteger</a>.</p>
320+
</dd>
321+
</dl>
322+
323+
324+
325+
326+
327+
328+
329+
330+
331+
332+
333+
334+
</article>
335+
336+
<div class="contribution d-print-none">
337+
<a href="https://github.com/lduchosal/ipnetwork/blob/feat/cleanup-documentation/src/System.Net.IPNetwork/BigIntegerExtensions.cs/#L15" class="edit-link">Edit this page</a>
338+
</div>
339+
340+
341+
</div>
342+
343+
<div class="affix">
344+
<nav id="affix"></nav>
345+
</div>
346+
</main>
347+
348+
<div class="container-xxl search-results" id="search-results"></div>
349+
350+
<footer class="border-top text-secondary">
351+
<div class="container-xxl">
352+
<div class="flex-fill">
353+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
354+
</div>
355+
</div>
356+
</footer>
357+
</body>
358+
</html>

0 commit comments

Comments
 (0)