Skip to content
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.

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

Generate docs for enum static methods. #3697

Merged
merged 3 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
5 changes: 4 additions & 1 deletion lib/src/generator/file_structure.dart
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ abstract class FileStructure {
// This should be the common case.
FileStructure._fromModelElement(documentable),
_ => throw UnimplementedError(
'Tried to build a FileStructure for an unknown subtype of Documentable: ${documentable.runtimeType}')
'Tried to build a FileStructure for an unknown subtype of '
"Documentable: '${documentable.runtimeType}'")
};
}

Expand All @@ -42,6 +43,8 @@ abstract class FileStructure {
return switch (modelElement) {
Library() => FileStructureImpl(modelElement.dirName, 'library'),
Mixin() => FileStructureImpl(modelElement.name, 'mixin'),
// Probably just an archaic state, but enums do not have a file suffix.
Enum() => FileStructureImpl(modelElement.name, null),
Class() => FileStructureImpl(modelElement.name, 'class'),
ExtensionType() => FileStructureImpl(modelElement.name, 'extension-type'),
Operator() => FileStructureImpl(
Expand Down
24 changes: 12 additions & 12 deletions lib/src/generator/generator_backend.dart
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,11 @@ abstract class GeneratorBackend {
runtimeStats.incrementAccumulator('writtenCategoryFileCount');
}

/// Emits documentation content for the [clazz].
void generateClass(PackageGraph packageGraph, Library library, Class clazz) {
var data = ClassTemplateData(options, packageGraph, library, clazz);
/// Emits documentation content for the [class_].
void generateClass(PackageGraph packageGraph, Library library, Class class_) {
var data = ClassTemplateData(options, packageGraph, library, class_);
var content = templates.renderClass(data);
write(writer, clazz.filePath, data, content);
write(writer, class_.filePath, data, content);
runtimeStats.incrementAccumulator('writtenClassFileCount');
}

Expand All @@ -143,11 +143,11 @@ abstract class GeneratorBackend {
runtimeStats.incrementAccumulator('writtenConstructorFileCount');
}

/// Emits documentation content for the [eNum].
void generateEnum(PackageGraph packageGraph, Library library, Enum eNum) {
var data = EnumTemplateData(options, packageGraph, library, eNum);
/// Emits documentation content for the [enum_].
void generateEnum(PackageGraph packageGraph, Library library, Enum enum_) {
var data = EnumTemplateData(options, packageGraph, library, enum_);
var content = templates.renderEnum(data);
write(writer, eNum.filePath, data, content);
write(writer, enum_.filePath, data, content);
runtimeStats.incrementAccumulator('writtenEnumFileCount');
}

Expand Down Expand Up @@ -189,9 +189,9 @@ abstract class GeneratorBackend {

/// Emits documentation content for the [method].
void generateMethod(PackageGraph packageGraph, Library library,
Container clazz, Method method) {
Container container, Method method) {
var data =
MethodTemplateData(options, packageGraph, library, clazz, method);
MethodTemplateData(options, packageGraph, library, container, method);
var content = templates.renderMethod(data);
write(writer, method.filePath, data, content);
runtimeStats.incrementAccumulator('writtenMethodFileCount');
Expand All @@ -215,9 +215,9 @@ abstract class GeneratorBackend {

/// Emits documentation content for the [field].
void generateProperty(PackageGraph packageGraph, Library library,
Container clazz, Field field) {
Container container, Field field) {
var data =
PropertyTemplateData(options, packageGraph, library, clazz, field);
PropertyTemplateData(options, packageGraph, library, container, field);
var content = templates.renderProperty(data);
write(writer, field.filePath, data, content);
runtimeStats.incrementAccumulator('writtenPropertyFileCount');
Expand Down
Loading