Skip to content

Commit fbdf8e9

Browse files
Bug 1694136 - [marionette] Remove marionette internals jsdoc r=webdriver-reviewers,whimboo
The internals jsdoc is not used by current maintainers of marionette and is costly to maintain. Differential Revision: https://phabricator.services.mozilla.com/D132047
1 parent c2929e5 commit fbdf8e9

24 files changed

+1
-350
lines changed

remote/marionette/doc/CodeStyle.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ a re-build.
173173

174174
[XPCOM]: https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM
175175
[strict mode]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode
176+
[Mozilla eslint rules]: https://searchfox.org/mozilla-central/source/.eslintrc.js
176177
[our own specialisations]: https://searchfox.org/mozilla-central/source/remote/marionette/.eslintrc.js
177178
[linter]: #linting
178179
[copying header]: https://www.mozilla.org/en-US/MPL/headers/
@@ -207,18 +208,8 @@ These include public functions—or command implementations—on
207208
the `GeckoDriver` class, as well as all exported symbols from
208209
other modules. Documentation for non-exported symbols is not required.
209210

210-
The API documentation can be regenerated to [remote/marionette/doc/internals]
211-
so:
212-
213-
The API documentation uses [jsdoc] and is generated to <https://firefox-source-docs.mozilla.org/testing/marionette/internals> on Taskcluster. You may also build the documentation locally:
214-
215-
% ./mach doc
216-
217-
[Mozilla eslint rules]: https://searchfox.org/mozilla-central/source/.eslintrc.js
218211
[remote/marionette/doc]: https://searchfox.org/mozilla-central/source/remote/marionette/doc
219-
[remote/marionette/doc/internals]: https://searchfox.org/mozilla-central/source/remote/marionette/doc/internals
220212
[testing/geckodriver/doc]: https://searchfox.org/mozilla-central/source/testing/geckodriver/doc
221-
[jsdoc]: http://usejsdoc.org/
222213

223214

224215
Linting

remote/marionette/doc/index.rst

-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ Some further documentation can be found here:
4646
CodeStyle.md
4747
SeleniumAtoms.md
4848
Prefs.md
49-
internals/index
5049

5150

5251
Bugs

remote/marionette/doc/internals/action.rst

-4
This file was deleted.

remote/marionette/doc/internals/addon.rst

-7
This file was deleted.

remote/marionette/doc/internals/appinfo.rst

-7
This file was deleted.

remote/marionette/doc/internals/browser.rst

-20
This file was deleted.

remote/marionette/doc/internals/capture.rst

-7
This file was deleted.

remote/marionette/doc/internals/cert.rst

-4
This file was deleted.

remote/marionette/doc/internals/cookie.rst

-4
This file was deleted.

remote/marionette/doc/internals/dom.rst

-8
This file was deleted.

remote/marionette/doc/internals/driver.rst

-4
This file was deleted.

remote/marionette/doc/internals/element.rst

-144
This file was deleted.

remote/marionette/doc/internals/evaluate.rst

-4
This file was deleted.

remote/marionette/doc/internals/event.rst

-4
This file was deleted.

remote/marionette/doc/internals/index.rst

-11
This file was deleted.

remote/marionette/doc/internals/interaction.rst

-4
This file was deleted.

remote/marionette/doc/internals/message.rst

-17
This file was deleted.

remote/marionette/doc/internals/modal.rst

-4
This file was deleted.

remote/marionette/doc/internals/navigate.rst

-7
This file was deleted.

remote/marionette/doc/internals/packets.rst

-22
This file was deleted.

remote/marionette/doc/internals/prefs.rst

-17
This file was deleted.

remote/marionette/doc/internals/reftest.rst

-4
This file was deleted.

remote/marionette/doc/internals/server.rst

-12
This file was deleted.

remote/marionette/doc/internals/sync.rst

-24
This file was deleted.

0 commit comments

Comments
 (0)