Skip to content

Commit 0f6433b

Browse files
committed
Merge from head
2 parents 0ad75e0 + 729d946 commit 0f6433b

File tree

101 files changed

+3960
-1806
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+3960
-1806
lines changed

.travis.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@ env:
1212
script: ./tool/travis.sh
1313

1414
os:
15-
- osx
1615
- linux
1716

17+
matrix:
18+
include:
19+
- env: DARTDOC_BOT=main
20+
os: osx
21+
dart: "dev/raw/latest"
22+
1823
install:
1924
- ./tool/install_travis.sh
2025

CHANGELOG.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
1+
## 0.28.6
2+
* Support for 0.38.3 version of `package:analyzer`.
3+
* Support generating docs for extension methods (#2001).
4+
5+
## 0.28.5
6+
* Support the latest version of `package:analyzer`.
7+
* Fix hyperlinks to overriden methods (#1994).
8+
* Option in dartdoc_options.yaml to exclude version in footer info (#1982).
9+
10+
## 0.28.4
11+
* **Breaking change** Change the default for `allow-tools` command line flag to false.
12+
* Fix some lints.
13+
* Update to support a future version of analyzer.
14+
15+
## 0.28.3+3
16+
* Fix code highlighting in Dart after string interpolation (#1946, #1948) by
17+
updating the highlightjs dependency.
18+
* Fix indentation of inheritance info to match others
19+
20+
## 0.28.3+2
21+
* Support the latest version of `package:html`.
22+
* Use latest version of the markdown package.
23+
24+
## 0.28.3+1
25+
* Fix scroll physics and behavior for Safari on iOS.
26+
27+
## 0.28.3
28+
* Support a new `{@youtube}` directive in documentation comments to embed
29+
YouTube videos.
30+
131
## 0.28.2
232
* Add empty CSS classes in spans around the names of entities so Dashing can pick
333
them up. (flutter/flutter#27654, #1929)
@@ -133,7 +163,7 @@
133163
## 0.22.0
134164
* Documentation updates. (#1760)
135165
* Fix incompatibility with head analyzer (endsWith exception). (#1768)
136-
* Added the ability to run external tools on a section of documentation and
166+
* Added the ability to run external tools on a section of documentation and
137167
replace it with the output of the tool.
138168

139169
## 0.21.1
@@ -516,7 +546,7 @@ This is a prerelease only, features listed as added here don't carry forward.
516546
## 0.9.7+1
517547
* change how we truncate long constant values on the summary page
518548
* show the full docs for enums on the summary page; just show the first line of
519-
docs for other contants
549+
docs for other constants
520550

521551
## 0.9.7
522552
* fix the display of long constants

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Yes!
99

1010
Start by [using the tool](README.md) and filing issues and requests.
1111

12-
See the [dartdoc API](https://pub.dartlang.org/documentation/dartdoc/latest/) docs, generated by
12+
See the [dartdoc API](https://pub.dev/documentation/dartdoc/latest/) docs, generated by
1313
dartdoc.
1414

1515
If you want to contribute, check out the [issue tracker][] and see if there's an

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ For information about contributing to the dartdoc project, see the
1111
[contributor docs][].
1212

1313
For issues/details related to hosted Dart API docs, see
14-
[dart-lang/api.dartlang.org](https://github.com/dart-lang/api.dartlang.org/).
14+
[dart-lang/api.dart.dev](https://github.com/dart-lang/api.dart.dev/).
1515

1616
## Installing dartdoc
1717

18-
- download the [Dart SDK](https://www.dartlang.org/downloads/)
18+
- download the [Dart SDK](https://dart.dev/get-dart)
1919
- add the SDK's `bin` directory to your `PATH`
2020

2121
## Generating docs
@@ -86,7 +86,7 @@ File names are _case-sensitive_.
8686
## Writing docs
8787

8888
Check out the
89-
[Effective Dart: Documentation guide](https://www.dartlang.org/effective-dart/documentation/).
89+
[Effective Dart: Documentation guide](https://dart.dev/guides/language/effective-dart/documentation).
9090

9191
The guide covers formatting, linking, markup, and general best practices when
9292
authoring doc comments for Dart with `dartdoc`.
@@ -152,7 +152,7 @@ Unrecognized options will be ignored. Supported options:
152152
* **includeExternal**: Specify a list of library filenames to add to the list of documented libraries.
153153
* **linkTo**: For other packages depending on this one, if this map is defined those packages
154154
will use the settings here to control how hyperlinks to the package are generated.
155-
This will override the default for packages hosted on pub.dartlang.org.
155+
This will override the default for packages hosted on pub.dev.
156156
* **url**: A string indicating the base URL for documentation of this package. Ordinarily
157157
you do not need to set this in the package: consider --link-to-hosted and
158158
--link-to-sdks instead of this option if you need to build your own website with

analysis_options.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1+
include: package:pedantic/analysis_options.1.8.0.yaml
2+
13
analyzer:
4+
# enable for analysis on test package sources.
5+
enable-experiment:
6+
- extension-methods
27
exclude:
38
- 'doc/**'
49
- 'lib/src/third_party/pkg/**'
@@ -15,7 +20,8 @@ linter:
1520
- directives_ordering
1621
- no_adjacent_strings_in_list
1722
- package_api_docs
18-
- slash_for_doc_comments
1923
- prefer_final_fields
24+
- prefer_generic_function_type_aliases
25+
- slash_for_doc_comments
2026
- unawaited_futures
2127
# - unnecessary_brace_in_string_interps

bin/dartdoc.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ class DartdocProgramOptionContext extends DartdocGeneratorOptionContext
2727

2828
Future<List<DartdocOption>> createDartdocProgramOptions() async {
2929
return <DartdocOption>[
30-
new DartdocOptionArgOnly<bool>('asyncStackTraces', false,
30+
DartdocOptionArgOnly<bool>('asyncStackTraces', false,
3131
help: 'Display coordinated asynchronous stack traces (slow)',
3232
negatable: true),
33-
new DartdocOptionArgOnly<bool>('generateDocs', true,
33+
DartdocOptionArgOnly<bool>('generateDocs', true,
3434
help:
3535
'Generate docs into the output directory (or only display warnings if false).',
3636
negatable: true),
37-
new DartdocOptionArgOnly<bool>('help', false,
37+
DartdocOptionArgOnly<bool>('help', false,
3838
abbr: 'h', help: 'Show command help.', negatable: false),
39-
new DartdocOptionArgOnly<bool>('version', false,
39+
DartdocOptionArgOnly<bool>('version', false,
4040
help: 'Display the version for $name.', negatable: false),
4141
];
4242
}
@@ -76,7 +76,7 @@ Future<void> main(List<String> arguments) async {
7676

7777
DartdocProgramOptionContext config;
7878
try {
79-
config = new DartdocProgramOptionContext(optionSet, null);
79+
config = DartdocProgramOptionContext(optionSet, null);
8080
} on DartdocOptionError catch (e) {
8181
stderr.writeln(' fatal error: ${e.message}');
8282
stderr.writeln('');
@@ -94,7 +94,7 @@ Future<void> main(List<String> arguments) async {
9494
try {
9595
await Chain.capture(() async {
9696
await runZoned(dartdoc.generateDocs,
97-
zoneSpecification: new ZoneSpecification(
97+
zoneSpecification: ZoneSpecification(
9898
print: (Zone self, ZoneDelegate parent, Zone zone, String line) =>
9999
logPrint(line)));
100100
}, onError: (e, Chain chain) {

dartdoc_options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
dartdoc:
22
linkToSource:
33
root: '.'
4-
uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/v0.28.2/%f%#L%l%'
4+
uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/v0.28.6/%f%#L%l%'

0 commit comments

Comments
 (0)