diff --git a/lib/src/generator/generator_frontend.dart b/lib/src/generator/generator_frontend.dart index 08d9f3caff..6bfcf2c769 100644 --- a/lib/src/generator/generator_frontend.dart +++ b/lib/src/generator/generator_frontend.dart @@ -168,14 +168,6 @@ class GeneratorFrontEnd implements Generator { indexAccumulator.add(mixin); _generatorBackend.generateMixin(writer, packageGraph, lib, mixin); - for (var constructor in filterNonDocumented(mixin.constructors)) { - if (!constructor.isCanonical) continue; - - indexAccumulator.add(constructor); - _generatorBackend.generateConstructor( - writer, packageGraph, lib, mixin, constructor); - } - for (var constant in filterNonDocumented(mixin.constantFields)) { if (!constant.isCanonical) continue; indexAccumulator.add(constant); diff --git a/lib/src/generator/template_data.dart b/lib/src/generator/template_data.dart index 594816fd50..e82681be9a 100644 --- a/lib/src/generator/template_data.dart +++ b/lib/src/generator/template_data.dart @@ -173,34 +173,51 @@ class LibraryTemplateData extends TemplateData } /// Template data for Dart 2.1-style mixin declarations. -class MixinTemplateData extends ClassTemplateData { - final Mixin mixin; - +class MixinTemplateData extends InheritingContainerTemplateData { MixinTemplateData( TemplateOptions htmlOptions, PackageGraph packageGraph, Library library, - this.mixin, + Mixin mixin, LibrarySidebar _sidebarForLibrary, ContainerSidebar _sidebarForContainer) : super(htmlOptions, packageGraph, library, mixin, _sidebarForLibrary, _sidebarForContainer); + Mixin get mixin => clazz; + @override Mixin get self => mixin; } +/// Template data for Dart classes. +class ClassTemplateData extends InheritingContainerTemplateData { + ClassTemplateData( + TemplateOptions htmlOptions, + PackageGraph packageGraph, + Library library, + Class clazz, + LibrarySidebar _sidebarForLibrary, + ContainerSidebar _sidebarForContainer) + : super(htmlOptions, packageGraph, library, clazz, _sidebarForLibrary, + _sidebarForContainer); + + @override + Class get clazz => super.clazz; +} + /// Base template data class for [Class], [Enum], and [Mixin]. -class ClassTemplateData extends TemplateData +abstract class InheritingContainerTemplateData + extends TemplateData implements TemplateDataWithLibrary, TemplateDataWithContainer { - final Class clazz; + final InheritingContainer clazz; @override final Library library; Class _objectType; final LibrarySidebar _sidebarForLibrary; final ContainerSidebar _sidebarForContainer; - ClassTemplateData( + InheritingContainerTemplateData( TemplateOptions htmlOptions, PackageGraph packageGraph, this.library, @@ -335,7 +352,7 @@ class ConstructorTemplateData extends TemplateData 'for the Dart programming language.'; } -class EnumTemplateData extends ClassTemplateData { +class EnumTemplateData extends InheritingContainerTemplateData { EnumTemplateData( TemplateOptions htmlOptions, PackageGraph packageGraph, diff --git a/lib/src/generator/templates.aot_renderers_for_html.dart b/lib/src/generator/templates.aot_renderers_for_html.dart index 0ece2698bb..1dcabf64ff 100644 --- a/lib/src/generator/templates.aot_renderers_for_html.dart +++ b/lib/src/generator/templates.aot_renderers_for_html.dart @@ -8,25 +8,26 @@ // non-bool, non-Iterable field is non-null. // ignore_for_file: unused_local_variable -import 'dart:convert' as _i18; +import 'dart:convert' as _i19; import 'package:dartdoc/src/generator/template_data.dart' as _i1; -import 'package:dartdoc/src/model/accessor.dart' as _i16; +import 'package:dartdoc/src/model/accessor.dart' as _i17; import 'package:dartdoc/src/model/category.dart' as _i2; -import 'package:dartdoc/src/model/class.dart' as _i4; +import 'package:dartdoc/src/model/class.dart' as _i8; import 'package:dartdoc/src/model/constructor.dart' as _i11; -import 'package:dartdoc/src/model/documentable.dart' as _i17; +import 'package:dartdoc/src/model/container.dart' as _i4; +import 'package:dartdoc/src/model/documentable.dart' as _i18; import 'package:dartdoc/src/model/enum.dart' as _i12; import 'package:dartdoc/src/model/extension.dart' as _i13; import 'package:dartdoc/src/model/field.dart' as _i9; import 'package:dartdoc/src/model/library.dart' as _i3; import 'package:dartdoc/src/model/library_container.dart' as _i15; import 'package:dartdoc/src/model/method.dart' as _i10; -import 'package:dartdoc/src/model/mixin.dart' as _i5; -import 'package:dartdoc/src/model/model_function.dart' as _i7; +import 'package:dartdoc/src/model/mixin.dart' as _i16; +import 'package:dartdoc/src/model/model_function.dart' as _i6; import 'package:dartdoc/src/model/package.dart' as _i14; -import 'package:dartdoc/src/model/top_level_variable.dart' as _i6; -import 'package:dartdoc/src/model/typedef.dart' as _i8; +import 'package:dartdoc/src/model/top_level_variable.dart' as _i5; +import 'package:dartdoc/src/model/typedef.dart' as _i7; String renderCategory(_i1.CategoryTemplateData context0) { final buffer = StringBuffer(); @@ -79,8 +80,8 @@ String renderCategory(_i1.CategoryTemplateData context0) { if (context4 != null) { for (var context5 in context4) { buffer.write('\n '); - buffer.write( - _renderCategory_partial_class_3(context5, context1, context0)); + buffer.write(_renderCategory_partial_container_3( + context5, context1, context0)); } } buffer.writeln(); @@ -100,8 +101,8 @@ String renderCategory(_i1.CategoryTemplateData context0) { if (context6 != null) { for (var context7 in context6) { buffer.write('\n '); - buffer.write( - _renderCategory_partial_mixin_4(context7, context1, context0)); + buffer.write(_renderCategory_partial_container_3( + context7, context1, context0)); } } buffer.writeln(); @@ -122,7 +123,7 @@ String renderCategory(_i1.CategoryTemplateData context0) { for (var context9 in context8) { buffer.write('\n '); buffer.write( - _renderCategory_partial_constant_5(context9, context1, context0)); + _renderCategory_partial_constant_4(context9, context1, context0)); } } buffer.writeln(); @@ -142,7 +143,7 @@ String renderCategory(_i1.CategoryTemplateData context0) { if (context10 != null) { for (var context11 in context10) { buffer.write('\n '); - buffer.write(_renderCategory_partial_property_6( + buffer.write(_renderCategory_partial_property_5( context11, context1, context0)); } } @@ -163,7 +164,7 @@ String renderCategory(_i1.CategoryTemplateData context0) { if (context12 != null) { for (var context13 in context12) { buffer.write('\n '); - buffer.write(_renderCategory_partial_callable_7( + buffer.write(_renderCategory_partial_callable_6( context13, context1, context0)); } } @@ -184,8 +185,8 @@ String renderCategory(_i1.CategoryTemplateData context0) { if (context14 != null) { for (var context15 in context14) { buffer.write('\n '); - buffer.write( - _renderCategory_partial_class_3(context15, context1, context0)); + buffer.write(_renderCategory_partial_container_3( + context15, context1, context0)); } } buffer.writeln(); @@ -206,7 +207,7 @@ String renderCategory(_i1.CategoryTemplateData context0) { for (var context17 in context16) { buffer.write('\n '); buffer.write( - _renderCategory_partial_typedef_8(context17, context1, context0)); + _renderCategory_partial_typedef_7(context17, context1, context0)); } } buffer.writeln(); @@ -226,8 +227,8 @@ String renderCategory(_i1.CategoryTemplateData context0) { if (context18 != null) { for (var context19 in context18) { buffer.write('\n '); - buffer.write( - _renderCategory_partial_class_3(context19, context1, context0)); + buffer.write(_renderCategory_partial_container_3( + context19, context1, context0)); } } buffer.writeln(); @@ -243,7 +244,7 @@ String renderCategory(_i1.CategoryTemplateData context0) { @@ -264,13 +265,13 @@ String renderCategory(_i1.CategoryTemplateData context0) { buffer.writeEscaped(context0.self.kind.toString()); buffer.write(''' '''); - buffer.write(_renderCategory_partial_sidebar_for_category_11(context0)); + buffer.write(_renderCategory_partial_sidebar_for_category_10(context0)); buffer.writeln(); buffer.write(''' '''); - buffer.write(_renderCategory_partial_footer_12(context0)); + buffer.write(_renderCategory_partial_footer_11(context0)); buffer.writeln(); return buffer.toString(); @@ -494,7 +495,7 @@ String __renderCategory_partial_library_2_partial_categorization_0( return buffer.toString(); } -String _renderCategory_partial_class_3(_i4.Class context2, +String _renderCategory_partial_container_3(_i4.Container context2, _i2.Category context1, _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
- '''); - buffer.write(context2.linkedName.toString()); - buffer.write(context2.linkedGenericParameters.toString()); - buffer.write(''' '''); - buffer.write(__renderCategory_partial_mixin_4_partial_categorization_0( - context2, context1, context0)); - buffer.writeln(); - buffer.write(''' -
-
- '''); - buffer.write(context2.oneLineDoc.toString()); - buffer.write(' '); - buffer.write(context2.extendedDocLink.toString()); - buffer.writeln(); - buffer.write(''' -
-'''); - - return buffer.toString(); -} - -String __renderCategory_partial_mixin_4_partial_categorization_0( - _i5.Mixin context2, - _i2.Category context1, - _i1.CategoryTemplateData context0) { - final buffer = StringBuffer(); - if (context2.hasCategoryNames == true) { - var context3 = context2.displayedCategories; - if (context3 != null) { - for (var context4 in context3) { - buffer.write('\n '); - buffer.write(context4.categoryLabel.toString()); - } - } - } - buffer.writeln(); - - return buffer.toString(); -} - -String _renderCategory_partial_constant_5(_i6.TopLevelVariable context2, +String _renderCategory_partial_constant_4(_i5.TopLevelVariable context2, _i2.Category context1, _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
'''); - buffer.write(__renderCategory_partial_property_6_partial_categorization_0( + buffer.write(__renderCategory_partial_property_5_partial_categorization_0( context2, context1, context0)); buffer.writeln(); buffer.write(''' @@ -706,7 +656,7 @@ String _renderCategory_partial_property_6(_i6.TopLevelVariable context2, buffer.write(' '); buffer.write(context2.extendedDocLink.toString()); buffer.write('\n '); - buffer.write(__renderCategory_partial_property_6_partial_features_1( + buffer.write(__renderCategory_partial_property_5_partial_features_1( context2, context1, context0)); buffer.writeln(); buffer.write(''' @@ -716,8 +666,8 @@ String _renderCategory_partial_property_6(_i6.TopLevelVariable context2, return buffer.toString(); } -String __renderCategory_partial_property_6_partial_categorization_0( - _i6.TopLevelVariable context2, +String __renderCategory_partial_property_5_partial_categorization_0( + _i5.TopLevelVariable context2, _i2.Category context1, _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); @@ -735,8 +685,8 @@ String __renderCategory_partial_property_6_partial_categorization_0( return buffer.toString(); } -String __renderCategory_partial_property_6_partial_features_1( - _i6.TopLevelVariable context2, +String __renderCategory_partial_property_5_partial_features_1( + _i5.TopLevelVariable context2, _i2.Category context1, _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); @@ -750,7 +700,7 @@ String __renderCategory_partial_property_6_partial_features_1( return buffer.toString(); } -String _renderCategory_partial_callable_7(_i7.ModelFunctionTyped context2, +String _renderCategory_partial_callable_6(_i6.ModelFunctionTyped context2, _i2.Category context1, _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
'''); buffer.write( - ___renderCategory_partial_typedef_8_partial_type_2_partial_categorization_0( + ___renderCategory_partial_typedef_7_partial_type_2_partial_categorization_0( context2, context1, context0)); buffer.writeln(); buffer.write(''' @@ -975,7 +925,7 @@ String __renderCategory_partial_typedef_8_partial_type_2(_i8.Typedef context2, buffer.write(context2.extendedDocLink.toString()); buffer.write('\n '); buffer.write( - ___renderCategory_partial_typedef_8_partial_type_2_partial_features_1( + ___renderCategory_partial_typedef_7_partial_type_2_partial_features_1( context2, context1, context0)); buffer.writeln(); buffer.write(''' @@ -986,8 +936,8 @@ String __renderCategory_partial_typedef_8_partial_type_2(_i8.Typedef context2, } String - ___renderCategory_partial_typedef_8_partial_type_2_partial_categorization_0( - _i8.Typedef context2, + ___renderCategory_partial_typedef_7_partial_type_2_partial_categorization_0( + _i7.Typedef context2, _i2.Category context1, _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); @@ -1005,8 +955,8 @@ String return buffer.toString(); } -String ___renderCategory_partial_typedef_8_partial_type_2_partial_features_1( - _i8.Typedef context2, +String ___renderCategory_partial_typedef_7_partial_type_2_partial_features_1( + _i7.Typedef context2, _i2.Category context1, _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); @@ -1020,7 +970,7 @@ String ___renderCategory_partial_typedef_8_partial_type_2_partial_features_1( return buffer.toString(); } -String _renderCategory_partial_search_sidebar_9( +String _renderCategory_partial_search_sidebar_8( _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
@@ -1084,7 +1034,7 @@ String _renderCategory_partial_search_sidebar_9( return buffer.toString(); } -String _renderCategory_partial_packages_10(_i1.CategoryTemplateData context0) { +String _renderCategory_partial_packages_9(_i1.CategoryTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
    '''); var context1 = context0.localPackages; @@ -1160,7 +1110,7 @@ String _renderCategory_partial_packages_10(_i1.CategoryTemplateData context0) { return buffer.toString(); } -String _renderCategory_partial_sidebar_for_category_11( +String _renderCategory_partial_sidebar_for_category_10( _i1.CategoryTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
      '''); @@ -1387,7 +1337,7 @@ String _renderCategory_partial_sidebar_for_category_11( return buffer.toString(); } -String _renderCategory_partial_footer_12(_i1.CategoryTemplateData context0) { +String _renderCategory_partial_footer_11(_i1.CategoryTemplateData context0) { final buffer = StringBuffer(); buffer.write(''' @@ -1437,7 +1387,7 @@ String _renderCategory_partial_footer_12(_i1.CategoryTemplateData context0) { return buffer.toString(); } -String renderClass(_i1.ClassTemplateData context0) { +String renderClass(_i1.ClassTemplateData context0) { final buffer = StringBuffer(); buffer.write(_renderClass_partial_head_0(context0)); buffer.writeln(); @@ -1821,8 +1771,7 @@ String renderClass(_i1.ClassTemplateData context0) { return buffer.toString(); } -String _renderClass_partial_head_0( - _i1.ClassTemplateData context0) { +String _renderClass_partial_head_0(_i1.ClassTemplateData context0) { final buffer = StringBuffer(); buffer.write(''' @@ -1975,8 +1924,8 @@ String _renderClass_partial_head_0( return buffer.toString(); } -String _renderClass_partial_source_link_1( - _i4.Class context1, _i1.ClassTemplateData context0) { +String _renderClass_partial_source_link_1( + _i8.Class context1, _i1.ClassTemplateData context0) { final buffer = StringBuffer(); if (context1.hasSourceHref == true) { buffer.writeln(); @@ -1990,8 +1939,8 @@ String _renderClass_partial_source_link_1( return buffer.toString(); } -String _renderClass_partial_feature_set_2( - _i4.Class context1, _i1.ClassTemplateData context0) { +String _renderClass_partial_feature_set_2( + _i8.Class context1, _i1.ClassTemplateData context0) { final buffer = StringBuffer(); if (context1.hasFeatureSet == true) { var context2 = context1.displayedLanguageFeatures; @@ -2007,8 +1956,8 @@ String _renderClass_partial_feature_set_2( return buffer.toString(); } -String _renderClass_partial_categorization_3( - _i4.Class context1, _i1.ClassTemplateData context0) { +String _renderClass_partial_categorization_3( + _i8.Class context1, _i1.ClassTemplateData context0) { final buffer = StringBuffer(); if (context1.hasCategoryNames == true) { var context2 = context1.displayedCategories; @@ -2024,8 +1973,8 @@ String _renderClass_partial_categorization_3( return buffer.toString(); } -String _renderClass_partial_documentation_4( - _i4.Class context1, _i1.ClassTemplateData context0) { +String _renderClass_partial_documentation_4( + _i8.Class context1, _i1.ClassTemplateData context0) { final buffer = StringBuffer(); if (context1.hasDocumentation == true) { buffer.writeln(); @@ -2042,8 +1991,8 @@ String _renderClass_partial_documentation_4( return buffer.toString(); } -String _renderClass_partial_property_5( - _i9.Field context2, _i4.Class context1, _i1.ClassTemplateData context0) { +String _renderClass_partial_property_5( + _i9.Field context2, _i8.Class context1, _i1.ClassTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
      '''); @@ -2116,10 +2064,8 @@ String __renderClass_partial_property_5_partial_features_1( return buffer.toString(); } -String _renderClass_partial_callable_6( - _i10.Method context2, - _i4.Class context1, - _i1.ClassTemplateData context0) { +String _renderClass_partial_callable_6( + _i10.Method context2, _i8.Class context1, _i1.ClassTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
      '''); @@ -2202,8 +2145,8 @@ String __renderClass_partial_callable_6_partial_features_1( return buffer.toString(); } -String _renderClass_partial_constant_7( - _i9.Field context2, _i4.Class context1, _i1.ClassTemplateData context0) { +String _renderClass_partial_constant_7( + _i9.Field context2, _i8.Class context1, _i1.ClassTemplateData context0) { final buffer = StringBuffer(); buffer.write('''
      '''); @@ -2276,8 +2218,7 @@ String __renderClass_partial_constant_7_partial_features_1( return buffer.toString(); } -String _renderClass_partial_search_sidebar_8( - _i1.ClassTemplateData context0) { +String _renderClass_partial_search_sidebar_8(_i1.ClassTemplateData context0) { final buffer = StringBuffer(); buffer.write('''