dartdoc command should not generates docs for dart-sdk

[rubensdemelo]

Im generating a new doc for my package, following theses instructions: https://flutter.dev/docs/development/packages-and-plugins/developing-packages

When I run dartdoc, it generates docs for my package and also to dart-sdk . How to avoid it ?

C:\Users\rubens\Documents\Projetos\brasil_fields>dartdoc
Documenting brasil_fields...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\brasil_fields.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\formatter\cep_input_formatter.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\formatter\cnpj_input_formatter.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\formatter\cpf_input_formatter.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\formatter\data_input_formatter.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\formatter\real_input_formatter.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\formatter\telefone_input_formatter.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\modelos\estados.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\modelos\meses.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\modelos\regioes.dart...
parsing c:\users\rubens\documents\projetos\brasil_fields\lib\modelos\semana.dart...
parsing C:\flutter\bin\cache\pkg\sky_engine\lib\collection\collection.dart...
parsing C:\flutter\bin\cache\pkg\sky_engine\lib\developer\developer.dart...
...
...
...

Is that correct ?

[jonasfj]

I think this is a bug related to flutter..

We have the same issue on pub.dartlang.org where we've worked around it for now using:

dartdoc --exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:io,dart:isolate,dart:math,dart:typed_data,dart:ui'

[rayliverified]

This issue still exists in Dart v2.3.0

[tatsuyuki25]

This issue still exists in flutter 1.9.8-pre.82

[parsodyl]

flutter 1.10.7, dart 2.6.0, dartdoc 0.28.6
It's getting even worse:

[escamoteur]

And actually it's the oposite of what is described in the DartDoc 's readme.

[escamoteur]

@mit-mit Sorry I was wrong, --exclude does work for flutter stable channel, but no longer on latest master
So it's not possible to build DartDocs on master.

I'm on:

Flutter 1.10.15-pre.424 • channel master • https://github.com/flutter/flutter
Framework • revision 289b4588f4 (8 hours ago) • 2019-11-06 02:51:17 -0500
Engine • revision 9726b4cb99
Tools • Dart 2.7.0

On master I get from

dartdoc --exclude dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:io,dart:isolate,dart:math,dart:typed_data,dart:ui

Instead of just a rx_widget folder

Attached is a console log
log.txt

[parsodyl]

@escamoteur not sure if you encountered some errors, but you have to include all the new packages in the list.
So, basically this is the updated command:

$FLUTTER_ROOT/bin/cache/dart-sdk/bin/dartdoc  --exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:ffi,dart:html,dart:io,dart:isolate,dart:js,dart:js_util,dart:math,dart:typed_data,dart:ui'

Also remember to clean up everything in the folder first.

[escamoteur]

@parsodyl oh I guess you are right. didn't consider that it's just more packets in the latest version. Still would be good if it would work without the need to do this

[parsodyl]

@escamoteur yeah, I hope it will be fixed soon as well.

[JncSol]

I tried to add the exclude list identified by @parsodyl to dartdoc_options.yaml rather than the command, but it seems to be ignored...

dartdoc:
  exclude: ["dart:async", "dart:collection", ..., "dart:ui"]