Skip to content

Commit 3c44922

Browse files
jcollins-gjcollins-g
authored
Update markdown templates post-refactor (#2208)
* intermediate * tests pass, ship it * Fix a missing variable static fields change in mixin template * Fix some remaining templating bugs * Review comments * Update markdown templates per #2206
1 parent 5da18a7 commit 3c44922

File tree

5 files changed

+100
-94
lines changed

5 files changed

+100
-94
lines changed

‎lib/templates/md/class.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -65,68 +65,68 @@
6565
{{#hasPublicConstructors}}
6666
## Constructors
6767

68-
{{#publicConstructors}}
68+
{{#publicConstructorsSorted}}
6969
{{{linkedName}}} ({{{ linkedParams }}})
7070

7171
{{{ oneLineDoc }}} {{{ extendedDocLink }}} {{!two spaces intentional}}
7272
{{#isConst}}_const_{{/isConst}} {{#isFactory}}_factory_{{/isFactory}}
7373

74-
{{/publicConstructors}}
74+
{{/publicConstructorsSorted}}
7575
{{/hasPublicConstructors}}
7676

77-
{{#hasPublicProperties}}
77+
{{#hasPublicInstanceFields}}
7878
## Properties
7979

80-
{{#allPublicInstanceProperties}}
80+
{{#publicInstanceFieldsSorted}}
8181
{{>property}}
8282

83-
{{/allPublicInstanceProperties}}
84-
{{/hasPublicProperties}}
83+
{{/publicInstanceFieldsSorted}}
84+
{{/hasPublicInstanceFields}}
8585

86-
{{#hasPublicMethods}}
86+
{{#hasPublicInstanceMethods}}
8787
## Methods
8888

89-
{{#allPublicInstanceMethods}}
89+
{{#publicInstanceMethodsSorted}}
9090
{{>callable}}
9191

92-
{{/allPublicInstanceMethods}}
93-
{{/hasPublicMethods}}
92+
{{/publicInstanceMethodsSorted}}
93+
{{/hasPublicInstanceMethods}}
9494

95-
{{#hasPublicOperators}}
95+
{{#hasPublicInstanceOperators}}
9696
## Operators
9797

98-
{{#allPublicOperators}}
98+
{{#publicInstanceOperatorsSorted}}
9999
{{>callable}}
100100

101-
{{/allPublicOperators}}
102-
{{/hasPublicOperators}}
101+
{{/publicInstanceOperatorsSorted}}
102+
{{/hasPublicInstanceOperators}}
103103

104-
{{#hasPublicStaticProperties}}
104+
{{#hasPublicVariableStaticFields}}
105105
## Static Properties
106106

107-
{{#publicStaticProperties}}
107+
{{#publicVariableStaticFieldsSorted}}
108108
{{>property}}
109109

110-
{{/publicStaticProperties}}
111-
{{/hasPublicStaticProperties}}
110+
{{/publicVariableStaticFieldsSorted}}
111+
{{/hasPublicVariableStaticFields}}
112112

113113
{{#hasPublicStaticMethods}}
114114
## Static Methods
115115

116-
{{#publicStaticMethods}}
116+
{{#publicStaticMethodsSorted}}
117117
{{>callable}}
118118

119-
{{/publicStaticMethods}}
119+
{{/publicStaticMethodsSorted}}
120120
{{/hasPublicStaticMethods}}
121121

122-
{{#hasPublicConstants}}
122+
{{#hasPublicConstantFields}}
123123
## Constants
124124

125-
{{#publicConstants}}
125+
{{#publicConstantFieldsSorted}}
126126
{{>constant}}
127127

128-
{{/publicConstants}}
129-
{{/hasPublicConstants}}
128+
{{/publicConstantFieldsSorted}}
129+
{{/hasPublicConstantFields}}
130130
{{/clazz}}
131131

132132
{{>footer}}

‎lib/templates/md/enum.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -54,70 +54,70 @@
5454
{{/hasAnnotations}}
5555
{{/hasModifiers}}
5656

57-
{{#hasPublicConstants}}
57+
{{#hasPublicConstantFields}}
5858
## Constants
5959

60-
{{#publicConstants}}
60+
{{#publicConstantFieldsSorted}}
6161
{{>constant}}
6262

63-
{{/publicConstants}}
64-
{{/hasPublicConstants}}
63+
{{/publicConstantFieldsSorted}}
64+
{{/hasPublicConstantFields}}
6565

6666
{{#hasPublicConstructors}}
6767
## Constructors
6868

69-
{{#publicConstructors}}
69+
{{#publicConstructorsSorted}}
7070
{{{linkedName}}}({{{ linkedParams }}})
7171

7272
{{{ oneLineDoc }}} {{{ extendedDocLink }}} {{!two spaces intentional}}
7373
{{#isConst}}_const_{{/isConst}} {{#isFactory}}_factory_{{/isFactory}}
7474

75-
{{/publicConstructors}}
75+
{{/publicConstructorsSorted}}
7676
{{/hasPublicConstructors}}
7777

78-
{{#hasPublicProperties}}
78+
{{#hasPublicInstanceFields}}
7979
## Properties
8080

81-
{{#allPublicInstanceProperties}}
81+
{{#publicInstanceFieldsSorted}}
8282
{{>property}}
8383

84-
{{/allPublicInstanceProperties}}
85-
{{/hasPublicProperties}}
84+
{{/publicInstanceFieldsSorted}}
85+
{{/hasPublicInstanceFields}}
8686

87-
{{#hasPublicMethods}}
87+
{{#hasPublicInstanceMethods}}
8888
## Methods
8989

90-
{{#allPublicInstanceMethods}}
90+
{{#publicInstanceMethodsSorted}}
9191
{{>callable}}
9292

93-
{{/allPublicInstanceMethods}}
94-
{{/hasPublicMethods}}
93+
{{/publicInstanceMethodsSorted}}
94+
{{/hasPublicInstanceMethods}}
9595

96-
{{#hasPublicOperators}}
96+
{{#hasPublicInstanceOperators}}
9797
## Operators
9898

99-
{{#allPublicOperators}}
99+
{{#publicInstanceOperatorsSorted}}
100100
{{>callable}}
101101

102-
{{/allPublicOperators}}
103-
{{/hasPublicOperators}}
102+
{{/publicInstanceOperatorsSorted}}
103+
{{/hasPublicInstanceOperators}}
104104

105-
{{#hasPublicStaticProperties}}
105+
{{#hasPublicVariableStaticFields}}
106106
## Static Properties
107107

108-
{{#publicStaticProperties}}
108+
{{#publicVariableStaticFieldsSorted}}
109109
{{>property}}
110110

111-
{{/publicStaticProperties}}
112-
{{/hasPublicStaticProperties}}
111+
{{/publicVariableStaticFieldsSorted}}
112+
{{/hasPublicVariableStaticFields}}
113113

114114
{{#hasPublicStaticMethods}}
115115
## Static Methods
116116

117-
{{#publicStaticMethods}}
117+
{{#publicStaticMethodsSorted}}
118118
{{>callable}}
119119

120-
{{/publicStaticMethods}}
120+
{{/publicStaticMethodsSorted}}
121121
{{/hasPublicStaticMethods}}
122122
{{/eNum}}
123123

‎lib/templates/md/extension.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,59 +12,59 @@ on {{#extendedType}}{{{linkedName}}}{{/extendedType}}
1212
{{#extension}}
1313
{{>documentation}}
1414

15-
{{#hasPublicProperties}}
15+
{{#hasPublicInstanceFields}}
1616
## Properties
1717

18-
{{#allPublicInstanceProperties}}
18+
{{#publicInstanceFieldsSorted}}
1919
{{>property}}
2020

21-
{{/allPublicInstanceProperties}}
22-
{{/hasPublicProperties}}
21+
{{/publicInstanceFieldsSorted}}
22+
{{/hasPublicInstanceFields}}
2323

24-
{{#hasPublicMethods}}
24+
{{#hasPublicInstanceMethods}}
2525
## Methods
2626

27-
{{#allPublicInstanceMethods}}
27+
{{#publicInstanceMethodsSorted}}
2828
{{>callable}}
2929

30-
{{/allPublicInstanceMethods}}
31-
{{/hasPublicMethods}}
30+
{{/publicInstanceMethodsSorted}}
31+
{{/hasPublicInstanceMethods}}
3232

33-
{{#hasPublicOperators}}
33+
{{#hasPublicInstanceOperators}}
3434
## Operators
3535

36-
{{#allPublicOperators}}
36+
{{#publicInstanceOperatorsSorted}}
3737
{{>callable}}
3838

39-
{{/allPublicOperators}}
40-
{{/hasPublicOperators}}
39+
{{/publicInstanceOperatorsSorted}}
40+
{{/hasPublicInstanceOperators}}
4141

42-
{{#hasPublicStaticProperties}}
42+
{{#hasPublicVariableStaticFields}}
4343
## Static Properties
4444

45-
{{#publicStaticProperties}}
45+
{{#publicVariableStaticFieldsSorted}}
4646
{{>property}}
4747

48-
{{/publicStaticProperties}}
49-
{{/hasPublicStaticProperties}}
48+
{{/publicVariableStaticFieldsSorted}}
49+
{{/hasPublicVariableStaticFields}}
5050

5151
{{#hasPublicStaticMethods}}
5252
## Static Methods
5353

54-
{{#publicStaticMethods}}
54+
{{#publicStaticMethodsSorted}}
5555
{{>callable}}
5656

57-
{{/publicStaticMethods}}
57+
{{/publicStaticMethodsSorted}}
5858
{{/hasPublicStaticMethods}}
5959

60-
{{#hasPublicConstants}}
60+
{{#hasPublicConstantFields}}
6161
## Constants
6262

63-
{{#publicConstants}}
63+
{{#publicConstantFieldsSorted}}
6464
{{>constant}}
6565

66-
{{/publicConstants}}
67-
{{/hasPublicConstants}}
66+
{{/publicConstantFieldsSorted}}
67+
{{/hasPublicConstantFields}}
6868
{{/extension}}
6969

7070
{{>footer}}

‎lib/templates/md/mixin.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -65,68 +65,68 @@
6565
{{#hasPublicConstructors}}
6666
## Constructors
6767

68-
{{#publicConstructors}}
68+
{{#publicConstructorsSorted}}
6969
{{{linkedName}}}({{{ linkedParams }}})
7070

7171
{{{ oneLineDoc }}} {{{ extendedDocLink }}} {{!two spaces intentional}}
7272
{{#isConst}}_const_{{/isConst}} {{#isFactory}}_factory_{{/isFactory}}
7373

74-
{{/publicConstructors}}
74+
{{/publicConstructorsSorted}}
7575
{{/hasPublicConstructors}}
7676

77-
{{#hasPublicProperties}}
77+
{{#hasPublicInstanceFields}}
7878
## Properties
7979

80-
{{#allPublicInstanceProperties}}
80+
{{#publicInstanceFieldsSorted}}
8181
{{>property}}
8282

83-
{{/allPublicInstanceProperties}}
84-
{{/hasPublicProperties}}
83+
{{/publicInstanceFieldsSorted}}
84+
{{/hasPublicInstanceFields}}
8585

86-
{{#hasPublicMethods}}
86+
{{#hasPublicInstanceMethods}}
8787
## Methods
8888

89-
{{#allPublicInstanceMethods}}
89+
{{#publicInstanceMethodsSorted}}
9090
{{>callable}}
9191

92-
{{/allPublicInstanceMethods}}
93-
{{/hasPublicMethods}}
92+
{{/publicInstanceMethodsSorted}}
93+
{{/hasPublicInstanceMethods}}
9494

95-
{{#hasPublicOperators}}
95+
{{#hasPublicInstanceOperators}}
9696
## Operators
9797

98-
{{#allPublicOperators}}
98+
{{#publicInstanceOperatorsSorted}}
9999
{{>callable}}
100100

101-
{{/allPublicOperators}}
102-
{{/hasPublicOperators}}
101+
{{/publicInstanceOperatorsSorted}}
102+
{{/hasPublicInstanceOperators}}
103103

104-
{{#hasPublicStaticProperties}}
104+
{{#hasPublicVariableStaticFields}}
105105
## Static Properties
106106

107-
{{#publicStaticProperties}}
107+
{{#publicVariableStaticFieldsSorted}}
108108
{{>property}}
109109

110-
{{/publicStaticProperties}}
111-
{{/hasPublicStaticProperties}}
110+
{{/publicVariableStaticFieldsSorted}}
111+
{{/hasPublicVariableStaticFields}}
112112

113113
{{#hasPublicStaticMethods}}
114114
## Static Methods
115115

116-
{{#publicStaticMethods}}
116+
{{#publicStaticMethodsSorted}}
117117
{{>callable}}
118118

119-
{{/publicStaticMethods}}
119+
{{/publicStaticMethodsSorted}}
120120
{{/hasPublicStaticMethods}}
121121

122-
{{#hasPublicConstants}}
122+
{{#hasPublicConstantFields}}
123123
## Constants
124124

125-
{{#publicConstants}}
125+
{{#publicConstantFieldsSorted}}
126126
{{>constant}}
127127

128-
{{/publicConstants}}
129-
{{/hasPublicConstants}}
128+
{{/publicConstantFieldsSorted}}
129+
{{/hasPublicConstantFields}}
130130
{{/mixin}}
131131

132132
{{>footer}}

‎test/dartdoc_test.dart

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,12 @@ void main() {
407407
}
408408
});
409409

410+
test('generating markdown docs does not crash', () async {
411+
var dartdoc =
412+
await buildDartdoc(['--format', 'md'], testPackageDir, tempDir);
413+
await dartdoc.generateDocsBase();
414+
});
415+
410416
test('rel canonical prefix does not include base href', () async {
411417
// ignore: omit_local_variable_types
412418
final String prefix = 'foo.bar/baz';

0 commit comments

Comments
 (0)