Skip to content

Commit 8266ca6

Browse files
github-actions[bot]ssferraz
github-actions[bot]
authored and
ssferraz
committed
Deploy Dart documentation
1 parent 689c7e2 commit 8266ca6

File tree

454 files changed

+66940
-0
lines changed

Some content is hidden

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

454 files changed

+66940
-0
lines changed

‎.github/workflows/dart.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,10 @@ jobs:
7373
run: |
7474
git config --global user.name 'github-actions[bot]'
7575
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
76+
mkdir -p docs
7677
rsync -av --delete doc/api/ docs/
7778
touch docs/.nojekyll
7879
git add docs
7980
git commit -m "Deploy Dart documentation"
8081
git push origin main
82+

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/__404error.html‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
7+
<meta name="description" content="askar_wrapper_dart API docs, for the Dart programming language.">
8+
<title>askar_wrapper_dart - Dart API docs</title>
9+
10+
11+
12+
<link rel="preconnect" href="https://fonts.gstatic.com">
13+
<link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
14+
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
15+
16+
<link rel="stylesheet" href="static-assets/github.css?v1">
17+
<link rel="stylesheet" href="static-assets/styles.css?v1">
18+
<link rel="icon" href="static-assets/favicon.png?v1">
19+
20+
</head>
21+
22+
<body data-base-href="" data-using-base-href="false" class="light-theme">
23+
<div id="overlay-under-drawer"></div>
24+
<header id="title">
25+
<span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
26+
<ol class="breadcrumbs gt-separated dark hidden-xs">
27+
<li class="self-crumb">askar_wrapper_dart package</li>
28+
</ol>
29+
<div class="self-name">askar_wrapper_dart</div>
30+
<form class="search navbar-right" role="search">
31+
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
32+
</form>
33+
<div class="toggle" id="theme-button" title="Toggle brightness">
34+
<label for="theme">
35+
<input type="checkbox" id="theme" value="light-theme">
36+
<span id="dark-theme-button" class="material-symbols-outlined">
37+
dark_mode
38+
</span>
39+
<span id="light-theme-button" class="material-symbols-outlined">
40+
light_mode
41+
</span>
42+
</label>
43+
</div>
44+
</header>
45+
<main>
46+
<div id="dartdoc-main-content" class="main-content">
47+
<h1>404: Something's gone wrong :-(</h1>
48+
<section class="desc">
49+
<p>You've tried to visit a page that doesn't exist. Luckily this site
50+
has other <a href="index.html">pages</a>.</p>
51+
<p>If you were looking for something specific, try searching:
52+
<form class="search-body" role="search">
53+
<input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
54+
</form>
55+
</p>
56+
</section>
57+
</div> <!-- /.main-content -->
58+
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
59+
<!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
60+
<header id="header-search-sidebar" class="hidden-l">
61+
<form class="search-sidebar" role="search">
62+
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
63+
</form>
64+
</header>
65+
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
66+
<li class="self-crumb">askar_wrapper_dart package</li>
67+
</ol>
68+
69+
<h5><span class="package-name">askar_wrapper_dart</span> <span class="package-kind">package</span></h5>
70+
<ol>
71+
<li class="section-title">Libraries</li>
72+
<li><a href="askar_wrapper_dart">askar_wrapper_dart</a></li>
73+
</ol>
74+
75+
</div>
76+
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
77+
</div>
78+
</main>
79+
<footer>
80+
<span class="no-break">
81+
askar_wrapper_dart
82+
0.0.1
83+
</span>
84+
85+
</footer>
86+
87+
88+
<script src="static-assets/highlight.pack.js?v1"></script>
89+
<script src="static-assets/docs.dart.js"></script>
90+
91+
</body>
92+
</html>
93+

‎docs/askar_wrapper_dart/AeadParams-class-sidebar.html‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<ol>
2+
3+
<li class="section-title"><a href="askar_wrapper_dart/AeadParams-class.html#constructors">Constructors</a></li>
4+
<li><a href="askar_wrapper_dart/AeadParams/AeadParams.html">AeadParams</a></li>
5+
6+
7+
8+
<li class="section-title">
9+
<a href="askar_wrapper_dart/AeadParams-class.html#instance-properties">Properties</a>
10+
</li>
11+
12+
<li class="inherited">
13+
<a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a>
14+
</li>
15+
16+
<li>
17+
<a href="askar_wrapper_dart/AeadParams/nonceLength.html">nonceLength</a>
18+
</li>
19+
20+
<li class="inherited">
21+
<a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a>
22+
</li>
23+
24+
<li>
25+
<a href="askar_wrapper_dart/AeadParams/tagLength.html">tagLength</a>
26+
</li>
27+
28+
<li class="section-title"><a href="askar_wrapper_dart/AeadParams-class.html#instance-methods">Methods</a></li>
29+
30+
<li class="inherited">
31+
<a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a>
32+
</li>
33+
34+
<li>
35+
<a href="askar_wrapper_dart/AeadParams/toString.html">toString</a>
36+
</li>
37+
38+
<li class="section-title inherited"><a href="askar_wrapper_dart/AeadParams-class.html#operators">Operators</a></li>
39+
40+
<li class="inherited">
41+
<a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a>
42+
</li>
43+
44+
45+
46+
47+
48+
49+
</ol>

‎docs/askar_wrapper_dart/AeadParams-class.html‎

Lines changed: 229 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,229 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
7+
<meta name="description" content="API docs for the AeadParams class from the askar_wrapper_dart library, for the Dart programming language.">
8+
<title>AeadParams class - askar_wrapper_dart library - Dart API</title>
9+
10+
11+
12+
<link rel="preconnect" href="https://fonts.gstatic.com">
13+
<link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
14+
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
15+
16+
<link rel="stylesheet" href="../static-assets/github.css?v1">
17+
<link rel="stylesheet" href="../static-assets/styles.css?v1">
18+
<link rel="icon" href="../static-assets/favicon.png?v1">
19+
20+
</head>
21+
22+
<body data-base-href="../" data-using-base-href="false" class="light-theme">
23+
<div id="overlay-under-drawer"></div>
24+
<header id="title">
25+
<span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
26+
<ol class="breadcrumbs gt-separated dark hidden-xs">
27+
<li><a href="../index.html">askar_wrapper_dart</a></li>
28+
<li><a href="../askar_wrapper_dart">askar_wrapper_dart.dart</a></li>
29+
<li class="self-crumb">AeadParams class</li>
30+
</ol>
31+
<div class="self-name">AeadParams</div>
32+
<form class="search navbar-right" role="search">
33+
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
34+
</form>
35+
<div class="toggle" id="theme-button" title="Toggle brightness">
36+
<label for="theme">
37+
<input type="checkbox" id="theme" value="light-theme">
38+
<span id="dark-theme-button" class="material-symbols-outlined">
39+
dark_mode
40+
</span>
41+
<span id="light-theme-button" class="material-symbols-outlined">
42+
light_mode
43+
</span>
44+
</label>
45+
</div>
46+
</header>
47+
<main>
48+
<div
49+
id="dartdoc-main-content"
50+
class="main-content"
51+
data-above-sidebar="askar_wrapper_dart&#47;askar_wrapper_dart-library-sidebar.html"
52+
data-below-sidebar="askar_wrapper_dart&#47;AeadParams-class-sidebar.html">
53+
<div>
54+
<h1><span class="kind-class">AeadParams</span> class
55+
<a href="https://dart.dev/language/class-modifiers#final" class="feature feature-final" title="This class can neither be extended, implemented, nor mixed in.">final</a>
56+
57+
</h1></div>
58+
59+
60+
<section class="desc markdown">
61+
<p>A class presents a byte buffer combining the AEAD (Authenticated Encryption with Associated Data) parameters.</p>
62+
<p>This class holds the parameters required for AEAD, including the <a href="../askar_wrapper_dart/AeadParams/tagLength.html">tagLength</a> and <a href="../askar_wrapper_dart/AeadParams/nonceLength.html">nonceLength</a>.</p>
63+
</section>
64+
65+
66+
67+
68+
<section class="summary offset-anchor" id="constructors">
69+
<h2>Constructors</h2>
70+
<dl class="constructor-summary-list">
71+
<dt id="AeadParams" class="callable">
72+
<span class="name"><a href="../askar_wrapper_dart/AeadParams/AeadParams.html">AeadParams</a></span><span class="signature">(<span class="parameter" id="-param-tagLength"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">tagLength</span>, </span><span class="parameter" id="-param-nonceLength"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">nonceLength</span></span>)</span>
73+
</dt>
74+
<dd>
75+
Constructs an instance of <a href="../askar_wrapper_dart/AeadParams-class.html">AeadParams</a> with the given <code>tagLength</code> and <code>nonceLength</code>.
76+
</dd>
77+
</dl>
78+
</section>
79+
80+
<section
81+
class="summary offset-anchor"
82+
id="instance-properties">
83+
<h2>Properties</h2>
84+
<dl class="properties">
85+
<dt id="hashCode" class="property inherited">
86+
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
87+
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
88+
89+
90+
</dt>
91+
<dd class="inherited">
92+
The hash code for this object.
93+
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
94+
95+
</dd>
96+
97+
<dt id="nonceLength" class="property">
98+
<span class="name"><a href="../askar_wrapper_dart/AeadParams/nonceLength.html">nonceLength</a></span>
99+
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
100+
101+
102+
</dt>
103+
<dd>
104+
The length of the nonce in bytes.
105+
<div class="features"><span class="feature">final</span></div>
106+
107+
</dd>
108+
109+
<dt id="runtimeType" class="property inherited">
110+
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
111+
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
112+
113+
114+
</dt>
115+
<dd class="inherited">
116+
A representation of the runtime type of the object.
117+
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
118+
119+
</dd>
120+
121+
<dt id="tagLength" class="property">
122+
<span class="name"><a href="../askar_wrapper_dart/AeadParams/tagLength.html">tagLength</a></span>
123+
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
124+
125+
126+
</dt>
127+
<dd>
128+
The length of the authentication tag in bytes.
129+
<div class="features"><span class="feature">final</span></div>
130+
131+
</dd>
132+
133+
</dl>
134+
</section>
135+
136+
137+
<section
138+
class="summary offset-anchor"
139+
id="instance-methods">
140+
<h2>Methods</h2>
141+
<dl class="callables">
142+
<dt id="noSuchMethod" class="callable inherited">
143+
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
144+
<span class="returntype parameter">&#8594; dynamic</span>
145+
</span>
146+
147+
148+
</dt>
149+
<dd class="inherited">
150+
Invoked when a nonexistent method or property is accessed.
151+
<div class="features"><span class="feature">inherited</span></div>
152+
153+
</dd>
154+
155+
<dt id="toString" class="callable">
156+
<span class="name"><a href="../askar_wrapper_dart/AeadParams/toString.html">toString</a></span><span class="signature">(<wbr>)
157+
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
158+
</span>
159+
160+
161+
</dt>
162+
<dd>
163+
A string representation of this object.
164+
<div class="features"><span class="feature">override</span></div>
165+
166+
</dd>
167+
168+
</dl>
169+
</section>
170+
171+
<section
172+
class="summary offset-anchor inherited"
173+
id="operators">
174+
<h2>Operators</h2>
175+
<dl class="callables">
176+
<dt id="operator ==" class="callable inherited">
177+
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
178+
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
179+
</span>
180+
181+
182+
</dt>
183+
<dd class="inherited">
184+
The equality operator.
185+
<div class="features"><span class="feature">inherited</span></div>
186+
187+
</dd>
188+
189+
</dl>
190+
</section>
191+
192+
193+
194+
195+
</div> <!-- /.main-content -->
196+
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
197+
<!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
198+
<header id="header-search-sidebar" class="hidden-l">
199+
<form class="search-sidebar" role="search">
200+
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
201+
</form>
202+
</header>
203+
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
204+
<li><a href="../index.html">askar_wrapper_dart</a></li>
205+
<li><a href="../askar_wrapper_dart">askar_wrapper_dart</a></li>
206+
<li class="self-crumb">AeadParams class</li>
207+
</ol>
208+
209+
<h5>askar_wrapper_dart library</h5>
210+
<div id="dartdoc-sidebar-left-content"></div>
211+
</div>
212+
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
213+
</div><!--/.sidebar-offcanvas-->
214+
</main>
215+
<footer>
216+
<span class="no-break">
217+
askar_wrapper_dart
218+
0.0.1
219+
</span>
220+
221+
</footer>
222+
223+
224+
<script src="../static-assets/highlight.pack.js?v1"></script>
225+
<script src="../static-assets/docs.dart.js"></script>
226+
227+
</body>
228+
</html>
229+

0 commit comments

Comments
 (0)