From cf96b561799b7696e366df4677206850580a124e Mon Sep 17 00:00:00 2001 From: keertip Date: Wed, 12 Nov 2014 14:42:41 -0800 Subject: [PATCH 1/5] initial commit --- .gitignore | 2 ++ LICENSE | 26 ++++++++++++++++++++++++ README.md | 4 ++++ bin/dartdoc.dart | 52 ++++++++++++++++++++++++++++++++++++++++++++++++ lib/dartdoc.dart | 30 ++++++++++++++++++++++++++++ pubspec.yaml | 8 ++++++++ 6 files changed, 122 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 bin/dartdoc.dart create mode 100644 lib/dartdoc.dart create mode 100644 pubspec.yaml diff --git a/.gitignore b/.gitignore index 2ceb8eed93..5a741cd012 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,9 @@ # Don’t commit the following directories created by pub. build/ packages/ +bin/packages .buildlog +.project # Or the files created by dart2js. *.dart.js diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..5c60afea39 --- /dev/null +++ b/LICENSE @@ -0,0 +1,26 @@ +Copyright 2014, the Dart project authors. All rights reserved. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + * Neither the name of Google Inc. nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..74dfa21f0b --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +dartdoc +====== + +A documentation generator for Dart. diff --git a/bin/dartdoc.dart b/bin/dartdoc.dart new file mode 100644 index 0000000000..31ad55d3c0 --- /dev/null +++ b/bin/dartdoc.dart @@ -0,0 +1,52 @@ +// Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file +// 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. + +import 'dart:io'; + +import 'package:args/args.dart'; + +import 'package:dartdoc/dartdoc.dart'; + + +/** + * Analyzes Dart files and generates a representation of included libraries, + * classes, and members. Uses the current directory to look for libraries. + */ +void main(List arguments) { + ArgParser parser = _createArgsParser(); + ArgResults results = parser.parse(arguments); + + if (results['help']) { + _printUsageAndExit(parser); + } + List excludeLibraries = results['exclude'] == null ? + [] : results['exclude'].split(','); + + Directory currentDir = Directory.current; + + new DartDoc(currentDir, excludeLibraries).generate(); +} + +/** + * Print help if we are passed the help option or invalid arguments. + */ +void _printUsageAndExit(ArgParser parser) { + print(parser.usage); + print('Usage: dartdoc [OPTIONS]'); + exit(0); +} + + + ArgParser _createArgsParser() { + // TODO: more options to be added + ArgParser parser = new ArgParser(); + parser.addOption( + 'exclude', + help: 'a comma-separated list of library names to ignore'); + parser.addFlag('help', + abbr: 'h', + negatable: false, + help: 'show command help'); + return parser; + } \ No newline at end of file diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart new file mode 100644 index 0000000000..1662315603 --- /dev/null +++ b/lib/dartdoc.dart @@ -0,0 +1,30 @@ +// Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file +// 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. + + +library dartdoc; + +import 'dart:io'; + +/** + * Generates Dart documentation for all public Dart libraries in the given + * directory. + */ +class DartDoc { + + List _excludes; + Directory _rootDir; + + + DartDoc(this._rootDir,this._excludes); + + /** + * Generate the documentation + */ + void generate() { + print("TODO: impelement doc generation"); + } + +} + diff --git a/pubspec.yaml b/pubspec.yaml new file mode 100644 index 0000000000..4551cd9a36 --- /dev/null +++ b/pubspec.yaml @@ -0,0 +1,8 @@ +name: dartdoc +version: 0.0.1 +author: Dart Team +description: A documentation generator for Dart. +homepage: https://www.dartlang.org/ +dependencies: + analyzer: any + args: any From 0ac84782576744c5bd67639f486659884966df17 Mon Sep 17 00:00:00 2001 From: keertip Date: Wed, 12 Nov 2014 14:44:27 -0800 Subject: [PATCH 2/5] fix whitespace --- bin/dartdoc.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/dartdoc.dart b/bin/dartdoc.dart index 31ad55d3c0..72b9b086d6 100644 --- a/bin/dartdoc.dart +++ b/bin/dartdoc.dart @@ -49,4 +49,4 @@ void _printUsageAndExit(ArgParser parser) { negatable: false, help: 'show command help'); return parser; - } \ No newline at end of file + } From 0d4282a4696b0678e0b1e9cc1c4db46225ecc6bf Mon Sep 17 00:00:00 2001 From: keertip Date: Wed, 12 Nov 2014 14:46:16 -0800 Subject: [PATCH 3/5] fix whitespace --- bin/dartdoc.dart | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/bin/dartdoc.dart b/bin/dartdoc.dart index 72b9b086d6..99c4213d7b 100644 --- a/bin/dartdoc.dart +++ b/bin/dartdoc.dart @@ -24,7 +24,6 @@ void main(List arguments) { [] : results['exclude'].split(','); Directory currentDir = Directory.current; - new DartDoc(currentDir, excludeLibraries).generate(); } @@ -40,13 +39,13 @@ void _printUsageAndExit(ArgParser parser) { ArgParser _createArgsParser() { // TODO: more options to be added - ArgParser parser = new ArgParser(); - parser.addOption( - 'exclude', - help: 'a comma-separated list of library names to ignore'); - parser.addFlag('help', - abbr: 'h', - negatable: false, - help: 'show command help'); - return parser; - } + ArgParser parser = new ArgParser(); + parser.addOption( + 'exclude', + help: 'a comma-separated list of library names to ignore'); + parser.addFlag('help', + abbr: 'h', + negatable: false, + help: 'show command help'); + return parser; +} From 461fcbfa615ef321f8f17eaabd53d6d2507ff9ca Mon Sep 17 00:00:00 2001 From: keertip Date: Wed, 12 Nov 2014 19:26:30 -0800 Subject: [PATCH 4/5] adress comments --- README.md | 13 +++++++++++-- bin/dartdoc.dart | 20 +++++++------------- lib/dartdoc.dart | 13 +++---------- pubspec.yaml | 4 +++- 4 files changed, 24 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 74dfa21f0b..31576e9724 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ -dartdoc -====== +#dartdoc A documentation generator for Dart. + +Note: This tool is currently in pre-alpha stage. + +Issues and bugs + +Please file reports on the [GitHub Issue Tracker](https://github.com/dart-lang/dartdoc/issues). + +License + +See the LICENSE file for information. diff --git a/bin/dartdoc.dart b/bin/dartdoc.dart index 99c4213d7b..8e74a024cc 100644 --- a/bin/dartdoc.dart +++ b/bin/dartdoc.dart @@ -8,14 +8,11 @@ import 'package:args/args.dart'; import 'package:dartdoc/dartdoc.dart'; - -/** - * Analyzes Dart files and generates a representation of included libraries, - * classes, and members. Uses the current directory to look for libraries. - */ +/// Analyzes Dart files and generates a representation of included libraries, +/// classes, and members. Uses the current directory to look for libraries. void main(List arguments) { - ArgParser parser = _createArgsParser(); - ArgResults results = parser.parse(arguments); + var parser = _createArgsParser(); + var results = parser.parse(arguments); if (results['help']) { _printUsageAndExit(parser); @@ -23,23 +20,20 @@ void main(List arguments) { List excludeLibraries = results['exclude'] == null ? [] : results['exclude'].split(','); - Directory currentDir = Directory.current; + var currentDir = Directory.current; new DartDoc(currentDir, excludeLibraries).generate(); } -/** - * Print help if we are passed the help option or invalid arguments. - */ +/// Print help if we are passed the help option or invalid arguments. void _printUsageAndExit(ArgParser parser) { print(parser.usage); print('Usage: dartdoc [OPTIONS]'); exit(0); } - ArgParser _createArgsParser() { // TODO: more options to be added - ArgParser parser = new ArgParser(); + var parser = new ArgParser(); parser.addOption( 'exclude', help: 'a comma-separated list of library names to ignore'); diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart index 1662315603..45efa06de2 100644 --- a/lib/dartdoc.dart +++ b/lib/dartdoc.dart @@ -2,29 +2,22 @@ // 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. - library dartdoc; import 'dart:io'; -/** - * Generates Dart documentation for all public Dart libraries in the given - * directory. - */ +/// Generates Dart documentation for all public Dart libraries in the given +/// directory. class DartDoc { List _excludes; Directory _rootDir; - DartDoc(this._rootDir,this._excludes); - /** - * Generate the documentation - */ + /// Generate the documentation void generate() { print("TODO: impelement doc generation"); } - } diff --git a/pubspec.yaml b/pubspec.yaml index 4551cd9a36..1802bfb230 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -2,7 +2,9 @@ name: dartdoc version: 0.0.1 author: Dart Team description: A documentation generator for Dart. -homepage: https://www.dartlang.org/ +homepage: https://github.com/dart-lang/dartdoc dependencies: analyzer: any args: any +executables: + dartdoc: dartdoc From 7329fad95224174614d4ae9c396ba36b6e503b5a Mon Sep 17 00:00:00 2001 From: keertip Date: Fri, 14 Nov 2014 08:03:04 -0800 Subject: [PATCH 5/5] change pubspec --- pubspec.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pubspec.yaml b/pubspec.yaml index 1802bfb230..5603af9652 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -7,4 +7,4 @@ dependencies: analyzer: any args: any executables: - dartdoc: dartdoc + dartdoc: