Skip to content

Commit 7ac2a1c

Browse files
kallentukallentu
authored
Remove MD renderer factory and related markdown renderers. (#3599)
* Remove MD renderer factory and related markdown renderers. * Remove record type field renderer.
1 parent 9fd64a2 commit 7ac2a1c

16 files changed

+0
-620
lines changed

‎lib/src/generator/markdown_generator.dart

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎lib/src/generator/templates.dart

Lines changed: 0 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ import 'package:dartdoc/src/generator/resource_loader.dart';
4646
import 'package:dartdoc/src/generator/template_data.dart';
4747
import 'package:dartdoc/src/generator/templates.aot_renderers_for_html.dart'
4848
as aot_renderers_for_html;
49-
import 'package:dartdoc/src/generator/templates.aot_renderers_for_md.dart'
50-
as aot_renderers_for_md;
5149
import 'package:dartdoc/src/generator/templates.runtime_renderers.dart'
5250
as runtime_renderers;
5351
import 'package:dartdoc/src/model/annotation.dart';
@@ -211,84 +209,6 @@ class HtmlAotTemplates implements Templates {
211209
aot_renderers_for_html.renderTypedef(context);
212210
}
213211

214-
/// The [Templates] implementation which uses the render functions generated
215-
/// from the default Dartdoc Markdown templates.
216-
class MarkdownAotTemplates implements Templates {
217-
@override
218-
String renderCategory(CategoryTemplateData context) =>
219-
aot_renderers_for_md.renderCategory(context);
220-
221-
@override
222-
String renderClass<T extends Class>(ClassTemplateData context) =>
223-
aot_renderers_for_md.renderClass(context);
224-
225-
@override
226-
String renderConstructor(ConstructorTemplateData context) =>
227-
aot_renderers_for_md.renderConstructor(context);
228-
229-
@override
230-
String renderEnum(EnumTemplateData context) =>
231-
aot_renderers_for_md.renderEnum(context);
232-
233-
@override
234-
String renderError(PackageTemplateData context) =>
235-
aot_renderers_for_md.renderError();
236-
237-
@override
238-
String renderExtension(ExtensionTemplateData context) =>
239-
aot_renderers_for_md.renderExtension(context);
240-
241-
@override
242-
String renderExtensionType(ExtensionTypeTemplateData context) =>
243-
aot_renderers_for_md.renderExtensionType(context);
244-
245-
@override
246-
String renderFunction(FunctionTemplateData context) =>
247-
aot_renderers_for_md.renderFunction(context);
248-
249-
@override
250-
String renderIndex(PackageTemplateData context) =>
251-
aot_renderers_for_md.renderIndex(context);
252-
253-
@override
254-
String renderLibrary(LibraryTemplateData context) =>
255-
aot_renderers_for_md.renderLibrary(context);
256-
257-
@override
258-
String renderMethod(MethodTemplateData context) =>
259-
aot_renderers_for_md.renderMethod(context);
260-
261-
@override
262-
String renderMixin(MixinTemplateData context) =>
263-
aot_renderers_for_md.renderMixin(context);
264-
265-
@override
266-
String renderProperty(PropertyTemplateData context) =>
267-
aot_renderers_for_md.renderProperty(context);
268-
269-
@override
270-
String renderSearchPage(PackageTemplateData context) =>
271-
aot_renderers_for_md.renderSearchPage(context);
272-
273-
@override
274-
String renderSidebarForContainer(
275-
TemplateDataWithContainer<Documentable> context) =>
276-
aot_renderers_for_md.renderSidebarForContainer();
277-
278-
@override
279-
String renderSidebarForLibrary(
280-
TemplateDataWithLibrary<Documentable> context) =>
281-
aot_renderers_for_md.renderSidebarForLibrary();
282-
283-
@override
284-
String renderTopLevelProperty(TopLevelPropertyTemplateData context) =>
285-
aot_renderers_for_md.renderTopLevelProperty(context);
286-
287-
@override
288-
String renderTypedef(TypedefTemplateData context) =>
289-
aot_renderers_for_md.renderTypedef(context);
290-
}
291-
292212
/// The collection of [Template] objects parsed at runtime.
293213
class RuntimeTemplates implements Templates {
294214
@override

‎lib/src/render/attribute_renderer.dart

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,3 @@ class AttributeRendererHtml extends AttributeRenderer {
2828
String renderAnnotation(Annotation attribute) =>
2929
'@${attribute.linkedName}${_htmlEscape.convert(attribute.parameterText)}';
3030
}
31-
32-
/// A Markdown renderer for an [Attribute].
33-
class AttributeRendererMd extends AttributeRenderer {
34-
const AttributeRendererMd();
35-
36-
@override
37-
String renderAnnotation(Annotation attribute) =>
38-
'@${attribute.linkedName}${_htmlEscape.convert(attribute.parameterText)}';
39-
}

‎lib/src/render/category_renderer.dart

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -53,20 +53,3 @@ class CategoryRendererHtml implements CategoryRenderer {
5353
}
5454
}
5555
}
56-
57-
/// A markdown renderer for a [Category].
58-
class CategoryRendererMd implements CategoryRenderer {
59-
const CategoryRendererMd();
60-
61-
@override
62-
String renderCategoryLabel(Category category) => renderLinkedName(category);
63-
64-
@override
65-
String renderLinkedName(Category category) {
66-
final name = category.name;
67-
if (category.isDocumented) {
68-
return '[$name](${category.href})';
69-
}
70-
return name;
71-
}
72-
}

‎lib/src/render/element_type_renderer.dart

Lines changed: 0 additions & 181 deletions
Original file line numberDiff line numberDiff line change
@@ -207,184 +207,3 @@ class CallableElementTypeRendererHtml
207207
return buffer.toString();
208208
}
209209
}
210-
211-
// Markdown implementations.
212-
213-
abstract class ElementTypeRendererMd<T extends ElementType>
214-
extends ElementTypeRenderer<T> {
215-
const ElementTypeRendererMd();
216-
217-
String _renderLinkedName(
218-
T elementType, String name, Iterable<ElementType> typeArguments) {
219-
var buffer = StringBuffer()..write(name);
220-
if (typeArguments.isNotEmpty &&
221-
!typeArguments.every((t) => t.name == 'dynamic')) {
222-
buffer
223-
..write('&lt;')
224-
..writeAll(typeArguments.map((t) => t.linkedName), ', ')
225-
..write('>');
226-
}
227-
buffer.write(elementType.nullabilitySuffix);
228-
return buffer.toString();
229-
}
230-
231-
String _renderNameWithGenerics(
232-
T elementType, String name, Iterable<ElementType> typeArguments) {
233-
var buffer = StringBuffer()..write(name);
234-
if (typeArguments.isNotEmpty &&
235-
!typeArguments.every((t) => t.name == 'dynamic')) {
236-
buffer
237-
..write('&lt;')
238-
..writeAll(typeArguments.map((t) => t.nameWithGenerics), ', ')
239-
..write('>');
240-
}
241-
buffer.write(elementType.nullabilitySuffix);
242-
return buffer.toString();
243-
}
244-
}
245-
246-
class FunctionTypeElementTypeRendererMd
247-
extends ElementTypeRenderer<FunctionTypeElementType> {
248-
const FunctionTypeElementTypeRendererMd();
249-
250-
@override
251-
String renderLinkedName(FunctionTypeElementType elementType) {
252-
var parameterRenderer = const ParameterRendererMd();
253-
return wrapNullabilityParens(
254-
elementType,
255-
'${elementType.returnType.linkedName} '
256-
'${elementType.nameWithGenerics}'
257-
'('
258-
'${parameterRenderer.renderLinkedParams(elementType.parameters)}'
259-
')');
260-
}
261-
262-
@override
263-
String renderNameWithGenerics(FunctionTypeElementType elementType) {
264-
var buffer = StringBuffer()..write(elementType.name);
265-
if (elementType.typeFormals.isNotEmpty) {
266-
if (!elementType.typeFormals.every((t) => t.name == 'dynamic')) {
267-
buffer
268-
..write('&lt;')
269-
..writeAll(elementType.typeFormals.map((t) => t.name), ', ')
270-
..write('>');
271-
}
272-
}
273-
return buffer.toString();
274-
}
275-
}
276-
277-
class ParameterizedElementTypeRendererMd
278-
extends ElementTypeRendererMd<ParameterizedElementType> {
279-
const ParameterizedElementTypeRendererMd();
280-
281-
@override
282-
String renderLinkedName(ParameterizedElementType elementType) =>
283-
_renderLinkedName(
284-
elementType,
285-
elementType.modelElement.linkedName,
286-
elementType.typeArguments,
287-
);
288-
289-
@override
290-
String renderNameWithGenerics(ParameterizedElementType elementType) =>
291-
_renderNameWithGenerics(
292-
elementType,
293-
elementType.modelElement.name,
294-
elementType.typeArguments,
295-
);
296-
}
297-
298-
class RecordElementTypeRendererMd
299-
extends ElementTypeRendererMd<RecordElementType> {
300-
const RecordElementTypeRendererMd();
301-
302-
@override
303-
String renderLinkedName(RecordElementType elementType) {
304-
var buffer = StringBuffer()
305-
..write('(')
306-
..write(
307-
const RecordTypeFieldListMdRenderer().renderLinkedFields(elementType))
308-
..write(')');
309-
return wrapNullabilityParens(elementType, buffer.toString());
310-
}
311-
312-
@override
313-
String renderNameWithGenerics(RecordElementType elementType) {
314-
return '${elementType.name}${elementType.nullabilitySuffix}';
315-
}
316-
}
317-
318-
class AliasedElementTypeRendererMd
319-
extends ElementTypeRendererMd<AliasedElementType> {
320-
const AliasedElementTypeRendererMd();
321-
322-
@override
323-
String renderLinkedName(AliasedElementType elementType) => _renderLinkedName(
324-
elementType,
325-
elementType.aliasElement.linkedName,
326-
elementType.aliasArguments,
327-
);
328-
329-
@override
330-
String renderNameWithGenerics(AliasedElementType elementType) =>
331-
_renderNameWithGenerics(
332-
elementType,
333-
elementType.aliasElement.name,
334-
elementType.aliasArguments,
335-
);
336-
}
337-
338-
class AliasedUndefinedElementTypeRendererMd
339-
extends ElementTypeRendererMd<AliasedUndefinedElementType> {
340-
const AliasedUndefinedElementTypeRendererMd();
341-
342-
@override
343-
String renderLinkedName(AliasedUndefinedElementType elementType) =>
344-
_renderLinkedName(
345-
elementType,
346-
elementType.aliasElement.linkedName,
347-
elementType.aliasArguments,
348-
);
349-
350-
@override
351-
String renderNameWithGenerics(AliasedUndefinedElementType elementType) =>
352-
_renderNameWithGenerics(
353-
elementType,
354-
elementType.aliasElement.name,
355-
elementType.aliasArguments,
356-
);
357-
}
358-
359-
class CallableElementTypeRendererMd
360-
extends ElementTypeRendererMd<CallableElementType> {
361-
const CallableElementTypeRendererMd();
362-
363-
@override
364-
String renderLinkedName(CallableElementType elementType) {
365-
var buffer = StringBuffer()
366-
..write(elementType.nameWithGenerics)
367-
..write('(')
368-
..write(const ParameterRendererMd()
369-
.renderLinkedParams(elementType.parameters, showNames: false)
370-
.trim())
371-
..write(') → ')
372-
..write(elementType.returnType.linkedName);
373-
return wrapNullabilityParens(elementType, buffer.toString());
374-
}
375-
376-
@override
377-
String renderNameWithGenerics(CallableElementType elementType) {
378-
var buffer = StringBuffer()..write(elementType.name);
379-
if (elementType.typeArguments.isNotEmpty &&
380-
!elementType.typeArguments.every((t) => t.name == 'dynamic')) {
381-
buffer
382-
..write('&lt;')
383-
..writeAll(
384-
elementType.typeArguments.map((t) => t.nameWithGenerics), ', ')
385-
..write('>');
386-
}
387-
buffer.write(elementType.nullabilitySuffix);
388-
return buffer.toString();
389-
}
390-
}

‎lib/src/render/enum_field_renderer.dart

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,3 @@ class EnumFieldRendererHtml implements EnumFieldRenderer {
3030
return '<a$cssClass href="${field.href}#${field.htmlId}">${field.name}</a>';
3131
}
3232
}
33-
34-
class EnumFieldRendererMd implements EnumFieldRenderer {
35-
const EnumFieldRendererMd();
36-
37-
@override
38-
String renderValue(EnumField field) {
39-
if (field.name == 'values') {
40-
return 'const List&lt;${field.enclosingElement.name}>';
41-
} else {
42-
return 'const ${field.enclosingElement.name}(${field.index})';
43-
}
44-
}
45-
46-
@override
47-
String renderLinkedName(EnumField field) {
48-
if (field.isDeprecated) {
49-
return '[~~${field.name}~~](${field.href})';
50-
}
51-
return '[${field.name}](${field.href})';
52-
}
53-
}

0 commit comments

Comments
 (0)