User DartDoc to generate documentation #8
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Josiassejod1
force-pushed
the
eng/djs/auto_generate
branch
from
948ba85
to
cb6306a
Compare
Doetheman
reviewed
Dec 3, 2021
Comment on lines
1
to
3
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
I believe this is an auto generated file so we don't have control over spacing.
Doetheman
reviewed
Dec 3, 2021
Comment on lines
26
to
31
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
example/lib/main.dart
Outdated
| ], | ||
| ), | ||
| Component( | ||
| componentName: 'List', | ||
| states: [ | ||
| ComponentState( | ||
| docName: 'ListExample', |
There was a problem hiding this comment.
this seems like it should be something like componentClassName or something similar
example/lib/main.dart
Outdated
| ), | ||
| ), | ||
| ); | ||
| return ListExample(); |
There was a problem hiding this comment.
use expression function => ListExample(),
lib/src/editor/ui/doc_markdown.dart
Outdated
| builder: (BuildContext context, AsyncSnapshot<String> text) { | ||
| return Tooltip( | ||
| message: "Click To Copy", | ||
| child: Markdown( |
There was a problem hiding this comment.
are we able to invert the colors on the rendered markdown so it's on a dark background?
lib/src/editor/ui/doc_markdown.dart
Outdated
| const String _markdownData = """ | ||
| ## Could Not Find Doc For Documents | ||
|
|
||
| If you are seeing this message, that means you have not generated docs for this component |
There was a problem hiding this comment.
Suggested change
| If you are seeing this message, that means you have not generated docs for this component | |
| If you are seeing this message, you have not generated docs for this component |
lib/src/editor/ui/doc_markdown.dart
Outdated
| - add the latest version of dartdoc to your pubspec.yaml | ||
| The --input is the path to your root directory in your project | ||
| The --output is the path in your project where the assets need to stay | ||
| - run dartdoc --format md --input "my_fake_project" --output "my_fake_project/assets/lib/docs" |
There was a problem hiding this comment.
nit:
Suggested change
| - run dartdoc --format md --input "my_fake_project" --output "my_fake_project/assets/lib/docs" | |
| - run dartdoc --format md --input "my_fake_project" --output "my_fake_project/lib/assets/docs" |
devbrandonlong
suggested changes
Dec 3, 2021
devbrandonlong
requested review from
a team,
Victorrent,
jasonmcgraw and
andrewboissonnault
DAL80
reviewed
Dec 6, 2021
DAL80
reviewed
Dec 6, 2021
Victorrent
suggested changes
Dec 8, 2021
Co-authored-by: Victor Rojas <Victorrent@users.noreply.github.com>
Co-authored-by: Victor Rojas <Victorrent@users.noreply.github.com>
Co-authored-by: Victor Rojas <Victorrent@users.noreply.github.com>
Co-authored-by: Victor Rojas <Victorrent@users.noreply.github.com>
Co-authored-by: Victor Rojas <Victorrent@users.noreply.github.com>
Co-authored-by: Victor Rojas <Victorrent@users.noreply.github.com>
Co-authored-by: Victor Rojas <Victorrent@users.noreply.github.com>
Co-authored-by: Victor Rojas <Victorrent@users.noreply.github.com>
devbrandonlong
suggested changes
Dec 9, 2021
Victorrent
approved these changes
Dec 9, 2021
DAL80
reviewed
Dec 9, 2021
Co-authored-by: Brandon Long <37224947+devbrandonlong@users.noreply.github.com>
…book into eng/djs/auto_generate
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pr introduces improvements to the currently introduced dart doc, instead of having to manually document code, we can now pull in changes using dartdoc to find the documentation on hosted asset
Screen.Recording.2021-12-03.at.12.03.39.PM.mov
s