Skip to content

Commit 4830931

Browse files
luckysmgluckysmg
authored
规范核心API的注释，生成dartdoc文件，所有代码逻辑未修改 (alibaba#1328)
* 所有代码逻辑未修改，仅对dart文档注释补全优化，代码格式化 * 提交生成的dartdoc Co-authored-by: MuChen <[email protected]>
1 parent bc4ad9b commit 4830931

File tree

267 files changed

+52363
-4
lines changed

Some content is hidden

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

267 files changed

+52363
-4
lines changed

‎doc/api/__404error.html‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
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="generator" content="made with love by dartdoc 1.0.2">
8+
<meta name="description" content="flutter_boost API docs, for the Dart programming language.">
9+
<title>flutter_boost - Dart API docs</title>
10+
11+
12+
13+
<link rel="preconnect" href="https://fonts.gstatic.com">
14+
<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">
15+
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
16+
17+
<link rel="stylesheet" href="static-assets/github.css?v1">
18+
<link rel="stylesheet" href="static-assets/styles.css?v1">
19+
<link rel="icon" href="static-assets/favicon.png?v1">
20+
21+
22+
</head>
23+
24+
25+
<body data-base-href=""
26+
data-using-base-href="false">
27+
28+
<div id="overlay-under-drawer"></div>
29+
30+
<header id="title">
31+
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
32+
<ol class="breadcrumbs gt-separated dark hidden-xs">
33+
<li><a href="https://github.com/alibaba/flutter_boost">flutter_boost package</a></li>
34+
</ol>
35+
<div class="self-name">flutter_boost</div>
36+
<form class="search navbar-right" role="search">
37+
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
38+
</form>
39+
</header>
40+
41+
<main>
42+
43+
44+
<div id="dartdoc-main-content" class="main-content">
45+
<h1>404: Something's gone wrong :-(</h1>
46+
47+
<section class="desc">
48+
<p>You've tried to visit a page that doesn't exist. Luckily this site
49+
has other <a href="index.html">pages</a>.</p>
50+
<p>If you were looking for something specific, try searching:
51+
<form class="search-body" role="search">
52+
<input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
53+
</form>
54+
</p>
55+
56+
</section>
57+
</div> <!-- /.main-content -->
58+
59+
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
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+
66+
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
67+
<li><a href="https://github.com/alibaba/flutter_boost">flutter_boost package</a></li>
68+
</ol>
69+
70+
71+
<h5><span class="package-name">flutter_boost</span> <span class="package-kind">package</span></h5>
72+
<ol>
73+
<li class="section-title">Libraries</li>
74+
<li><a href="boost_channel/boost_channel-library.html">boost_channel</a></li>
75+
<li><a href="boost_container/boost_container-library.html">boost_container</a></li>
76+
<li><a href="boost_flutter_binding/boost_flutter_binding-library.html">boost_flutter_binding</a></li>
77+
<li><a href="boost_flutter_router_api/boost_flutter_router_api-library.html">boost_flutter_router_api</a></li>
78+
<li><a href="boost_interceptor/boost_interceptor-library.html">boost_interceptor</a></li>
79+
<li><a href="boost_lifecycle_binding/boost_lifecycle_binding-library.html">boost_lifecycle_binding</a></li>
80+
<li><a href="boost_navigator/boost_navigator-library.html">boost_navigator</a></li>
81+
<li><a href="flutter_boost/flutter_boost-library.html">flutter_boost</a></li>
82+
<li><a href="flutter_boost_app/flutter_boost_app-library.html">flutter_boost_app</a></li>
83+
<li><a href="logger/logger-library.html">logger</a></li>
84+
<li><a href="messages/messages-library.html">messages</a></li>
85+
<li><a href="overlay_entry/overlay_entry-library.html">overlay_entry</a></li>
86+
<li><a href="page_visibility/page_visibility-library.html">page_visibility</a></li>
87+
</ol>
88+
89+
</div>
90+
91+
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
92+
</div>
93+
94+
</main>
95+
96+
<footer>
97+
<span class="no-break">
98+
flutter_boost
99+
3.0.0
100+
</span>
101+
102+
103+
</footer>
104+
105+
106+
107+
<script src="static-assets/highlight.pack.js?v1"></script>
108+
<script src="static-assets/script.js?v1"></script>
109+
110+
111+
112+
</body>
113+
114+
</html>
115+

‎doc/api/boost_channel/BoostChannel-class.html‎

Lines changed: 273 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,273 @@
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 BoostChannel class from the boost_channel library, for the Dart programming language.">
8+
<title>BoostChannel class - boost_channel 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/icon?family=Material+Icons" 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+
21+
</head>
22+
23+
24+
<body data-base-href="../"
25+
data-using-base-href="false">
26+
27+
<div id="overlay-under-drawer"></div>
28+
29+
<header id="title">
30+
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
31+
<ol class="breadcrumbs gt-separated dark hidden-xs">
32+
<li><a href="../index.html">flutter_boost</a></li>
33+
<li><a href="../boost_channel/boost_channel-library.html">boost_channel</a></li>
34+
<li class="self-crumb">BoostChannel class</li>
35+
</ol>
36+
<div class="self-name">BoostChannel</div>
37+
<form class="search navbar-right" role="search">
38+
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
39+
</form>
40+
</header>
41+
42+
<main>
43+
44+
45+
<div id="dartdoc-main-content" class="main-content">
46+
<div>
47+
<h1><span class="kind-class">BoostChannel</span> class
48+
49+
</h1></div>
50+
51+
52+
<section class="desc markdown">
53+
<p>The <a href="../boost_channel/BoostChannel-class.html">BoostChannel</a> is a tool to get <a href="../flutter_boost_app/FlutterBoostAppState-class.html">FlutterBoostAppState</a>
54+
to operate the Custom events</p>
55+
<p>We can get this by calling "BoostChannel.instance"</p>
56+
</section>
57+
58+
59+
60+
61+
<section class="summary offset-anchor inherited" id="instance-properties">
62+
<h2>Properties</h2>
63+
64+
<dl class="properties">
65+
<dt id="hashCode" class="property inherited">
66+
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
67+
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
68+
69+
</dt>
70+
<dd class="inherited">
71+
The hash code for this object. <a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">[...]</a>
72+
<div class="features">read-only, inherited</div>
73+
74+
</dd>
75+
76+
<dt id="runtimeType" class="property inherited">
77+
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
78+
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
79+
80+
</dt>
81+
<dd class="inherited">
82+
A representation of the runtime type of the object.
83+
<div class="features">read-only, inherited</div>
84+
85+
</dd>
86+
87+
</dl>
88+
</section>
89+
90+
<section class="summary offset-anchor" id="instance-methods">
91+
<h2>Methods</h2>
92+
<dl class="callables">
93+
<dt id="addEventListener" class="callable">
94+
<span class="name"><a href="../boost_channel/BoostChannel/addEventListener.html">addEventListener</a></span><span class="signature">(<wbr><span class="parameter" id="addEventListener-param-key"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">key</span>, </span><span class="parameter" id="addEventListener-param-listener"><span class="type-annotation"><a href="../boost_channel/EventListener.html">EventListener</a></span> <span class="parameter-name">listener</span></span>)
95+
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a></span>
96+
</span>
97+
98+
99+
</dt>
100+
<dd>
101+
Add event listener in flutter side, which is to listen
102+
the events from native side <a href="../boost_channel/BoostChannel/addEventListener.html">[...]</a>
103+
104+
105+
</dd>
106+
107+
<dt id="noSuchMethod" class="callable inherited">
108+
<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>)
109+
<span class="returntype parameter">&#8594; dynamic</span>
110+
</span>
111+
112+
113+
</dt>
114+
<dd class="inherited">
115+
Invoked when a non-existent method or property is accessed. <a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">[...]</a>
116+
<div class="features">inherited</div>
117+
118+
</dd>
119+
120+
<dt id="sendEventToNative" class="callable">
121+
<span class="name"><a href="../boost_channel/BoostChannel/sendEventToNative.html">sendEventToNative</a></span><span class="signature">(<wbr><span class="parameter" id="sendEventToNative-param-key"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">key</span>, </span><span class="parameter" id="sendEventToNative-param-args"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a></span> <span class="parameter-name">args</span></span>)
122+
<span class="returntype parameter">&#8594; void</span>
123+
</span>
124+
125+
126+
</dt>
127+
<dd>
128+
Send a custom event to native with <code>key</code> and <code>args</code>
129+
Calls when flutter(here) wants to send event to native side
130+
131+
132+
</dd>
133+
134+
<dt id="toString" class="callable inherited">
135+
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
136+
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
137+
</span>
138+
139+
140+
</dt>
141+
<dd class="inherited">
142+
A string representation of this object. <a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">[...]</a>
143+
<div class="features">inherited</div>
144+
145+
</dd>
146+
147+
</dl>
148+
</section>
149+
150+
<section class="summary offset-anchor inherited" id="operators">
151+
<h2>Operators</h2>
152+
<dl class="callables">
153+
<dt id="operator ==" class="callable inherited">
154+
<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>)
155+
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
156+
</span>
157+
158+
159+
</dt>
160+
<dd class="inherited">
161+
The equality operator. <a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">[...]</a>
162+
<div class="features">inherited</div>
163+
164+
</dd>
165+
166+
</dl>
167+
</section>
168+
169+
<section class="summary offset-anchor" id="static-properties">
170+
<h2>Static Properties</h2>
171+
172+
<dl class="properties">
173+
<dt id="instance" class="property">
174+
<span class="name"><a href="../boost_channel/BoostChannel/instance.html">instance</a></span>
175+
<span class="signature">&#8594; <a href="../boost_channel/BoostChannel-class.html">BoostChannel</a></span>
176+
177+
</dt>
178+
<dd>
179+
180+
<div class="features">read-only</div>
181+
182+
</dd>
183+
184+
</dl>
185+
</section>
186+
187+
188+
189+
</div> <!-- /.main-content -->
190+
191+
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
192+
<header id="header-search-sidebar" class="hidden-l">
193+
<form class="search-sidebar" role="search">
194+
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
195+
</form>
196+
</header>
197+
198+
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
199+
<li><a href="../index.html">flutter_boost</a></li>
200+
<li><a href="../boost_channel/boost_channel-library.html">boost_channel</a></li>
201+
<li class="self-crumb">BoostChannel class</li>
202+
</ol>
203+
204+
205+
<h5>boost_channel library</h5>
206+
<ol>
207+
<li class="section-title"><a href="../boost_channel/boost_channel-library.html#classes">Classes</a></li>
208+
<li><a href="../boost_channel/BoostChannel-class.html">BoostChannel</a></li>
209+
210+
211+
212+
213+
214+
215+
216+
<li class="section-title"><a href="../boost_channel/boost_channel-library.html#typedefs">Typedefs</a></li>
217+
<li><a href="../boost_channel/EventListener.html">EventListener</a></li>
218+
219+
</ol>
220+
221+
</div>
222+
223+
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
224+
<ol>
225+
226+
227+
228+
<li class="section-title inherited">
229+
<a href="../boost_channel/BoostChannel-class.html#instance-properties">Properties</a>
230+
</li>
231+
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
232+
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
233+
234+
<li class="section-title"><a href="../boost_channel/BoostChannel-class.html#instance-methods">Methods</a></li>
235+
<li><a href="../boost_channel/BoostChannel/addEventListener.html">addEventListener</a></li>
236+
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
237+
<li><a href="../boost_channel/BoostChannel/sendEventToNative.html">sendEventToNative</a></li>
238+
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
239+
240+
<li class="section-title inherited"><a href="../boost_channel/BoostChannel-class.html#operators">Operators</a></li>
241+
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>
242+
243+
244+
<li class="section-title"><a href="../boost_channel/BoostChannel-class.html#static-properties">Static properties</a></li>
245+
<li><a href="../boost_channel/BoostChannel/instance.html">instance</a></li>
246+
247+
248+
</ol>
249+
250+
</div><!--/.sidebar-offcanvas-->
251+
252+
</main>
253+
254+
<footer>
255+
<span class="no-break">
256+
flutter_boost
257+
3.0.0
258+
</span>
259+
260+
261+
</footer>
262+
263+
264+
265+
<script src="../static-assets/highlight.pack.js?v1"></script>
266+
<script src="../static-assets/script.js?v1"></script>
267+
268+
269+
270+
</body>
271+
272+
</html>
273+

0 commit comments

Comments
 (0)