quine-global/webdriverio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fixing deprecated tag display and returns (#14387)

Browse source 
* docs: fixing display when return has no description

* docs: fixing deprecated tag display to display description

* docs: fixing return typing

* docs: removing console.log

* docs: fixing HTMLElement return for WebdriverIO.Element
This commit is contained in:
Rondley Gregório 2025-04-08 19:46:18 -03:00 committed by GitHub
parent 834ae62d8d
commit 119e6167e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
21 changed files with 26 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/webdriverio/src/commands/browser/$$.ts
View file

@ -38,7 +38,7 @@ import type { Selector } from '../../types.js'
*
* @alias $$
* @param {String|Function} selector selector or JS Function to fetch multiple elements
* @return {ElementArray}
* @return {WebdriverIO.ElementArray}
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/example.html
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/multipleElements.js#L6-L7
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/multipleElements.js#L15-L24

2
packages/webdriverio/src/commands/browser/$.ts
View file

@ -57,7 +57,7 @@ import type { Selector } from '../../types.js'
*
* @alias $
* @param {String|Function|Matcher} selector selector, JS Function, or Matcher object to fetch a certain element
* @return {Element}
* @return {WebdriverIO.Element}
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/example.html
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/singleElements.js#L9-L10
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/singleElements.js#L16-L25

2
packages/webdriverio/src/commands/browser/custom$.ts
View file

@ -28,7 +28,7 @@ import type { CustomStrategyFunction } from '../../types.js'
* @example https://github.com/webdriverio/example-recipes/blob/f5730428ec3605e856e90bf58be17c9c9da891de/queryElements/customStrategy.js#L2-L11
* @example https://github.com/webdriverio/example-recipes/blob/f5730428ec3605e856e90bf58be17c9c9da891de/queryElements/example.html#L8-L12
* @example https://github.com/webdriverio/example-recipes/blob/f5730428ec3605e856e90bf58be17c9c9da891de/queryElements/customStrategy.js#L16-L19
* @return {Element}
* @return {WebdriverIO.Element}
*/
export async function custom$ (
this: WebdriverIO.Browser,

2
packages/webdriverio/src/commands/browser/react$$.ts
View file

@ -36,7 +36,7 @@ import type { ReactSelectorOptions } from '../../types.js'
* @param {ReactSelectorOptions=} options React selector options
* @param {Object=} options.props React props the element should contain
* @param {`Array<any>|number|string|object|boolean`=} options.state React state the element should be in
* @return {ElementArray}
* @return {WebdriverIO.ElementArray}
*
*/
export async function react$$ (

2
packages/webdriverio/src/commands/browser/react$.ts
View file

@ -45,7 +45,7 @@ import type { ReactSelectorOptions } from '../../types.js'
* @param {ReactSelectorOptions=} options React selector options
* @param {Object=} options.props React props the element should contain
* @param {`Array<any>|number|string|object|boolean`=} options.state React state the element should be in
* @return {Element}
* @return {WebdriverIO.Element}
*
*/
export async function react$ (

4
packages/webdriverio/src/commands/browser/scroll.ts
View file

@ -19,8 +19,8 @@ const log = logger('webdriverio')
* </example>
*
* @alias element.scroll
* @param {number=} x horizontal scroll position (default: `0`)
* @param {number=} y vertical scroll position (default: `0`)
* @param {number} [x=0] horizontal scroll position (default: `0`)
* @param {number} [y=0] vertical scroll position (default: `0`)
* @uses protocol/execute
* @type utility
*

2
packages/webdriverio/src/commands/element/$$.ts
View file

@ -42,7 +42,7 @@
*
* @alias $$
* @param {String|Function|Matcher} selector selector, JS Function, or Matcher object to fetch multiple elements
* @return {ElementArray}
* @return {WebdriverIO.ElementArray}
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/example.html
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/multipleElements.js#L6-L7
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/multipleElements.js#L15-L24

2
packages/webdriverio/src/commands/element/$.ts
View file

@ -57,7 +57,7 @@
*
* @alias $
* @param {String|Function|Matcher} selector selector, JS Function, or Matcher object to fetch a certain element
* @return {Element}
* @return {WebdriverIO.Element}
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/example.html
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/singleElements.js#L9-L10
* @example https://github.com/webdriverio/example-recipes/blob/59c122c809d44d343c231bde2af7e8456c8f086c/queryElements/singleElements.js#L16-L25

2
packages/webdriverio/src/commands/element/custom$$.ts
View file

@ -28,7 +28,7 @@ import type { CustomStrategyFunction } from '../../types.js'
* @alias custom$$
* @param {string} strategyName
* @param {*} strategyArguments
* @return {ElementArray}
* @return {WebdriverIO.ElementArray}
*/
export async function custom$$ (
this: WebdriverIO.Element,

2
packages/webdriverio/src/commands/element/custom$.ts
View file

@ -30,7 +30,7 @@ import type { CustomStrategyFunction } from '../../types.js'
* @example https://github.com/webdriverio/example-recipes/blob/f5730428ec3605e856e90bf58be17c9c9da891de/queryElements/customStrategy.js#L2-L11
* @example https://github.com/webdriverio/example-recipes/blob/f5730428ec3605e856e90bf58be17c9c9da891de/queryElements/example.html#L8-L12
* @example https://github.com/webdriverio/example-recipes/blob/f5730428ec3605e856e90bf58be17c9c9da891de/queryElements/customStrategy.js#L16-L19
* @return {Element}
* @return {WebdriverIO.Element}
*/
export async function custom$ (
this: WebdriverIO.Element,

2
packages/webdriverio/src/commands/element/getElement.ts
View file

@ -13,7 +13,7 @@ import type { ChainablePromiseElement } from '../../types.js'
* </example>
*
* @alias element.getElement
* @return {Element}
* @return {WebdriverIO.Element}
* @type utility
*
*/

2
packages/webdriverio/src/commands/element/getElements.ts
View file

@ -13,7 +13,7 @@ import type { ChainablePromiseArray } from '../../types.js'
* </example>
*
* @alias element.getElements
* @return {Element}
* @return {WebdriverIO.ElementArray}
* @type utility
*
*/

2
packages/webdriverio/src/commands/element/nextElement.ts
View file

@ -18,7 +18,7 @@
* </example>
*
* @alias element.nextElement
* @return {Element}
* @return {WebdriverIO.Element}
* @type utility
*/

2
packages/webdriverio/src/commands/element/parentElement.ts
View file

@ -18,7 +18,7 @@
* </example>
*
* @alias element.parentElement
* @return {Element}
* @return {WebdriverIO.Element}
* @type utility
*/
export function parentElement (this: WebdriverIO.Element) {

2
packages/webdriverio/src/commands/element/previousElement.ts
View file

@ -18,7 +18,7 @@
* </example>
*
* @alias element.previousElement
* @return {Element}
* @return {WebdriverIO.Element}
* @type utility
*/
export function previousElement (this: WebdriverIO.Element) {

2
packages/webdriverio/src/commands/element/react$$.ts
View file

@ -37,7 +37,7 @@ import type { ReactSelectorOptions } from '../../types.js'
* @param {ReactSelectorOptions=} options React selector options
* @param {Object=} options.props React props the element should contain
* @param {`Array<any>|number|string|object|boolean`=} options.state React state the element should be in
* @return {ElementArray}
* @return {WebdriverIO.ElementArray}
*
*/
export async function react$$(

2
packages/webdriverio/src/commands/element/react$.ts
View file

@ -46,7 +46,7 @@ import type { ReactSelectorOptions } from '../../types.js'
* @param {ReactSelectorOptions=} options React selector options
* @param {Object=} options.props React props the element should contain
* @param {`Array<any>|number|string|object|boolean`=} options.state React state the element should be in
* @return {Element}
* @return {WebdriverIO.Element}
*
*/
export async function react$(

2
packages/webdriverio/src/commands/element/shadow$$.ts
View file

@ -34,7 +34,7 @@ const log = logger('webdriverio')
*
* @alias element.shadow$$
* @param {String|Function} selector selector or JS Function to fetch a certain element
* @return {ElementArray}
* @return {WebdriverIO.ElementArray}
* @type utility
*
*/

2
packages/webdriverio/src/commands/element/shadow$.ts
View file

@ -32,7 +32,7 @@ const log = logger('webdriverio')
*
* @alias element.shadow$
* @param {String|Function} selector selector or JS Function to fetch a certain element
* @return {Element}
* @return {WebdriverIO.Element}
* @type utility
*
*/

5
scripts/templates/template.eta
View file

@ -114,7 +114,10 @@ const ext = it.path.extname(filename).slice(1);
<% if (it.returns) { %>
##### Returns
- **&lt;<%= it.returns.type %>&gt; <code><var><%= it.returns.name %></var></code>:** <%= it.returns.description %>
- **&lt;<%= it.returns.type %>&gt;**
<% if (it.returns.description) { %>
**<code><var><%= it.returns.name %></var></code>:** <%= it.returns.description %>
<% } %>
<% } %>
<% if (it.throwsTags.length) { %>

4
scripts/utils/formatter.ts
View file

@ -51,7 +51,7 @@ export default function (docfile: {
const fires: string[] = []
const listens: string[] = []
const exampleReferences: string[] = []
let tagDeprecated = false
let tagDeprecated = ''
let tagSee = ''
let tagVersion = ''
let tagAuthor = ''
@ -141,7 +141,7 @@ export default function (docfile: {
break
}
case 'deprecated': {
tagDeprecated = true
tagDeprecated = source[0].source.split('@deprecated')[1].trim()
break
}
case 'mobileElement': {