diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-12 05:43:14 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-12 05:43:14 +0000 |
| commit | 8dd16259287f58f9273002717ec4d27e97127719 (patch) | |
| tree | 3863e62a53829a84037444beab3abd4ed9dfc7d0 /tools/moztreedocs | |
| parent | Releasing progress-linux version 126.0.1-1~progress7.99u1. (diff) | |
| download | firefox-8dd16259287f58f9273002717ec4d27e97127719.tar.xz firefox-8dd16259287f58f9273002717ec4d27e97127719.zip | |
Merging upstream version 127.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'tools/moztreedocs')
| -rw-r--r-- | tools/moztreedocs/docs/jsdoc-support.rst | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/tools/moztreedocs/docs/jsdoc-support.rst b/tools/moztreedocs/docs/jsdoc-support.rst index 100fb92dac..2c1d5843b6 100644 --- a/tools/moztreedocs/docs/jsdoc-support.rst +++ b/tools/moztreedocs/docs/jsdoc-support.rst @@ -1,6 +1,25 @@ jsdoc support ============= +ESLint support +-------------- + +If you are looking to enable JSDoc generation for your documents, please also +enable the ESLint plugin for JSDoc if it is not already enabled. + +In the top-level :searchfox:`.eslintrc.js file <.eslintrc.js>` there are currently +two sections where the ``valid-jsdoc`` and ``require-jsdoc`` rules are enabled. +Please check that your component is not excluded from these sections. If it is, +you should remove the exclusion and fix any instances that are raised by running + +.. code-block:: shell + + ./mach eslint path/to/component/ + + +Enabling JSDoc generation +------------------------- + Here is a quick example, for the public AddonManager :ref:`API <AddonManager Reference>` To use it for your own code: @@ -8,9 +27,9 @@ To use it for your own code: #. Check that JSDoc generates the output you expect (you may need to use a @class annotation on "object initializer"-style class definitions for instance) #. Create an `.rst file`, which may contain explanatory text as well as the API docs. The minimum will look something like - `this <https://firefox-source-docs.mozilla.org/_sources/toolkit/mozapps/extensions/addon-manager/AddonManager.rst.txt>`__ + `this <https://firefox-source-docs.mozilla.org/_sources/toolkit/mozapps/extensions/addon-manager/AddonManager.rst.txt>`__. #. Ensure your component is on the js_source_path here in the sphinx - config: https://hg.mozilla.org/mozilla-central/file/72ee4800d415/tools/docs/conf.py#l46 + config: https://hg.mozilla.org/mozilla-central/file/72ee4800d415/tools/docs/conf.py#l46 #. Run `mach doc` locally to generate the output and confirm that it looks correct. |