Skip to content

Update markdown templates post-refactor #2208

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
May 12, 2020
Merged

Update markdown templates post-refactor #2208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
45c5ed2
intermediate
jcollins-g May 8, 2020
623c3d1
tests pass, ship it
jcollins-g May 8, 2020
976e903
Merge branch 'master' into nnbd-pre-cleanup
jcollins-g May 8, 2020
6e46e32
Fix a missing variable static fields change in mixin template
jcollins-g May 8, 2020
7c789b4
Fix some remaining templating bugs
jcollins-g May 8, 2020
5b24ba8
Merge branch 'master' into nnbd-pre-cleanup
jcollins-g May 11, 2020
02b8138
Review comments
jcollins-g May 11, 2020
4bbbe49
Update markdown templates per #2206
jcollins-g May 11, 2020
2bc802e
Merge branch 'master' into nnbd-pre-cleanup
jcollins-g May 11, 2020
382b7ee
Merge branch 'nnbd-pre-cleanup' into nnbd-pre-cleanup-md
jcollins-g May 11, 2020
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
48 changes: 24 additions & 24 deletions lib/templates/md/class.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,68 +65,68 @@
{{#hasPublicConstructors}}
## Constructors

{{#publicConstructors}}
{{#publicConstructorsSorted}}
{{{linkedName}}} ({{{ linkedParams }}})

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

{{/publicConstructors}}
{{/publicConstructorsSorted}}
{{/hasPublicConstructors}}

{{#hasPublicProperties}}
{{#hasPublicInstanceFields}}
## Properties

{{#allPublicInstanceProperties}}
{{#publicInstanceFieldsSorted}}
{{>property}}

{{/allPublicInstanceProperties}}
{{/hasPublicProperties}}
{{/publicInstanceFieldsSorted}}
{{/hasPublicInstanceFields}}

{{#hasPublicMethods}}
{{#hasPublicInstanceMethods}}
## Methods

{{#allPublicInstanceMethods}}
{{#publicInstanceMethodsSorted}}
{{>callable}}

{{/allPublicInstanceMethods}}
{{/hasPublicMethods}}
{{/publicInstanceMethodsSorted}}
{{/hasPublicInstanceMethods}}

{{#hasPublicOperators}}
{{#hasPublicInstanceOperators}}
## Operators

{{#allPublicOperators}}
{{#publicInstanceOperatorsSorted}}
{{>callable}}

{{/allPublicOperators}}
{{/hasPublicOperators}}
{{/publicInstanceOperatorsSorted}}
{{/hasPublicInstanceOperators}}

{{#hasPublicStaticProperties}}
{{#hasPublicVariableStaticFields}}
## Static Properties

{{#publicStaticProperties}}
{{#publicVariableStaticFieldsSorted}}
{{>property}}

{{/publicStaticProperties}}
{{/hasPublicStaticProperties}}
{{/publicVariableStaticFieldsSorted}}
{{/hasPublicVariableStaticFields}}

{{#hasPublicStaticMethods}}
## Static Methods

{{#publicStaticMethods}}
{{#publicStaticMethodsSorted}}
{{>callable}}

{{/publicStaticMethods}}
{{/publicStaticMethodsSorted}}
{{/hasPublicStaticMethods}}

{{#hasPublicConstants}}
{{#hasPublicConstantFields}}
## Constants

{{#publicConstants}}
{{#publicConstantFieldsSorted}}
{{>constant}}

{{/publicConstants}}
{{/hasPublicConstants}}
{{/publicConstantFieldsSorted}}
{{/hasPublicConstantFields}}
{{/clazz}}

{{>footer}}
48 changes: 24 additions & 24 deletions lib/templates/md/enum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,70 +54,70 @@
{{/hasAnnotations}}
{{/hasModifiers}}

{{#hasPublicConstants}}
{{#hasPublicConstantFields}}
## Constants

{{#publicConstants}}
{{#publicConstantFieldsSorted}}
{{>constant}}

{{/publicConstants}}
{{/hasPublicConstants}}
{{/publicConstantFieldsSorted}}
{{/hasPublicConstantFields}}

{{#hasPublicConstructors}}
## Constructors

{{#publicConstructors}}
{{#publicConstructorsSorted}}
{{{linkedName}}}({{{ linkedParams }}})

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

{{/publicConstructors}}
{{/publicConstructorsSorted}}
{{/hasPublicConstructors}}

{{#hasPublicProperties}}
{{#hasPublicInstanceFields}}
## Properties

{{#allPublicInstanceProperties}}
{{#publicInstanceFieldsSorted}}
{{>property}}

{{/allPublicInstanceProperties}}
{{/hasPublicProperties}}
{{/publicInstanceFieldsSorted}}
{{/hasPublicInstanceFields}}

{{#hasPublicMethods}}
{{#hasPublicInstanceMethods}}
## Methods

{{#allPublicInstanceMethods}}
{{#publicInstanceMethodsSorted}}
{{>callable}}

{{/allPublicInstanceMethods}}
{{/hasPublicMethods}}
{{/publicInstanceMethodsSorted}}
{{/hasPublicInstanceMethods}}

{{#hasPublicOperators}}
{{#hasPublicInstanceOperators}}
## Operators

{{#allPublicOperators}}
{{#publicInstanceOperatorsSorted}}
{{>callable}}

{{/allPublicOperators}}
{{/hasPublicOperators}}
{{/publicInstanceOperatorsSorted}}
{{/hasPublicInstanceOperators}}

{{#hasPublicStaticProperties}}
{{#hasPublicVariableStaticFields}}
## Static Properties

{{#publicStaticProperties}}
{{#publicVariableStaticFieldsSorted}}
{{>property}}

{{/publicStaticProperties}}
{{/hasPublicStaticProperties}}
{{/publicVariableStaticFieldsSorted}}
{{/hasPublicVariableStaticFields}}

{{#hasPublicStaticMethods}}
## Static Methods

{{#publicStaticMethods}}
{{#publicStaticMethodsSorted}}
{{>callable}}

{{/publicStaticMethods}}
{{/publicStaticMethodsSorted}}
{{/hasPublicStaticMethods}}
{{/eNum}}

Expand Down
44 changes: 22 additions & 22 deletions lib/templates/md/extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,59 +12,59 @@ on {{#extendedType}}{{{linkedName}}}{{/extendedType}}
{{#extension}}
{{>documentation}}

{{#hasPublicProperties}}
{{#hasPublicInstanceFields}}
## Properties

{{#allPublicInstanceProperties}}
{{#publicInstanceFieldsSorted}}
{{>property}}

{{/allPublicInstanceProperties}}
{{/hasPublicProperties}}
{{/publicInstanceFieldsSorted}}
{{/hasPublicInstanceFields}}

{{#hasPublicMethods}}
{{#hasPublicInstanceMethods}}
## Methods

{{#allPublicInstanceMethods}}
{{#publicInstanceMethodsSorted}}
{{>callable}}

{{/allPublicInstanceMethods}}
{{/hasPublicMethods}}
{{/publicInstanceMethodsSorted}}
{{/hasPublicInstanceMethods}}

{{#hasPublicOperators}}
{{#hasPublicInstanceOperators}}
## Operators

{{#allPublicOperators}}
{{#publicInstanceOperatorsSorted}}
{{>callable}}

{{/allPublicOperators}}
{{/hasPublicOperators}}
{{/publicInstanceOperatorsSorted}}
{{/hasPublicInstanceOperators}}

{{#hasPublicStaticProperties}}
{{#hasPublicVariableStaticFields}}
## Static Properties

{{#publicStaticProperties}}
{{#publicVariableStaticFieldsSorted}}
{{>property}}

{{/publicStaticProperties}}
{{/hasPublicStaticProperties}}
{{/publicVariableStaticFieldsSorted}}
{{/hasPublicVariableStaticFields}}

{{#hasPublicStaticMethods}}
## Static Methods

{{#publicStaticMethods}}
{{#publicStaticMethodsSorted}}
{{>callable}}

{{/publicStaticMethods}}
{{/publicStaticMethodsSorted}}
{{/hasPublicStaticMethods}}

{{#hasPublicConstants}}
{{#hasPublicConstantFields}}
## Constants

{{#publicConstants}}
{{#publicConstantFieldsSorted}}
{{>constant}}

{{/publicConstants}}
{{/hasPublicConstants}}
{{/publicConstantFieldsSorted}}
{{/hasPublicConstantFields}}
{{/extension}}

{{>footer}}
48 changes: 24 additions & 24 deletions lib/templates/md/mixin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,68 +65,68 @@
{{#hasPublicConstructors}}
## Constructors

{{#publicConstructors}}
{{#publicConstructorsSorted}}
{{{linkedName}}}({{{ linkedParams }}})

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

{{/publicConstructors}}
{{/publicConstructorsSorted}}
{{/hasPublicConstructors}}

{{#hasPublicProperties}}
{{#hasPublicInstanceFields}}
## Properties

{{#allPublicInstanceProperties}}
{{#publicInstanceFieldsSorted}}
{{>property}}

{{/allPublicInstanceProperties}}
{{/hasPublicProperties}}
{{/publicInstanceFieldsSorted}}
{{/hasPublicInstanceFields}}

{{#hasPublicMethods}}
{{#hasPublicInstanceMethods}}
## Methods

{{#allPublicInstanceMethods}}
{{#publicInstanceMethodsSorted}}
{{>callable}}

{{/allPublicInstanceMethods}}
{{/hasPublicMethods}}
{{/publicInstanceMethodsSorted}}
{{/hasPublicInstanceMethods}}

{{#hasPublicOperators}}
{{#hasPublicInstanceOperators}}
## Operators

{{#allPublicOperators}}
{{#publicInstanceOperatorsSorted}}
{{>callable}}

{{/allPublicOperators}}
{{/hasPublicOperators}}
{{/publicInstanceOperatorsSorted}}
{{/hasPublicInstanceOperators}}

{{#hasPublicStaticProperties}}
{{#hasPublicVariableStaticFields}}
## Static Properties

{{#publicStaticProperties}}
{{#publicVariableStaticFieldsSorted}}
{{>property}}

{{/publicStaticProperties}}
{{/hasPublicStaticProperties}}
{{/publicVariableStaticFieldsSorted}}
{{/hasPublicVariableStaticFields}}

{{#hasPublicStaticMethods}}
## Static Methods

{{#publicStaticMethods}}
{{#publicStaticMethodsSorted}}
{{>callable}}

{{/publicStaticMethods}}
{{/publicStaticMethodsSorted}}
{{/hasPublicStaticMethods}}

{{#hasPublicConstants}}
{{#hasPublicConstantFields}}
## Constants

{{#publicConstants}}
{{#publicConstantFieldsSorted}}
{{>constant}}

{{/publicConstants}}
{{/hasPublicConstants}}
{{/publicConstantFieldsSorted}}
{{/hasPublicConstantFields}}
{{/mixin}}

{{>footer}}
6 changes: 6 additions & 0 deletions test/dartdoc_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,12 @@ void main() {
}
});

test('generating markdown docs does not crash', () async {
var dartdoc =
await buildDartdoc(['--format', 'md'], testPackageDir, tempDir);
await dartdoc.generateDocsBase();
});

test('rel canonical prefix does not include base href', () async {
// ignore: omit_local_variable_types
final String prefix = 'foo.bar/baz';
Expand Down