Skip to content

Commit

Permalink
Add Dart Doc support
Browse files Browse the repository at this point in the history
This includes the Dart Doc generation
  • Loading branch information
anthonycastelli committed May 15, 2024
1 parent cea324b commit f18c29a
Show file tree
Hide file tree
Showing 59 changed files with 14,076 additions and 9 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ migrate_working_dir/
# Flutter/Dart/Pub related
# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
/pubspec.lock
**/doc/api/
.dart_tool/
build/
/.flutter-plugins-dependencies
Expand Down
8 changes: 0 additions & 8 deletions dartdoc_options.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
dartdoc:
categories:
"Get Started":
markdown: documentation/GET_STARTED.md
name: Get Started
"Tracking":
markdown: documentation/TRACKING.md
name: Tracking
categoryOrder: ["Get Started", "Second Category"]
nodoc:
- "lib/networking/*.dart"
- "lib/caching/*.dart"
114 changes: 114 additions & 0 deletions doc/api/__404error.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
<!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="generator" content="made with love by dartdoc 8.0.3">
<meta name="description" content="appfit API docs, for the Dart programming language.">
<title>appfit - Dart API docs</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@48,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="https://appfit.io">appfit package</a></li>
</ol>
<div class="self-name">appfit</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">
<label for="theme">
<input type="checkbox" id="theme" value="light-theme">
<span id="dark-theme-button" class="material-symbols-outlined">
brightness_4
</span>
<span id="light-theme-button" class="material-symbols-outlined">
brightness_5
</span>
</label>
</div>
</header>
<main>

<div id="dartdoc-main-content" class="main-content">
<h1>404: Something's gone wrong :-(</h1>

<section class="desc">
<p>You've tried to visit a page that doesn't exist. Luckily this site
has other <a href="index.html">pages</a>.</p>
<p>If you were looking for something specific, try searching:
<form class="search-body" role="search">
<input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</p>

</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="https://appfit.io">appfit package</a></li>
</ol>


<h5><span class="package-name">appfit</span> <span class="package-kind">package</span></h5>
<ol>
<li class="section-title">Libraries</li>
<li><a href="appfit/appfit-library.html">appfit</a></li>
<li><a href="appfit_configuration/appfit_configuration-library.html">appfit_configuration</a></li>
<li><a href="appfit_event/appfit_event-library.html">appfit_event</a></li>
</ol>

</div>

<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
</div>

</main>

<footer>
<span class="no-break">
appfit
1.0.0
</span>


</footer>



<script src="static-assets/highlight.pack.js?v1"></script>
<script src="static-assets/docs.dart.js"></script>



</body>

</html>

31 changes: 31 additions & 0 deletions doc/api/appfit/AppFit-class-sidebar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<ol>

<li class="section-title"><a href="appfit/AppFit-class.html#constructors">Constructors</a></li>
<li><a href="appfit/AppFit/AppFit.html">AppFit</a></li>



<li class="section-title">
<a href="appfit/AppFit-class.html#instance-properties">Properties</a>
</li>
<li><a href="appfit/AppFit/configuration.html">configuration</a></li>
<li><a href="appfit/AppFit/eventDigester.html">eventDigester</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>

<li class="section-title"><a href="appfit/AppFit-class.html#instance-methods">Methods</a></li>
<li><a href="appfit/AppFit/identifyUser.html">identifyUser</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
<li><a href="appfit/AppFit/track.html">track</a></li>
<li><a href="appfit/AppFit/trackEvent.html">trackEvent</a></li>

<li class="section-title inherited"><a href="appfit/AppFit-class.html#operators">Operators</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>






</ol>
Loading

0 comments on commit f18c29a

Please sign in to comment.