From 5baea1b7e74775d7ffaca004713f59a744769c3a Mon Sep 17 00:00:00 2001 From: Devon Carew Date: Wed, 16 Sep 2015 18:03:52 -0700 Subject: [PATCH] make dev_compiler slightly happier with dartdoc --- pkg/dev_compiler/.gitignore | 1 + pkg/dev_compiler/README.md | 8 +++++--- pkg/dev_compiler/lib/devc.dart | 1 + pkg/dev_compiler/lib/runtime/messages_widget.dart | 8 +++----- pkg/dev_compiler/lib/strong_mode.dart | 4 ++-- 5 files changed, 12 insertions(+), 10 deletions(-) diff --git a/pkg/dev_compiler/.gitignore b/pkg/dev_compiler/.gitignore index 494181f32889..4f79e2cdfa37 100644 --- a/pkg/dev_compiler/.gitignore +++ b/pkg/dev_compiler/.gitignore @@ -12,6 +12,7 @@ packages .idea/ .pub/ node_modules +doc/api/ # Ignore test output test/codegen/expect/dev_compiler/ diff --git a/pkg/dev_compiler/README.md b/pkg/dev_compiler/README.md index b0466606e577..3dff73f331bf 100644 --- a/pkg/dev_compiler/README.md +++ b/pkg/dev_compiler/README.md @@ -11,19 +11,21 @@ The Dart Dev Compiler (DDC) is an **experimental** development tool and transpil DDC attempts to map to idiomatic EcmaScript 6 (ES6) as cleanly as possible. To do this while cohering to Dart semantics, DDC relies heavily on static type information, static checking, and runtime assertions. -DDC is intended to support [a very large subset of Dart](https://github.com/dart-lang/dev_compiler/blob/master/STRONG_MODE.md). If a program does not statically check, DDC will not result in valid generated code. Our goal is that a program execution (of a valid program) that runs without triggering runtime assertions should run the same on other Dart platforms under checked mode or production mode. +DDC is intended to support a very [large subset](https://github.com/dart-lang/dev_compiler/blob/master/STRONG_MODE.md) of Dart. If a program does not statically check, DDC will not result in valid generated code. Our goal is that a program execution (of a valid program) that runs without triggering runtime assertions should run the same on other Dart platforms under checked mode or production mode. DDC does support untyped Dart code, but it will typically result in less readable and less efficient ES6 output. DDC has the following project goals: + - Effective static checking and error detection. - A debugging solution for all modern browsers. - Readable output. - Fast, modular compilation of Dart code. - Easy use of generated code from JavaScript. -DDC is still in a very early stage as highlighted by our choice of ES6. ES6 itself is in active development across all modern browsers, but at various stages of support: https://kangax.github.io/compat-table/es6/ +DDC is still in a very early stage as highlighted by our choice of ES6. ES6 itself is in active development across all modern browsers, but at various stages of support: +[kangax.github.io/compat-table/es6](https://kangax.github.io/compat-table/es6/). We are initially targeting the subset of ES6 supported in Chrome Canary. -To try out DDC and/or give feedback, please read our [Usage](https://github.com/dart-lang/dev_compiler/blob/master/USAGE.md) page. +To try out DDC and/or give feedback, please read our [usage](https://github.com/dart-lang/dev_compiler/blob/master/USAGE.md) page. diff --git a/pkg/dev_compiler/lib/devc.dart b/pkg/dev_compiler/lib/devc.dart index 5fd03216da70..7c1fe985449c 100644 --- a/pkg/dev_compiler/lib/devc.dart +++ b/pkg/dev_compiler/lib/devc.dart @@ -2,6 +2,7 @@ // for details. All rights reserved. Use of this source code is governed by a // BSD-style license that can be found in the LICENSE file. +/// The main library for the Dart Dev Compiler. library dev_compiler.devc; export 'src/analysis_context.dart' diff --git a/pkg/dev_compiler/lib/runtime/messages_widget.dart b/pkg/dev_compiler/lib/runtime/messages_widget.dart index 11c4b82c57ba..0d6a903aa395 100644 --- a/pkg/dev_compiler/lib/runtime/messages_widget.dart +++ b/pkg/dev_compiler/lib/runtime/messages_widget.dart @@ -2,16 +2,14 @@ // for details. All rights reserved. Use of this source code is governed by a // BSD-style license that can be found in the LICENSE file. -/// This library provides a single function called injectLogs which when called -/// will request a logs json file and build a small widget out of them which -/// groups the logs by level. -library polymer.build.log_injector; +/// This library displays [MessageSummary]s from the Dart Dev Compiler. +library dev_compiler.messages; import 'dart:convert'; import 'dart:html'; -import 'package:source_span/source_span.dart'; import 'package:dev_compiler/src/summary.dart'; +import 'package:source_span/source_span.dart'; main() async { await window.animationFrame; diff --git a/pkg/dev_compiler/lib/strong_mode.dart b/pkg/dev_compiler/lib/strong_mode.dart index 740fa645ee57..16fbdf8f1418 100644 --- a/pkg/dev_compiler/lib/strong_mode.dart +++ b/pkg/dev_compiler/lib/strong_mode.dart @@ -2,8 +2,8 @@ // for details. All rights reserved. Use of this source code is governed by a // BSD-style license that can be found in the LICENSE file. -/// Types needed to implement "strong" checking in the Dart analyzer. -/// This is intended to be used by analyzer_cli and analysis_server packages. +/// Types needed to implement "strong" checking in the Dart analyzer. This is +/// intended to be used by `analyzer_cli` and `analysis_server` packages. library dev_compiler.strong_mode; import 'package:analyzer/src/generated/engine.dart'