Skip to content

docs: Fix various dartdoc warnings#1353

Merged
spydon merged 8 commits into
flame-engine:mainfrom
st-pasha:dartdoc
Feb 4, 2022
Merged

docs: Fix various dartdoc warnings#1353
spydon merged 8 commits into
flame-engine:mainfrom
st-pasha:dartdoc

Conversation

@st-pasha
Copy link
Copy Markdown
Contributor

@st-pasha st-pasha commented Feb 4, 2022

Description

Currently, dartdoc is emitting ~60 different warnings on our codebase. This PR fixes all of them, except the "broken link" warnings, which stem from the README file that contains links to other .md documents.

Checklist

  • The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
  • I have read the Contributor Guide and followed the process outlined for submitting PRs.
  • (NA) I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • (NA) I have updated/added relevant examples in examples.

Breaking Change

  • No, this is not a breaking change.

Comment thread packages/flame/lib/src/components/input/joystick_component.dart Outdated
Comment thread packages/flame/lib/src/components/shape_component.dart Outdated
Comment thread packages/flame/lib/src/components/shape_component.dart Outdated
@spydon spydon merged commit 9f09605 into flame-engine:main Feb 4, 2022
@st-pasha st-pasha deleted the dartdoc branch February 4, 2022 17:58
@st-pasha st-pasha mentioned this pull request Feb 10, 2022
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants