Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dartdoc over Flutter project is trying to parse all the Flutter source files. #2141

Closed
limonadev opened this issue Feb 1, 2020 · 5 comments · Fixed by #2187
Closed

dartdoc over Flutter project is trying to parse all the Flutter source files. #2141

limonadev opened this issue Feb 1, 2020 · 5 comments · Fixed by #2187
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-enhancement A request for a change that isn't a bug

Comments

@limonadev
Copy link

I am trying to generate docs for a Flutter app. When I go inside de app directory, and run dartdoc, the command first parse my lib/ folder (which is ok!) but then tryies to parse the Flutter source files (shows lines like parsing /opt/Flutter/..., for every Flutter source file). Is there any form to specificate that dartdoc only works over the actual folder?

@jcollins-g
Copy link
Contributor

We should just squelch the parsing messages outside the package the person is documenting. We still have to parse them but it's confusing to people, especially considering we have bugs in this area like #1949.

@jcollins-g jcollins-g added type-enhancement A request for a change that isn't a bug P1 A high priority bug; for example, a single project is unusable or has many test failures labels Feb 3, 2020
@limonadev
Copy link
Author

I will let dartdoc parse all the files then. Thank you so much for the help!

@tbarbugli
Copy link

@jcollins-g on my tiny Flutter package it takes dartdoc ~90s to run parsing and doc generation

flutter pub global run dartdoc:dartdoc --exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:io,dart:isolate,dart:math,dart:typed_data,dart:ui,dart:ffi,dart:html,dart:js,dart:js_util'

@AbdelrahmanMohamedEmam
Copy link

@limonadev please can you tell me how did you generated the docs for your project as all my attempts to generate docs it generate docs for the dart sdk.

@limonadev
Copy link
Author

@abdelrahmanemam91 I just went into the root of my project folder and run the dartdoc command. The command first documented my code but after that, it documented the Flutter SDK also. It took a few minutes but at the end, it created the documentation without problems

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants