Merge pull request #1080 from keertip/publish

publish 0.8.5

Author: keertip

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 &lt;nodoc> in the doc comment.
+* [bug]link typdefs when used as parameters
+* [bug] fix issue with processing &lt;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.

README.md

@@ -121,6 +121,11 @@ The following options are used only when generating docs for the Dart SDK.
 - `--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][].

lib/dartdoc.dart

@@ -22,7 +22,6 @@ import 'package:analyzer/src/generated/sdk.dart';
 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 @@ export 'src/package_meta.dart';
 
 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 @@ class DartDoc {
   }
 }
 
-/// 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,19 +227,25 @@ class DartDocFailure {
   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;
   final String projectPath;
 
   _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 @@ class _Error implements Comparable {
     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);

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 <[email protected]>
 description: A documentation generator for Dart.
 homepage: https://github.com/dart-lang/dartdoc

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>