Skip to content

docs(methods): add param tags and reformat some method comments#1

Merged
perrygovier merged 18 commits into
perrygovier:masterfrom
soundproofboot:updateMethodParameterDocumentation
Jun 16, 2025
Merged

docs(methods): add param tags and reformat some method comments#1
perrygovier merged 18 commits into
perrygovier:masterfrom
soundproofboot:updateMethodParameterDocumentation

Conversation

@soundproofboot

@soundproofboot soundproofboot commented Jun 11, 2025

Copy link
Copy Markdown

Issue number: resolves ionic-team/ionic-docs#4145

What is the current behavior?

Several @param tags are missing from JSDoc comments in methods for several components. Some comments are out of order so method descriptions appear in parameter documentation.

What is the new behavior?

  • All absent @param tags added to component methods.
  • Small typos fixed in several comments.
  • Comments in several methods refactored to move any method documentation above @param tags.

Does this introduce a breaking change?

  • Yes
  • [ x] No

brandyscarney and others added 18 commits June 9, 2025 14:57
@brandyscarney
test(fab): skip flaky custom size test (ionic-team#30463)
907506b 
Co-authored-by: Brandy Smith <6577830+brandyscarney@users.noreply.github.com>
@renovate
chore(deps): update dependency @axe-core/playwright to ^4.10.2 (ionic…
8bec166 
…-team#30460)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[@axe-core/playwright](https://redirect.github.com/dequelabs/axe-core-npm)
| [`^4.10.1` ->
`^4.10.2`](https://renovatebot.com/diffs/npm/@axe-core%2fplaywright/4.10.1/4.10.2)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/@axe-core%2fplaywright/4.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@axe-core%2fplaywright/4.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@axe-core%2fplaywright/4.10.1/4.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@axe-core%2fplaywright/4.10.1/4.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>dequelabs/axe-core-npm (@&ionic-team#8203;axe-core/playwright)</summary>

###
[`v4.10.2`](https://redirect.github.com/dequelabs/axe-core-npm/blob/HEAD/CHANGELOG.md#4102-2025-05-12)

[Compare
Source](https://redirect.github.com/dequelabs/axe-core-npm/compare/v4.10.1...v4.10.2)

##### Bug Fixes

- Optimize AxeBuilder memory usage.
([#&ionic-team#8203;1154](https://redirect.github.com/dequelabs/axe-core-npm/issues/1154))
([e53cd36](https://redirect.github.com/dequelabs/axe-core-npm/commit/e53cd36d0770a8323577946b0438f058b87a0aad)),
closes
[/github.com/bensenescu/axe-core-npm/blob/develop/packages/puppeteer/src/axePuppeteer.ts#L59](https://redirect.github.com//github.com/bensenescu/axe-core-npm/blob/develop/packages/puppeteer/src/axePuppeteer.ts/issues/L59)
[/github.com/bensenescu/axe-core-npm/blob/develop/packages/puppeteer/src/utils.ts#L34](https://redirect.github.com//github.com/bensenescu/axe-core-npm/blob/develop/packages/puppeteer/src/utils.ts/issues/L34)
- Update axe-core to v4.10.3
([#&ionic-team#8203;1155](https://redirect.github.com/dequelabs/axe-core-npm/issues/1155))
([f8e3a14](https://redirect.github.com/dequelabs/axe-core-npm/commit/f8e3a14043c7288ca9373a5f1543ffd27cedf256))
- **wdio:** resolve blank navigation issue in WDIO v9
([#&ionic-team#8203;1169](https://redirect.github.com/dequelabs/axe-core-npm/issues/1169))
([6505560](https://redirect.github.com/dequelabs/axe-core-npm/commit/6505560d646ddc6db8a9b4cf772af08ff3f08dc3))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "every weekday before 11am" (UTC),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Never, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/ionic-team/ionic-framework).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MC40MC4zIiwidXBkYXRlZEluVmVyIjoiNDAuNDAuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@brandyscarney
test(popover): skip flaky no event popover test (ionic-team#30464)
7da26d0 
Co-authored-by: Brandy Smith <6577830+brandyscarney@users.noreply.github.com>
@renovate
chore(deps): update dependency @capacitor/core to v7.3.0 (ionic-team#…
5ca8fc8 
…30461)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@capacitor/core](https://capacitorjs.com)
([source](https://redirect.github.com/ionic-team/capacitor)) | [`7.2.0`
->
`7.3.0`](https://renovatebot.com/diffs/npm/@capacitor%2fcore/7.2.0/7.3.0)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/@capacitor%2fcore/7.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@capacitor%2fcore/7.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@capacitor%2fcore/7.2.0/7.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@capacitor%2fcore/7.2.0/7.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>ionic-team/capacitor (@&ionic-team#8203;capacitor/core)</summary>

###
[`v7.3.0`](https://redirect.github.com/ionic-team/capacitor/blob/HEAD/CHANGELOG.md#730-2025-06-05)

[Compare
Source](https://redirect.github.com/ionic-team/capacitor/compare/7.2.0...7.3.0)

##### Bug Fixes

- add error code checking to `runPlatformHook`
([#&ionic-team#8203;7994](https://redirect.github.com/ionic-team/capacitor/issues/7994))
([8717680](https://redirect.github.com/ionic-team/capacitor/commit/871768049187afe9f5d358d3fe08b6f18f70533e))
- **cli:** Don't downgrade deployment target on migrate
([#&ionic-team#8203;7953](https://redirect.github.com/ionic-team/capacitor/issues/7953))
([46e8792](https://redirect.github.com/ionic-team/capacitor/commit/46e87925b675933b413737854b1376eb1c71a23e))
- **cli:** ensures the execution order of CLI hooks
([#&ionic-team#8203;7947](https://redirect.github.com/ionic-team/capacitor/issues/7947))
([c3ea809](https://redirect.github.com/ionic-team/capacitor/commit/c3ea8094cdd385ac02a5aae89f8b44b6c53d493a))
- **cli:** unexpected error on target device list
([#&ionic-team#8203;8015](https://redirect.github.com/ionic-team/capacitor/issues/8015))
([f827c48](https://redirect.github.com/ionic-team/capacitor/commit/f827c48f08b13a265e8671291c24f3506e14a094))
- **cli:** use proper build params
([#&ionic-team#8203;8016](https://redirect.github.com/ionic-team/capacitor/issues/8016))
([12ce2a4](https://redirect.github.com/ionic-team/capacitor/commit/12ce2a486542011c8d6f4cd89a67464f3f27e28d))
- **core:** Prevent error when hasListeners is empty
([#&ionic-team#8203;7975](https://redirect.github.com/ionic-team/capacitor/issues/7975))
([a4a0942](https://redirect.github.com/ionic-team/capacitor/commit/a4a0942eddba068e078bd782bb093ed1ecff9e00))
- Remove all plugin listeners in bridge reset
([#&ionic-team#8203;7962](https://redirect.github.com/ionic-team/capacitor/issues/7962))
([06aeea9](https://redirect.github.com/ionic-team/capacitor/commit/06aeea973aa56ac2fb791f893ebd899253ee65f9))

##### Features

- **cli:** Initial Cordova plugin SPM support
([#&ionic-team#8203;7999](https://redirect.github.com/ionic-team/capacitor/issues/7999))
([c030354](https://redirect.github.com/ionic-team/capacitor/commit/c03035426343ddc4e303ca3420e476bb7f1e2201))
- expose `appStartPath` on cap config server configuration
([#&ionic-team#8203;8019](https://redirect.github.com/ionic-team/capacitor/issues/8019))
([a274fef](https://redirect.github.com/ionic-team/capacitor/commit/a274fef069176a8e528a22f4734d1e29a539709c))
- **ios:** Alternative debug config for SPM
([#&ionic-team#8203;7982](https://redirect.github.com/ionic-team/capacitor/issues/7982))
([a054aa5](https://redirect.github.com/ionic-team/capacitor/commit/a054aa5bb4d5eabe5da5d42a380bd51b8785958c))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "every weekday before 11am" (UTC),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Never, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/ionic-team/ionic-framework).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MC40MC4zIiwidXBkYXRlZEluVmVyIjoiNDAuNDAuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@soundproofboot
docs(app): add param tag to setFocus method
3503975
@soundproofboot
docs(action-sheet): refactor documentation for dismiss method
d677274
@soundproofboot
docs(alert): refactor documentation for dismiss method
94b7df1
@soundproofboot
docs(datetime): add param tags to confirm, reset, and cancel methods
160968b
@soundproofboot
docs(loading): refactor documentation for dismiss method
6b0154c
@soundproofboot
docs(datetime): fix typo in method param tags
fa0108a
@soundproofboot
docs(menu): add param tags to open, close and toggle methods
5cafafc
@soundproofboot
docs(modal): add update documenation on setCurrentBreakpoint and dism…
b9fd8a2 
…iss methods
@soundproofboot
docs(menu): add param tags to setOpen method
dd643f9
@soundproofboot
docs(popover): update docs for present and dismiss methods
4556bec
@soundproofboot
docs(reorder-group): remove new line from complete method
4d9743e
@soundproofboot
docs(router): add param tag to push method
9db7a54
@soundproofboot
docs(searchbar): spacing in setFocus documentation
ad35701
@soundproofboot
docs(toast): refactor documentation for dismiss method
a505969
@soundproofboot

soundproofboot commented Jun 11, 2025

Copy link
Copy Markdown
Author

I ran the build on this branch to create a new version of the json documentation for the components, then copied that json into a new branch in my docs fork. I replaced the fetch from unpkg with that json file so the docs build with these changes. I connected my docs fork to Vercel to be able to preview these changes - https://ionic-docs-git-temptotestdocs-soundproofboots-projects.vercel.app/docs/api/datetime#methods

@perrygovier

perrygovier commented Jun 16, 2025

Copy link
Copy Markdown
Owner

same with this one. the code looks good to me, but my git setup is a bit weird. If you don't see these other commits in the PR when you submit it to ionic, let me know

@perrygovier
perrygovier merged commit a7bd259 into perrygovier:master Jun 16, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

package: core

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

content: add @param tags and review formatting in method comments

3 participants

@soundproofboot @perrygovier @brandyscarney