From 126f7eda8d3bf9e721fb6d023966750954eeb351 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 11 Feb 2014 19:26:36 -0600 Subject: [PATCH 1/5] Add support for DART_DOCGEN Assume that docs are generated by `docgen`. If `docgen` is not available, then use `dartdoc`. --- scripts/env.sh | 2 +- scripts/generate-documentation.sh | 10 +++++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/scripts/env.sh b/scripts/env.sh index 8ba3b593d..dd01ad9be 100755 --- a/scripts/env.sh +++ b/scripts/env.sh @@ -29,7 +29,7 @@ export DART=${DART:-"$DARTSDK/bin/dart"} export PUB=${PUB:-"$DARTSDK/bin/pub"} export DARTANALYZER=${DARTANALYZER:-"$DARTSDK/bin/dartanalyzer"} export DARTDOC=${DARTDOC:-"$DARTSDK/bin/dartdoc"} - +export DART_DOCGEN=${DART_DOCGEN:-"$DARTSDK/bin/docgen"} export CHROME_CANARY_BIN=${CHROME_CANARY_BIN:-"$DARTIUM"} export CHROME_BIN=${CHROME_BIN:-"google-chrome"} diff --git a/scripts/generate-documentation.sh b/scripts/generate-documentation.sh index fbfb3153c..5b357c406 100755 --- a/scripts/generate-documentation.sh +++ b/scripts/generate-documentation.sh @@ -1,6 +1,14 @@ #!/bin/bash . $(dirname $0)/env.sh -$DARTDOC \ + +# Temporary during transition period from dartdoc to docgen. + +if [ ! -x "$DART_DOCGEN" ]; then + # Fall back on old dartdoc + DART_DOCGEN=$DARTDOC +fi + +$DART_DOCGEN \ --package-root=packages/ \ --out doc \ --mode=static \ From a96a3ca93b6cf2542b3bbd7eec7cd1cd5c3ae65d Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 11 Feb 2014 19:47:16 -0600 Subject: [PATCH 2/5] Remove --mode option for `docgen` --- scripts/generate-documentation.sh | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/scripts/generate-documentation.sh b/scripts/generate-documentation.sh index 5b357c406..a53d679b3 100755 --- a/scripts/generate-documentation.sh +++ b/scripts/generate-documentation.sh @@ -1,16 +1,20 @@ #!/bin/bash . $(dirname $0)/env.sh -# Temporary during transition period from dartdoc to docgen. - -if [ ! -x "$DART_DOCGEN" ]; then - # Fall back on old dartdoc - DART_DOCGEN=$DARTDOC +# Temporary during transition period from use of dartdoc to docgen. +if [ -x "$DART_DOCGEN" ]; then + DOC_CMD="$DART_DOCGEN" + MODE_OPTION= +else + DOC_CMD="$DARTDOC" + MODE_OPTION="--mode=static" fi -$DART_DOCGEN \ +echo Generating documentation using $DOC_CMD +$DOC_CMD \ --package-root=packages/ \ --out doc \ - --mode=static \ + $MODE_OPTION \ --exclude-lib=js,metadata,meta,mirrors,intl,number_symbols,number_symbol_data,intl_helpers,date_format_internal,date_symbols,angular.util \ - packages/angular/angular.dart lib/mock/module.dart \ + packages/angular/angular.dart lib/mock/module.dart + From dae87b924e46d2951b19540dfe2d5dda469d7441 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 11 Feb 2014 19:55:09 -0600 Subject: [PATCH 3/5] Do not generate doc if there is no doc tool --- scripts/generate-documentation.sh | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/scripts/generate-documentation.sh b/scripts/generate-documentation.sh index a53d679b3..548edeacc 100755 --- a/scripts/generate-documentation.sh +++ b/scripts/generate-documentation.sh @@ -1,13 +1,22 @@ #!/bin/bash . $(dirname $0)/env.sh +echo DART_DOCGEN=$DART_DOCGEN +ls -l $DART_DOCGEN +echo DARTDOC=$DARTDOC +ls -l $DARTDOC + # Temporary during transition period from use of dartdoc to docgen. if [ -x "$DART_DOCGEN" ]; then DOC_CMD="$DART_DOCGEN" MODE_OPTION= -else +elif [ -x "$DARTDOC" ]; then DOC_CMD="$DARTDOC" MODE_OPTION="--mode=static" +else + echo "There is no tool to generate the documentation!" + echo "Failing silently during this transition period from dartdoc to docgen." + exit 0; fi echo Generating documentation using $DOC_CMD From b6fbc9671cd2d1145175a024de683eeea7010e69 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 11 Feb 2014 21:01:52 -0600 Subject: [PATCH 4/5] Fix inclusion of MODE_OPTION --- scripts/generate-documentation.sh | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/generate-documentation.sh b/scripts/generate-documentation.sh index 548edeacc..e267ca303 100755 --- a/scripts/generate-documentation.sh +++ b/scripts/generate-documentation.sh @@ -2,9 +2,9 @@ . $(dirname $0)/env.sh echo DART_DOCGEN=$DART_DOCGEN -ls -l $DART_DOCGEN +ls -l "$DART_DOCGEN" || true echo DARTDOC=$DARTDOC -ls -l $DARTDOC +ls -l "$DARTDOC" || true # Temporary during transition period from use of dartdoc to docgen. if [ -x "$DART_DOCGEN" ]; then @@ -15,15 +15,15 @@ elif [ -x "$DARTDOC" ]; then MODE_OPTION="--mode=static" else echo "There is no tool to generate the documentation!" - echo "Failing silently during this transition period from dartdoc to docgen." + echo "Report success during this transition period from dartdoc to docgen." exit 0; fi -echo Generating documentation using $DOC_CMD -$DOC_CMD \ +echo Generating documentation using $DOC_CMD using mode option '$MODE_OPTION' +"$DOC_CMD" $MODE_OPTION \ --package-root=packages/ \ --out doc \ - $MODE_OPTION \ --exclude-lib=js,metadata,meta,mirrors,intl,number_symbols,number_symbol_data,intl_helpers,date_format_internal,date_symbols,angular.util \ packages/angular/angular.dart lib/mock/module.dart + From 454e258684b0dec9963cead1a475809196e51324 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 11 Feb 2014 21:35:33 -0600 Subject: [PATCH 5/5] Disable use of docgen until it can successfully generate angular.dart docs https://code.google.com/p/dart/issues/detail?id=16752 --- scripts/generate-documentation.sh | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/scripts/generate-documentation.sh b/scripts/generate-documentation.sh index e267ca303..c6bf8bc48 100755 --- a/scripts/generate-documentation.sh +++ b/scripts/generate-documentation.sh @@ -1,25 +1,24 @@ #!/bin/bash . $(dirname $0)/env.sh -echo DART_DOCGEN=$DART_DOCGEN -ls -l "$DART_DOCGEN" || true -echo DARTDOC=$DARTDOC -ls -l "$DARTDOC" || true - # Temporary during transition period from use of dartdoc to docgen. if [ -x "$DART_DOCGEN" ]; then - DOC_CMD="$DART_DOCGEN" - MODE_OPTION= + # docgen seems to freeze when it processes the angular.dart files + # https://code.google.com/p/dart/issues/detail?id=16752 + # so disable it for now + # DOC_CMD="$DART_DOCGEN" + # MODE_OPTION= + echo "DISABLING DOCUMENT GENERATION due to isses with docgen." + echo "https://code.google.com/p/dart/issues/detail?id=16752" + echo "----" + echo "Reporting success none-the-less during this docgen beta period." + exit 0; elif [ -x "$DARTDOC" ]; then DOC_CMD="$DARTDOC" MODE_OPTION="--mode=static" -else - echo "There is no tool to generate the documentation!" - echo "Report success during this transition period from dartdoc to docgen." - exit 0; fi -echo Generating documentation using $DOC_CMD using mode option '$MODE_OPTION' +echo "Generating documentation using $DOC_CMD" "$DOC_CMD" $MODE_OPTION \ --package-root=packages/ \ --out doc \