W3C WebDriver spec links not working for a lot of pages

[garg3133]

There are a lot of pages in the API docs which have an invalid link in the "W3C WebDriver spec" section. See this page for one such example.

• We need to fix all such invalid links in the API docs. This can ideally be fixed by adding the WebDriver spec doc link as the prefix if the link does not start with http. This change only needs to be made at a single place in this repo where we convert the JSDoc tags to HTML.
• Additionally, all the links related to W3C should be placed in the @link tag in JSDoc throughout the Nightwatch APIs (present in nightwatchjs/nightwatch repo), and all other links should be put in the @see tag.

[ParmarKrishna]

I understood the issue here, and I am working on it.

[ParmarKrishna]

all the links related to W3C should be placed in the @link tag in JSDoc throughout the Nightwatch APIs (present in nightwatchjs/nightwatch repo), and all other links should be put in the @see tag.

Regarding this, there are two versions of @link tag found in the files. For example, lib/api/client-commands/document/source.js has entire link (such as, @link https://www.w3.org/TR/webdriver#getting-page-source) in the tag, where as other files such as, lib/api/client-commands/document/executeAsyncScript.js has only /#execute-async-script in the tag.

Hence, should link tag contain only #references-page or entire link as shown above?
Additionally, the URL is also incorrect.

[garg3133]

The @link tag can contain links in /#execute-async-script format only, no need to specify complete URLs.

There are also some pages where the @link tag is incorrect (ex. the link present in element.clickAndHold page doesn't lead to anywhere), we'd need to fix those as well (or remove them if there's no such section and instead add a selenium doc reference).

Also, if there are some non-webdriver spec related links present in the @link tag, we would need to move them to @see tag. Similarly, if there are some webdriver spec related links present in @see tag, we'd move them to @link tag.

[ParmarKrishna]

okay. understood.