publish 0.8.5
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b502e1b..3beabf3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,9 @@
## 0.8.5
-* [enhancement] do not document if there is a <nodoc> in the doc comment.
+* [enhancement] do not document if there is a <nodoc> in the doc comment.
+* [bug]link typdefs when used as parameters
+* [bug] fix issue with processing <pre> tags
+* [health] run tests only once on travis
+* [health] speed up dartdoc with caching and upgrade to latest analyzer package
## 0.8.4
* [enhancement] Only include generator metadata in the package `index.html` file.
diff --git a/README.md b/README.md
index 0a8011e..a665689 100644
--- a/README.md
+++ b/README.md
@@ -121,6 +121,11 @@
- `--sdk-docs` Generate only docs for the Dart SDK.
- `--sdk-readme=<file>` Specify the README file for the Dart SDK.
+## Excluding from documentation
+
+dartdoc will not generate documentation for a Dart element and its children that has
+the `<nodoc>` tag in the documentation comment.
+
## Issues and bugs
Please file reports on the [GitHub Issue Tracker][].
diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart
index 1d9e5b3..febca16 100644
--- a/lib/dartdoc.dart
+++ b/lib/dartdoc.dart
@@ -22,7 +22,6 @@
import 'package:analyzer/src/generated/sdk_io.dart';
import 'package:analyzer/src/generated/source.dart';
import 'package:analyzer/src/generated/source_io.dart';
-
import 'package:path/path.dart' as p;
import 'src/generator.dart';
@@ -39,7 +38,7 @@
const String name = 'dartdoc';
// Update when pubspec version changes.
-const String version = '0.8.4-dev';
+const String version = '0.8.5';
final String defaultOutDir = p.join('doc', 'api');
@@ -218,15 +217,6 @@
}
}
-/// The results of a [DartDoc.generateDocs] call.
-class DartDocResults {
- final PackageMeta packageMeta;
- final Package package;
- final Directory outDir;
-
- DartDocResults(this.packageMeta, this.package, this.outDir);
-}
-
/// This class is returned if dartdoc fails in an expected way (for instance, if
/// there is an analysis error in the library).
class DartDocFailure {
@@ -237,6 +227,15 @@
String toString() => message;
}
+/// The results of a [DartDoc.generateDocs] call.
+class DartDocResults {
+ final PackageMeta packageMeta;
+ final Package package;
+ final Directory outDir;
+
+ DartDocResults(this.packageMeta, this.package, this.outDir);
+}
+
class _Error implements Comparable {
final AnalysisError error;
final LineInfo lineInfo;
@@ -244,12 +243,9 @@
_Error(this.error, this.lineInfo, this.projectPath);
- int get severity => error.errorCode.errorSeverity.ordinal;
- bool get isError => error.errorCode.errorSeverity == ErrorSeverity.ERROR;
- String get severityName => error.errorCode.errorSeverity.displayName;
String get description => '${error.message} at ${location}, line ${line}.';
+ bool get isError => error.errorCode.errorSeverity == ErrorSeverity.ERROR;
int get line => lineInfo.getLocation(error.offset).lineNumber;
-
String get location {
String path = error.source.fullName;
if (path.startsWith(projectPath)) {
@@ -258,6 +254,10 @@
return path;
}
+ int get severity => error.errorCode.errorSeverity.ordinal;
+
+ String get severityName => error.errorCode.errorSeverity.displayName;
+
int compareTo(_Error other) {
if (severity == other.severity) {
int cmp = error.source.fullName.compareTo(other.error.source.fullName);
diff --git a/pubspec.yaml b/pubspec.yaml
index 37148fc..eadfbad 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -1,6 +1,6 @@
name: dartdoc
# Also update the `version` field in lib/dartdoc.dart.
-version: 0.8.5-dev
+version: 0.8.5
author: Dart Team <misc@dartlang.org>
description: A documentation generator for Dart.
homepage: https://github.com/dart-lang/dartdoc
diff --git a/test_package_docs/index.html b/test_package_docs/index.html
index 8c64967..4b60c97 100644
--- a/test_package_docs/index.html
+++ b/test_package_docs/index.html
@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
- <meta name="generator" content="made with love by dartdoc 0.8.4-dev">
+ <meta name="generator" content="made with love by dartdoc 0.8.5">
<meta name="description" content="test_package API docs, for the Dart programming language.">
<title>test_package - Dart API docs</title>
