Skip to content

wip #4097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

wip #4097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions lib/src/generator/generator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,21 @@ abstract class FileWriter {
}

/// A generator generates documentation for a given package.
///
/// Generators can generate documentation in different formats: HTML, JSON, etc.
class Generator {
abstract class Generator {
Future<void> generate(PackageGraph? packageGraph);
Set<String> get writtenFiles;
}

/// A [DartdocModelGenerator] generates documentation for a given package
/// analyzed in the dartdoc model.
class DartdocModelGenerator implements Generator {
/// Depending on the given [GeneratorBackend] it can generate documentation
/// in different formats: HTML, JSON, etc.
final GeneratorBackend _generatorBackend;

Generator(this._generatorBackend);
DartdocModelGenerator(this._generatorBackend);

@override
Future<void> generate(PackageGraph? packageGraph) async {
await _generatorBackend.generateAdditionalFiles();

Expand All @@ -60,6 +68,7 @@ class Generator {
_generatorBackend.generateSearchIndex(indexElements);
}

@override
Set<String> get writtenFiles => _generatorBackend.writer.writtenFiles;

/// Traverses the [packageGraph] and generates documentation for all contained
Expand Down Expand Up @@ -318,5 +327,5 @@ Generator initHtmlGenerator(
var options = DartdocGeneratorBackendOptions.fromContext(context);
var generatorBackend = HtmlGeneratorBackend(
options, templates, writer, context.resourceProvider);
return Generator(generatorBackend);
return DartdocModelGenerator(generatorBackend);
}
Loading