Skip to content

API reference

The guides explain behavior and decisions. Generated dartdoc remains the source for public constructor signatures, members, and documentation comments.

Published packages

After publication, pub.dev generates version-specific API documentation for each public library.

Public entrypoints

import 'package:ff_golden/ff_golden.dart';
import 'package:ff_golden_presenter/ff_golden_presenter.dart';

package:ff_golden/golden.dart is a deprecated compatibility entrypoint. New code should use ff_golden.dart. Do not import files below lib/src/.

Generate API docs locally

Run Pub resolution first, then generate or validate each package:

cd packages/ff_golden
flutter pub get
dart doc .
dart doc --dry-run .

cd packages/ff_golden_presenter
flutter pub get
dart doc .
dart doc --dry-run .

Generated files are written below doc/api by default and are intentionally ignored by Git. Serve that directory over HTTP for working search.

Source and examples