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

Enable dartdoc link to source #607

Merged
merged 2 commits into from
Dec 9, 2023
Merged

Enable dartdoc link to source #607

merged 2 commits into from
Dec 9, 2023

Conversation

abitofevrything
Copy link
Member

Description

Enables the linkToSource dartdoc option which adds a button to jump to the source definition in the generated API documentation. This makes it easier for new contributors to find types in the library, and shortens the time spent looking for API elements for regular developers.

Also corrects some invalid documentation references.

Checklist:

  • Ran dart analyze or make analyze and fixed all issues
  • Ran dart format --set-exit-if-changed -l 160 ./lib or make format and fixed all issues
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

@abitofevrything abitofevrything added the documentation Issues linked with documentation label Dec 9, 2023
@abitofevrything abitofevrything added this to the 6.1.0 milestone Dec 9, 2023
@abitofevrything abitofevrything self-assigned this Dec 9, 2023
@abitofevrything abitofevrything merged commit 57ce193 into dev Dec 9, 2023
7 checks passed
@abitofevrything abitofevrything deleted the docs/link-to-source branch December 9, 2023 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues linked with documentation
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants