Skip to content
This repository was archived by the owner on Feb 22, 2018. It is now read-only.

Commit 16906a4

Browse files
chalinmhevery
authored andcommitted
chore(documentation-generation): prepare for transition from dartdoc to docgen
Closes #553
1 parent 89f06bb commit 16906a4

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

scripts/env.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export DART=${DART:-"$DARTSDK/bin/dart"}
2929
export PUB=${PUB:-"$DARTSDK/bin/pub"}
3030
export DARTANALYZER=${DARTANALYZER:-"$DARTSDK/bin/dartanalyzer"}
3131
export DARTDOC=${DARTDOC:-"$DARTSDK/bin/dartdoc"}
32-
32+
export DART_DOCGEN=${DART_DOCGEN:-"$DARTSDK/bin/docgen"}
3333

3434
export CHROME_CANARY_BIN=${CHROME_CANARY_BIN:-"$DARTIUM"}
3535
export CHROME_BIN=${CHROME_BIN:-"google-chrome"}

scripts/generate-documentation.sh

+23-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
11
#!/bin/bash
22
. $(dirname $0)/env.sh
3-
$DARTDOC \
3+
4+
# Temporary during transition period from use of dartdoc to docgen.
5+
if [ -x "$DART_DOCGEN" ]; then
6+
# docgen seems to freeze when it processes the angular.dart files
7+
# https://code.google.com/p/dart/issues/detail?id=16752
8+
# so disable it for now
9+
# DOC_CMD="$DART_DOCGEN"
10+
# MODE_OPTION=
11+
echo "DISABLING DOCUMENT GENERATION due to isses with docgen."
12+
echo "https://code.google.com/p/dart/issues/detail?id=16752"
13+
echo "----"
14+
echo "Reporting success none-the-less during this docgen beta period."
15+
exit 0;
16+
elif [ -x "$DARTDOC" ]; then
17+
DOC_CMD="$DARTDOC"
18+
MODE_OPTION="--mode=static"
19+
fi
20+
21+
echo "Generating documentation using $DOC_CMD"
22+
"$DOC_CMD" $MODE_OPTION \
423
--package-root=packages/ \
524
--out doc \
6-
--mode=static \
725
--exclude-lib=js,metadata,meta,mirrors,intl,number_symbols,number_symbol_data,intl_helpers,date_format_internal,date_symbols,angular.util \
8-
packages/angular/angular.dart lib/mock/module.dart \
26+
packages/angular/angular.dart lib/mock/module.dart
27+
28+

0 commit comments

Comments
 (0)