From 8dd16259287f58f9273002717ec4d27e97127719 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 12 Jun 2024 07:43:14 +0200 Subject: Merging upstream version 127.0. Signed-off-by: Daniel Baumann --- tools/moztreedocs/docs/jsdoc-support.rst | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) (limited to 'tools/moztreedocs') 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 ` 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 `__ + `this `__. #. 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. -- cgit v1.2.3