docs: added project code documentation
This commit is contained in:
parent
07584a48a1
commit
0465851ec5
2866 changed files with 64165 additions and 0 deletions
166
docs/flutterdocs/main/main.html
Normal file
166
docs/flutterdocs/main/main.html
Normal file
|
|
@ -0,0 +1,166 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
|
||||
<meta name="description" content="API docs for the main function from the main library, for the Dart programming language.">
|
||||
<title>main function - main library - Dart API</title>
|
||||
|
||||
|
||||
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com">
|
||||
<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">
|
||||
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
|
||||
|
||||
<link rel="stylesheet" href="../static-assets/github.css?v1">
|
||||
<link rel="stylesheet" href="../static-assets/styles.css?v1">
|
||||
<link rel="icon" href="../static-assets/favicon.png?v1">
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body data-base-href="../" data-using-base-href="false" class="light-theme">
|
||||
|
||||
<div id="overlay-under-drawer"></div>
|
||||
|
||||
<header id="title">
|
||||
<span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
|
||||
<ol class="breadcrumbs gt-separated dark hidden-xs">
|
||||
<li><a href="../index.html">flutter_test_gui</a></li>
|
||||
<li><a href="../main/main-library.html">main.dart</a></li>
|
||||
<li class="self-crumb">main function</li>
|
||||
</ol>
|
||||
<div class="self-name">main</div>
|
||||
<form class="search navbar-right" role="search">
|
||||
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
|
||||
</form>
|
||||
<div class="toggle" id="theme-button" title="Toggle brightness">
|
||||
<label for="theme">
|
||||
<input type="checkbox" id="theme" value="light-theme">
|
||||
<span id="dark-theme-button" class="material-symbols-outlined">
|
||||
dark_mode
|
||||
</span>
|
||||
<span id="light-theme-button" class="material-symbols-outlined">
|
||||
light_mode
|
||||
</span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<main>
|
||||
|
||||
<div
|
||||
id="dartdoc-main-content"
|
||||
class="main-content"
|
||||
data-above-sidebar="main/main-library-sidebar.html"
|
||||
data-below-sidebar="">
|
||||
<div>
|
||||
<h1><span class="kind-function">main</span> function
|
||||
|
||||
</h1></div>
|
||||
|
||||
<section class="multi-line-signature">
|
||||
|
||||
|
||||
<span class="returntype"><a href="https://api.flutter.dev/flutter/dart-async/Future-class.html">Future</a><span class="signature"><<wbr><span class="type-parameter">void</span>></span></span>
|
||||
<span class="name ">main</span>(<wbr>)
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
<section class="desc markdown">
|
||||
<p>Main entrypoint of the application.</p>
|
||||
<p>This function is called when the application starts. It initializes the
|
||||
Rust library, sets up the application widget, and shows the window.</p>
|
||||
<p>The function first calls the <code>RustLib.init</code> function to initialize the
|
||||
Rust library. Then, it runs the application using the <a href="https://api.flutter.dev/flutter/widgets/runApp.html">runApp</a> function
|
||||
with the <a href="../main/MyApp-class.html">MyApp</a> widget. If the application is running on Windows, Linux,
|
||||
or macOS, it sets up the window properties such as the minimum size,
|
||||
initial size, alignment, and title. Finally, it shows the window.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<section class="summary source-code" id="source">
|
||||
<h2><span>Implementation</span></h2>
|
||||
<pre class="language-dart"><code class="language-dart">Future<void> main() async {
|
||||
// Initialize the Rust library
|
||||
await RustLib.init();
|
||||
|
||||
// Set up the application widget
|
||||
runApp(const MyApp());
|
||||
|
||||
// Set up the window properties if running on Windows, Linux, or macOS
|
||||
if (Platform.isWindows || Platform.isLinux || Platform.isMacOS) {
|
||||
doWhenWindowReady(() {
|
||||
final win = appWindow;
|
||||
|
||||
// Set the minimum size of the window
|
||||
const initialSize = Size(720, 512);
|
||||
win.minSize = initialSize;
|
||||
|
||||
// Set the initial size of the window
|
||||
win.size = initialSize;
|
||||
|
||||
// Set the alignment of the window
|
||||
win.alignment = Alignment.center;
|
||||
|
||||
// Set the title of the window
|
||||
win.title = 'Caesar Test Demo';
|
||||
|
||||
// Show the window
|
||||
win.show();
|
||||
});
|
||||
}
|
||||
}</code></pre>
|
||||
</section>
|
||||
|
||||
|
||||
</div> <!-- /.main-content -->
|
||||
|
||||
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
|
||||
<!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
|
||||
<header id="header-search-sidebar" class="hidden-l">
|
||||
<form class="search-sidebar" role="search">
|
||||
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
|
||||
</form>
|
||||
</header>
|
||||
|
||||
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
|
||||
<li><a href="../index.html">flutter_test_gui</a></li>
|
||||
<li><a href="../main/main-library.html">main</a></li>
|
||||
<li class="self-crumb">main function</li>
|
||||
</ol>
|
||||
|
||||
|
||||
<h5>main library</h5>
|
||||
<div id="dartdoc-sidebar-left-content"></div>
|
||||
</div><!--/.sidebar-offcanvas-left-->
|
||||
|
||||
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
|
||||
</div><!--/.sidebar-offcanvas-->
|
||||
|
||||
</main>
|
||||
|
||||
<footer>
|
||||
<span class="no-break">
|
||||
flutter_test_gui
|
||||
1.0.0+1
|
||||
</span>
|
||||
|
||||
|
||||
</footer>
|
||||
|
||||
|
||||
|
||||
<script src="../static-assets/highlight.pack.js?v1"></script>
|
||||
<script src="../static-assets/docs.dart.js"></script>
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue