From 9dac6dc8ade659b8684ee8fabcf502357268fd99 Mon Sep 17 00:00:00 2001 From: Sarah Zakarias Date: Wed, 27 Aug 2025 09:15:30 +0000 Subject: [PATCH] Small cleanup around generators --- lib/src/dartdoc.dart | 1 - lib/src/generator/generator.dart | 14 ++++++++++++++ ..._generator.dart => html_generator_backend.dart} | 14 -------------- test/html_generator_test.dart | 2 +- 4 files changed, 15 insertions(+), 16 deletions(-) rename lib/src/generator/{html_generator.dart => html_generator_backend.dart} (90%) diff --git a/lib/src/dartdoc.dart b/lib/src/dartdoc.dart index 8c847ab564..26b952e277 100644 --- a/lib/src/dartdoc.dart +++ b/lib/src/dartdoc.dart @@ -10,7 +10,6 @@ import 'package:analyzer/file_system/file_system.dart'; import 'package:dartdoc/src/dartdoc_options.dart'; import 'package:dartdoc/src/failure.dart'; import 'package:dartdoc/src/generator/generator.dart'; -import 'package:dartdoc/src/generator/html_generator.dart'; import 'package:dartdoc/src/logging.dart'; import 'package:dartdoc/src/model/model.dart'; import 'package:dartdoc/src/package_meta.dart'; diff --git a/lib/src/generator/generator.dart b/lib/src/generator/generator.dart index 896e077136..8e81fd6731 100644 --- a/lib/src/generator/generator.dart +++ b/lib/src/generator/generator.dart @@ -7,6 +7,8 @@ library; import 'package:dartdoc/src/dartdoc_options.dart'; import 'package:dartdoc/src/generator/generator_backend.dart'; +import 'package:dartdoc/src/generator/html_generator_backend.dart'; +import 'package:dartdoc/src/generator/templates.dart'; import 'package:dartdoc/src/logging.dart'; import 'package:dartdoc/src/model/model.dart'; import 'package:dartdoc/src/model_utils.dart'; @@ -306,3 +308,15 @@ List createGeneratorOptions( 'SEO; learn more at https://goo.gl/gktN6F.'), ]; } + +/// Creates a [Generator] with an [HtmlGeneratorBackend] backend. +Generator initHtmlGenerator( + DartdocGeneratorOptionContext context, { + required FileWriter writer, +}) { + var templates = HtmlAotTemplates(); + var options = DartdocGeneratorBackendOptions.fromContext(context); + var generatorBackend = HtmlGeneratorBackend( + options, templates, writer, context.resourceProvider); + return Generator(generatorBackend); +} diff --git a/lib/src/generator/html_generator.dart b/lib/src/generator/html_generator_backend.dart similarity index 90% rename from lib/src/generator/html_generator.dart rename to lib/src/generator/html_generator_backend.dart index 9b5c136a7f..f64ffe19fa 100644 --- a/lib/src/generator/html_generator.dart +++ b/lib/src/generator/html_generator_backend.dart @@ -2,28 +2,14 @@ // for details. All rights reserved. Use of this source code is governed by a // BSD-style license that can be found in the LICENSE file. -import 'package:dartdoc/src/dartdoc_options.dart'; import 'package:dartdoc/src/generator/generator.dart'; import 'package:dartdoc/src/generator/generator_backend.dart'; import 'package:dartdoc/src/generator/html_resources.g.dart' as resources; import 'package:dartdoc/src/generator/resource_loader.dart'; import 'package:dartdoc/src/generator/template_data.dart'; -import 'package:dartdoc/src/generator/templates.dart'; import 'package:dartdoc/src/model/model.dart'; import 'package:dartdoc/src/runtime_stats.dart'; -/// Creates a [Generator] with an [HtmlGeneratorBackend] backend. -Generator initHtmlGenerator( - DartdocGeneratorOptionContext context, { - required FileWriter writer, -}) { - var templates = HtmlAotTemplates(); - var options = DartdocGeneratorBackendOptions.fromContext(context); - var generatorBackend = HtmlGeneratorBackend( - options, templates, writer, context.resourceProvider); - return Generator(generatorBackend); -} - /// Generator backend for HTML output. class HtmlGeneratorBackend extends GeneratorBackend { HtmlGeneratorBackend( diff --git a/test/html_generator_test.dart b/test/html_generator_test.dart index 8344af499c..28733143fb 100644 --- a/test/html_generator_test.dart +++ b/test/html_generator_test.dart @@ -9,7 +9,7 @@ import 'package:dartdoc/src/dartdoc.dart' show DartdocFileWriter; import 'package:dartdoc/src/dartdoc_options.dart'; import 'package:dartdoc/src/generator/generator.dart'; import 'package:dartdoc/src/generator/generator_backend.dart'; -import 'package:dartdoc/src/generator/html_generator.dart'; +import 'package:dartdoc/src/generator/html_generator_backend.dart'; import 'package:dartdoc/src/generator/html_resources.g.dart'; import 'package:dartdoc/src/generator/templates.dart'; import 'package:dartdoc/src/model/library.dart';