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

docs: fix addListener links #2010

Merged
merged 1 commit into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion action-sheet/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion app-launcher/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
12 changes: 6 additions & 6 deletions app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ const checkAppLaunchUrl = async () => {
* [`getState()`](#getstate)
* [`getLaunchUrl()`](#getlaunchurl)
* [`minimizeApp()`](#minimizeapp)
* [`addListener('appStateChange', ...)`](#addlistenerappstatechange)
* [`addListener('pause', ...)`](#addlistenerpause)
* [`addListener('resume', ...)`](#addlistenerresume)
* [`addListener('appUrlOpen', ...)`](#addlistenerappurlopen)
* [`addListener('appRestoredResult', ...)`](#addlistenerapprestoredresult)
* [`addListener('backButton', ...)`](#addlistenerbackbutton)
* [`addListener('appStateChange', ...)`](#addlistenerappstatechange-)
* [`addListener('pause', ...)`](#addlistenerpause-)
* [`addListener('resume', ...)`](#addlistenerresume-)
* [`addListener('appUrlOpen', ...)`](#addlistenerappurlopen-)
* [`addListener('appRestoredResult', ...)`](#addlistenerapprestoredresult-)
* [`addListener('backButton', ...)`](#addlistenerbackbutton-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Expand Down
2 changes: 1 addition & 1 deletion app/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
4 changes: 2 additions & 2 deletions browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ const openCapacitorSite = async () => {

* [`open(...)`](#open)
* [`close()`](#close)
* [`addListener('browserFinished', ...)`](#addlistenerbrowserfinished)
* [`addListener('browserPageLoaded', ...)`](#addlistenerbrowserpageloaded)
* [`addListener('browserFinished', ...)`](#addlistenerbrowserfinished-)
* [`addListener('browserPageLoaded', ...)`](#addlistenerbrowserpageloaded-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)

Expand Down
2 changes: 1 addition & 1 deletion browser/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion camera/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion clipboard/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion device/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion dialog/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion filesystem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const readFilePath = async () => {
* [`checkPermissions()`](#checkpermissions)
* [`requestPermissions()`](#requestpermissions)
* [`downloadFile(...)`](#downloadfile)
* [`addListener('progress', ...)`](#addlistenerprogress)
* [`addListener('progress', ...)`](#addlistenerprogress-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Expand Down
2 changes: 1 addition & 1 deletion filesystem/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion geolocation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion google-maps/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "^1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion haptics/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
8 changes: 4 additions & 4 deletions keyboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,10 @@ the following events also work with `window.addEventListener`:
* [`setStyle(...)`](#setstyle)
* [`setResizeMode(...)`](#setresizemode)
* [`getResizeMode()`](#getresizemode)
* [`addListener('keyboardWillShow', ...)`](#addlistenerkeyboardwillshow)
* [`addListener('keyboardDidShow', ...)`](#addlistenerkeyboarddidshow)
* [`addListener('keyboardWillHide', ...)`](#addlistenerkeyboardwillhide)
* [`addListener('keyboardDidHide', ...)`](#addlistenerkeyboarddidhide)
* [`addListener('keyboardWillShow', ...)`](#addlistenerkeyboardwillshow-)
* [`addListener('keyboardDidShow', ...)`](#addlistenerkeyboarddidshow-)
* [`addListener('keyboardWillHide', ...)`](#addlistenerkeyboardwillhide-)
* [`addListener('keyboardDidHide', ...)`](#addlistenerkeyboarddidhide-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Enums](#enums)
Expand Down
2 changes: 1 addition & 1 deletion keyboard/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"@capacitor/android": "next",
"@capacitor/cli": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
4 changes: 2 additions & 2 deletions local-notifications/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ If the device has entered [Doze](https://developer.android.com/training/monitori
* [`requestPermissions()`](#requestpermissions)
* [`changeExactNotificationSetting()`](#changeexactnotificationsetting)
* [`checkExactNotificationSetting()`](#checkexactnotificationsetting)
* [`addListener('localNotificationReceived', ...)`](#addlistenerlocalnotificationreceived)
* [`addListener('localNotificationActionPerformed', ...)`](#addlistenerlocalnotificationactionperformed)
* [`addListener('localNotificationReceived', ...)`](#addlistenerlocalnotificationreceived-)
* [`addListener('localNotificationActionPerformed', ...)`](#addlistenerlocalnotificationactionperformed-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Expand Down
2 changes: 1 addition & 1 deletion local-notifications/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"@capacitor/android": "next",
"@capacitor/cli": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
4 changes: 2 additions & 2 deletions motion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ API to understand the data supplied in the 'accel' event.

<docgen-index>

* [`addListener('accel', ...)`](#addlisteneraccel)
* [`addListener('orientation', ...)`](#addlistenerorientation)
* [`addListener('accel', ...)`](#addlisteneraccel-)
* [`addListener('orientation', ...)`](#addlistenerorientation-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Expand Down
2 changes: 1 addition & 1 deletion motion/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const logCurrentNetworkStatus = async () => {
<docgen-index>

* [`getStatus()`](#getstatus)
* [`addListener('networkStatusChange', ...)`](#addlistenernetworkstatuschange)
* [`addListener('networkStatusChange', ...)`](#addlistenernetworkstatuschange-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Expand Down
2 changes: 1 addition & 1 deletion network/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion preferences/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
8 changes: 4 additions & 4 deletions push-notifications/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,10 @@ const getDeliveredNotifications = async () => {
* [`listChannels()`](#listchannels)
* [`checkPermissions()`](#checkpermissions)
* [`requestPermissions()`](#requestpermissions)
* [`addListener('registration', ...)`](#addlistenerregistration)
* [`addListener('registrationError', ...)`](#addlistenerregistrationerror)
* [`addListener('pushNotificationReceived', ...)`](#addlistenerpushnotificationreceived)
* [`addListener('pushNotificationActionPerformed', ...)`](#addlistenerpushnotificationactionperformed)
* [`addListener('registration', ...)`](#addlistenerregistration-)
* [`addListener('registrationError', ...)`](#addlistenerregistrationerror-)
* [`addListener('pushNotificationReceived', ...)`](#addlistenerpushnotificationreceived-)
* [`addListener('pushNotificationActionPerformed', ...)`](#addlistenerpushnotificationactionperformed-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Expand Down
2 changes: 1 addition & 1 deletion push-notifications/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"@capacitor/android": "next",
"@capacitor/cli": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion screen-orientation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ By default, an iPad allows Multitasking and its orientation cannot be locked. If
* [`orientation()`](#orientation)
* [`lock(...)`](#lock)
* [`unlock()`](#unlock)
* [`addListener('screenOrientationChange', ...)`](#addlistenerscreenorientationchange)
* [`addListener('screenOrientationChange', ...)`](#addlistenerscreenorientationchange-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Expand Down
2 changes: 1 addition & 1 deletion screen-orientation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion screen-reader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const sayHello = async () => {

* [`isEnabled()`](#isenabled)
* [`speak(...)`](#speak)
* [`addListener('stateChange', ...)`](#addlistenerstatechange)
* [`addListener('stateChange', ...)`](#addlistenerstatechange-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Expand Down
2 changes: 1 addition & 1 deletion screen-reader/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion share/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion splash-screen/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"@capacitor/android": "next",
"@capacitor/cli": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion status-bar/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion text-zoom/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion toast/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"devDependencies": {
"@capacitor/android": "next",
"@capacitor/core": "next",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "next",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
Loading