Skip to content

Commit

Permalink
docs: fix addListener links (#2012)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jcesarmobile
jcesarmobile authored Jan 29, 2024
1 parent d8540fe commit be9ff28
Show file tree
Hide file tree
Showing 36 changed files with 60 additions and 49 deletions.
2 changes: 1 addition & 1 deletion action-sheet/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion app-launcher/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
12 changes: 6 additions & 6 deletions app/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
4 changes: 2 additions & 2 deletions browser/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion camera/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion clipboard/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion device/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion dialog/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion filesystem/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.1.1",
"@capacitor/core": "^5.1.1",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.1.1",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
11 changes: 11 additions & 0 deletions geolocation/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,17 @@ Request location permissions. Will throw if system location services are disabl
### Type Aliases


#### Position

A <a href="#position">Position</a> is an array of coordinates.
https://tools.ietf.org/html/rfc7946#section-3.1.1
Array should contain between two and three elements.
The previous GeoJSON specification allowed more elements (e.g., which could be used to represent M values),
but the current specification only allows X, Y, and (optionally) Z to be defined.

<code>number[]</code>


#### WatchPositionCallback

<code>(position: <a href="#position">Position</a> | null, err?: any): void</code>
Expand Down
2 changes: 1 addition & 1 deletion geolocation/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion google-maps/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "^1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion haptics/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
8 changes: 4 additions & 4 deletions keyboard/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"@capacitor/android": "^5.0.0",
"@capacitor/cli": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
4 changes: 2 additions & 2 deletions local-notifications/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ If the device has entered [Doze](https://developer.android.com/training/monitori
* [`listChannels()`](#listchannels)
* [`checkPermissions()`](#checkpermissions)
* [`requestPermissions()`](#requestpermissions)
* [`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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"@capacitor/android": "^5.0.0",
"@capacitor/cli": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
4 changes: 2 additions & 2 deletions motion/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion network/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion preferences/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
8 changes: 4 additions & 4 deletions push-notifications/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"@capacitor/android": "^5.0.0",
"@capacitor/cli": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion screen-orientation/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion screen-reader/README.md
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion share/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion splash-screen/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"@capacitor/android": "^5.0.0",
"@capacitor/cli": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion status-bar/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion text-zoom/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion toast/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@capacitor/android": "^5.0.0",
"@capacitor/core": "^5.0.0",
"@capacitor/docgen": "0.2.0",
"@capacitor/docgen": "0.2.2",
"@capacitor/ios": "^5.0.0",
"@ionic/eslint-config": "^0.3.0",
"@ionic/prettier-config": "~1.0.1",
Expand Down

0 comments on commit be9ff28

Please sign in to comment.