docs: add dartdoc headers to dart files

This commit is contained in:
Ashley Venn 2026-06-29 21:16:35 -07:00
parent e5e532d56f
commit fc1d100b1f
107 changed files with 374 additions and 1 deletions

View file

@ -1 +1,4 @@
/// Exports the FocusFlow Flutter application entry points.
library;
export 'app/focus_flow_app.dart' show FocusFlowApp;

View file

@ -1,3 +1,6 @@
/// Composes the FocusFlow Flutter application around Demo Scheduler Composition.
library;
import 'package:scheduler_core/scheduler_core.dart';
import '../controllers/scheduler_command_controller.dart';

View file

@ -1,3 +1,6 @@
/// Composes the FocusFlow Flutter application around Focus Flow App.
library;
import 'package:flutter/material.dart';
import '../controllers/today_screen_controller.dart';

View file

@ -1 +1,4 @@
/// Provides compatibility composition exports for FocusFlow Flutter.
library;
export '../app/demo_scheduler_composition.dart' show DemoSchedulerComposition;

View file

@ -1,3 +1,6 @@
/// Coordinates Scheduler Command Controller state for the FocusFlow Flutter UI.
library;
import 'package:flutter/foundation.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Coordinates Scheduler Read Controller state for the FocusFlow Flutter UI.
library;
import 'package:flutter/foundation.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Coordinates Today Screen Controller state for the FocusFlow Flutter UI.
library;
import 'package:flutter/foundation.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Launches the FocusFlow Flutter desktop application.
library;
import 'package:flutter/material.dart';
import 'app/demo_scheduler_composition.dart';

View file

@ -1,3 +1,6 @@
/// Defines Today Screen Models models for the FocusFlow Flutter UI.
library;
import 'package:scheduler_core/scheduler_core.dart';
class RequiredBannerModel {

View file

@ -1,3 +1,6 @@
/// Defines Focus Flow Theme styling for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import 'focus_flow_tokens.dart';

View file

@ -1,3 +1,6 @@
/// Defines Focus Flow Tokens styling for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
abstract final class FocusFlowTokens {

View file

@ -1,3 +1,6 @@
/// Defines Scheduler Visual Tokens styling for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Renders the App Shell widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import '../theme/focus_flow_tokens.dart';

View file

@ -1,3 +1,6 @@
/// Renders the Backlog Pane widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Renders the Read State View widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import '../controllers/scheduler_read_controller.dart';

View file

@ -1,3 +1,6 @@
/// Renders the Required Banner widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import '../models/today_screen_models.dart';

View file

@ -1,3 +1,6 @@
/// Renders the Schedule Components widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Renders the Sidebar widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import '../theme/focus_flow_tokens.dart';

View file

@ -1,3 +1,6 @@
/// Renders the Task Selection Modal widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import '../models/today_screen_models.dart';

View file

@ -1,3 +1,6 @@
/// Renders Difficulty Bars pieces for the FocusFlow Flutter timeline.
library;
import 'package:flutter/material.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Renders Reward Icon pieces for the FocusFlow Flutter timeline.
library;
import 'package:flutter/material.dart';
import '../../theme/focus_flow_tokens.dart';

View file

@ -1,3 +1,6 @@
/// Renders Task Timeline Card pieces for the FocusFlow Flutter timeline.
library;
import 'package:flutter/material.dart';
import '../../models/today_screen_models.dart';

View file

@ -1,3 +1,6 @@
/// Renders Timeline Axis pieces for the FocusFlow Flutter timeline.
library;
import 'package:flutter/material.dart';
import '../../theme/focus_flow_tokens.dart';

View file

@ -1,3 +1,6 @@
/// Renders Timeline Geometry pieces for the FocusFlow Flutter timeline.
library;
import 'package:flutter/material.dart';
class TimelineGeometry {

View file

@ -1,3 +1,6 @@
/// Renders Timeline View pieces for the FocusFlow Flutter timeline.
library;
import 'package:flutter/material.dart';
import '../../models/today_screen_models.dart';

View file

@ -1,3 +1,6 @@
/// Renders the Today Pane widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Renders the Top Bar widget for the FocusFlow Flutter UI.
library;
import 'package:flutter/material.dart';
import '../theme/focus_flow_tokens.dart';

View file

@ -1,3 +1,6 @@
/// Tests Forbidden Imports behavior in the FocusFlow Flutter app.
library;
import 'dart:io';
import 'package:flutter_test/flutter_test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Widget behavior in the FocusFlow Flutter app.
library;
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Runs the Backup command for the Scheduler Backup package.
library;
import 'dart:io';
import 'package:scheduler_backup/backup.dart';

View file

@ -1,3 +1,6 @@
/// Implements Encrypted Backup behavior for the Scheduler Backup package.
library;
import 'dart:convert';
import 'dart:io';
import 'dart:math';

View file

@ -1,3 +1,6 @@
/// Tests Encrypted Backup behavior for the Scheduler Backup package.
library;
import 'dart:convert';
import 'dart:io';

View file

@ -1,3 +1,6 @@
/// Defines the Scheduler Core public library for the Scheduler Core package.
library;
// Public library entry point for the ADHD scheduling core.
//
// Import this file from app/UI code instead of importing individual files from

View file

@ -1,3 +1,6 @@
/// Implements Application Commands behavior for the Scheduler Core package.
library;
// Atomic V1 application commands.
//
// These use cases are the UI-facing mutation boundary. They load authoritative

View file

@ -1,3 +1,6 @@
/// Implements Application Layer behavior for the Scheduler Core package.
library;
// Application orchestration contracts for UI-facing use cases.
//
// This layer sits above the pure domain services and repository interfaces. It

View file

@ -1,3 +1,6 @@
/// Implements Application Management behavior for the Scheduler Core package.
library;
// V1 management queries and commands.
//
// These use cases cover non-scheduling surfaces such as backlog views, project

View file

@ -1,3 +1,6 @@
/// Implements Application Recovery behavior for the Scheduler Core package.
library;
// App-open/start-day recovery orchestration.
//
// This layer makes rollover explicit. Reading Today never runs recovery; a UI or

View file

@ -1,3 +1,6 @@
/// Implements Backlog behavior for the Scheduler Core package.
library;
// Backlog query helpers for the ADHD scheduling core.
//
// The backlog is not a separate database table in this starter model. It is a

View file

@ -1,3 +1,6 @@
/// Implements Child Tasks behavior for the Scheduler Core package.
library;
// Parent/child task ownership helpers.
//
// Child tasks are owned by one parent through `Task.parentTaskId`. This file

View file

@ -1,3 +1,6 @@
/// Implements Document Mapping behavior for the Scheduler Core package.
library;
// Adapter-neutral V1 document mapping helpers.
//
// These helpers use plain Dart map shapes only. They do not import database

View file

@ -1,3 +1,6 @@
/// Implements Document Migration behavior for the Scheduler Core package.
library;
// Legacy document migration helpers for the V1 persistence contract.
//
// The migration layer is intentionally plain Dart and side-effect free. Future

View file

@ -1,3 +1,6 @@
/// Implements Free Slots behavior for the Scheduler Core package.
library;
// Protected Free Slot helpers.
//
// Free slots are intentional rest, not empty capacity. They are represented as

View file

@ -1,3 +1,6 @@
/// Implements Locked Time behavior for the Scheduler Core package.
library;
// Locked-time modeling and expansion.
//
// Locked time is anything the flexible scheduler should treat as unavailable:

View file

@ -1,3 +1,6 @@
/// Implements Models behavior for the Scheduler Core package.
library;
// Core domain model for the ADHD scheduling starter project.
//
// This file intentionally contains small immutable value objects and enums. It

View file

@ -1,3 +1,6 @@
/// Implements Occupancy Policy behavior for the Scheduler Core package.
library;
// Central occupancy policy for V1 scheduling.
//
// This file keeps scheduler movement rules separate from UI timeline

View file

@ -1,3 +1,6 @@
/// Implements Persistence Contract behavior for the Scheduler Core package.
library;
// Adapter-neutral persistence contract helpers.
//
// This file defines stable field names and encoding conventions that document

View file

@ -1,3 +1,6 @@
/// Implements Project Statistics behavior for the Scheduler Core package.
library;
// Project-level aggregate statistics and deterministic learned suggestions.
//
// These types stay in the pure Dart core. They provide persistence-friendly

View file

@ -1,3 +1,6 @@
/// Implements Quick Capture behavior for the Scheduler Core package.
library;
// Low-friction capture flow.
//
// Quick capture is the "dump the thought before it disappears" path. The goal

View file

@ -1,3 +1,6 @@
/// Implements Reminder Policy behavior for the Scheduler Core package.
library;
// UI/platform-independent reminder policy.
//
// This file decides whether the core would deliver, suppress, defer, or require

View file

@ -1,3 +1,6 @@
/// Implements Repositories behavior for the Scheduler Core package.
library;
// Persistence boundary interfaces for the scheduling core.
//
// These interfaces are intentionally database-client-free. SQLite, in-memory,

View file

@ -1,3 +1,6 @@
/// Implements Scheduling Engine behavior for the Scheduler Core package.
library;
// Scheduling engine for the ADHD scheduling starter project.
//
// This file is the core timeline manipulation layer. It takes task data plus a

View file

@ -1,3 +1,6 @@
/// Implements Task Actions behavior for the Scheduler Core package.
library;
// Flexible task card actions.
//
// The main scheduling engine moves tasks through time. This file models the

View file

@ -1,3 +1,6 @@
/// Implements Task Lifecycle behavior for the Scheduler Core package.
library;
// Canonical task lifecycle transitions and internal activity records.
//
// This module keeps task state changes separate from UI buttons and scheduling

View file

@ -1,3 +1,6 @@
/// Implements Task Statistics behavior for the Scheduler Core package.
library;
// Quiet per-task history counters.
//
// The app design calls for recovery/reporting features that can notice repeated

View file

@ -1,3 +1,6 @@
/// Implements Time Contracts behavior for the Scheduler Core package.
library;
import 'models.dart';
/// Deterministic source of the current instant.

View file

@ -1,3 +1,6 @@
/// Implements Timeline State behavior for the Scheduler Core package.
library;
// UI-independent Today timeline view state.
//
// This file translates domain tasks into small display-ready value objects

View file

@ -1,3 +1,6 @@
/// Implements Today State behavior for the Scheduler Core package.
library;
// Application-level Today read model.
//
// This module builds UI-independent state for the Today and compact views. It

View file

@ -1,3 +1,6 @@
/// Tests Application Commands behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Application Layer behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Application Management behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Application Recovery behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Child Tasks behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Document Mapping behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Document Migration behavior for the Scheduler Core package.
library;
import 'dart:convert';
import 'dart:io';

View file

@ -1,3 +1,6 @@
/// Tests Domain Contracts behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Domain Invariants behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Edge Case Regression behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Free Slots behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Occupancy Policy behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Persistence Edge Cases behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Persistence Index Contract behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Project Statistics behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Reminder Policy behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Repositories behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Required Task Actions behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Scheduling Engine behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Scheduling Invariants behavior for the Scheduler Core package.
library;
import 'dart:math';
import 'package:scheduler_core/scheduler_core.dart';

View file

@ -1,3 +1,6 @@
/// Tests Surprise Task Logging behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Task Lifecycle behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Time Contracts behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Timeline State behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Today State behavior for the Scheduler Core package.
library;
import 'package:scheduler_core/scheduler_core.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Implements Export Controller behavior for the Scheduler Export package.
library;
import 'dart:convert';
import 'package:scheduler_core/scheduler_core.dart' as core;

View file

@ -1,3 +1,6 @@
/// Tests Export Controller behavior for the Scheduler Export package.
library;
import 'dart:convert';
import 'package:scheduler_core/scheduler_core.dart' as core;

View file

@ -1,3 +1,6 @@
/// Runs the Export command for the Scheduler Export Json package.
library;
import 'dart:io';
import 'package:scheduler_core/scheduler_core.dart' as core;

View file

@ -1,3 +1,6 @@
/// Implements Json Csv Writers behavior for the Scheduler Export Json package.
library;
import 'dart:convert';
import 'package:scheduler_core/scheduler_core.dart' as core;

View file

@ -1,3 +1,6 @@
/// Tests Export Json behavior for the Scheduler Export Json package.
library;
import 'dart:convert';
import 'dart:io';

View file

@ -1,3 +1,6 @@
/// Exercises Scheduler Flow integration behavior for the Scheduler Integration Tests package.
library;
import 'package:drift/native.dart';
import 'package:scheduler_core/scheduler_core.dart' as core;
import 'package:scheduler_notifications/notifications.dart';

View file

@ -1,3 +1,6 @@
/// Tests Scheduler Flow behavior for the Scheduler Integration Tests package.
library;
import '../integration/scheduler_flow_test.dart' as scheduler_flow_test;
void main() {

View file

@ -1,3 +1,6 @@
/// Implements Notification Adapter behavior for the Scheduler Notifications package.
library;
import 'dart:async';
/// Request to schedule one notification through a platform adapter.

View file

@ -1,3 +1,6 @@
/// Tests Fake Adapter behavior for the Scheduler Notifications package.
library;
import 'package:scheduler_notifications/notifications.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Notification Adapter Contract behavior for the Scheduler Notifications package.
library;
import 'package:scheduler_notifications/notifications.dart';
import 'package:test/test.dart';

View file

@ -1,2 +1,5 @@
/// Implements Desktop Notification Adapter behavior for the Scheduler Notifications Desktop package.
library;
export 'desktop_notification_adapter_stub.dart'
if (dart.library.io) 'desktop_notification_adapter_io.dart';

View file

@ -1,3 +1,6 @@
/// Implements Desktop Notification Adapter Io behavior for the Scheduler Notifications Desktop package.
library;
import 'dart:async';
import 'dart:convert';
import 'dart:io';

View file

@ -1,3 +1,6 @@
/// Implements Desktop Notification Adapter Stub behavior for the Scheduler Notifications Desktop package.
library;
import 'dart:async';
import 'package:scheduler_notifications/notifications.dart';

View file

@ -1,3 +1,6 @@
/// Tests Desktop Notification Adapter behavior for the Scheduler Notifications Desktop package.
library;
import 'dart:io';
import 'package:scheduler_notifications/notifications.dart';

View file

@ -1,3 +1,6 @@
/// Tests Repo Conformance behavior for the Scheduler Persistence package.
library;
import 'package:scheduler_core/scheduler_core.dart' as core;
import 'package:scheduler_persistence/persistence.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Repo Contract Smoke behavior for the Scheduler Persistence package.
library;
import 'package:scheduler_core/scheduler_core.dart' as core;
import 'package:scheduler_persistence/persistence.dart';
import 'package:test/test.dart';

View file

@ -1,3 +1,6 @@
/// Tests Memory Repository Conformance behavior for the Scheduler Persistence Memory package.
library;
import 'package:scheduler_persistence_memory/persistence_memory.dart';
import '../../scheduler_persistence/test/repo_conformance.dart';

View file

@ -1,3 +1,6 @@
/// Tests Scheduler Db behavior for the Scheduler Persistence Sqlite package.
library;
import 'package:drift/native.dart';
import 'package:scheduler_persistence_sqlite/sqlite.dart';
import 'package:test/test.dart';

Some files were not shown because too many files have changed in this diff Show more