Skip to content

Commit b554bb9

Browse files
ssferrazssferraz
committed
add dartdoc CI
1 parent efe4a90 commit b554bb9

File tree

454 files changed

+66951
-2
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

+66951
-2
lines changed

‎.github/workflows/dart.yml‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
uses: flutter-actions/setup-flutter@v4
2626
with:
2727
channel: stable
28-
version: 3.27.1
28+
version: 3.29.0
2929

3030
- name: Install dependencies
3131
run: flutter pub get
@@ -43,3 +43,15 @@ jobs:
4343
# want to change this to 'flutter test'.
4444
- name: Run tests
4545
run: flutter test
46+
47+
# Generate documentation
48+
- name: Generate documentation
49+
run: dart doc
50+
51+
# Upload documentation as an artifact
52+
- name: Upload documentation
53+
uses: actions/upload-artifact@v4
54+
with:
55+
name: dartdoc
56+
path: doc/api
57+

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ migrate_working_dir/
2424
#.vscode/
2525

2626
# Flutter/Dart/Pub related
27-
**/doc/api/
2827
**/ios/Flutter/.last_build_id
2928
.dart_tool/
3029
.flutter-plugins

‎doc/api/__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+

‎doc/api/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>

0 commit comments

Comments
 (0)