tools/moztreedocs/docs/jsdoc-support.rst

   1 jsdoc support
   2 =============
   3
   4 ESLint support
   5 --------------
   6
   7 If you are looking to enable JSDoc generation for your documents, please also
   8 enable the ESLint plugin for JSDoc if it is not already enabled.
   9
  10 In the top-level :searchfox:`.eslintrc-rollouts.js file <.eslintrc-rollouts.js>`
  11 there are currently two sections where the ``valid-jsdoc`` and ``require-jsdoc``
  12 rules are enabled. Please check that your component is not excluded from these
  13 sections. If it is, you should remove the exclusion and fix any instances that
  14 are raised by running
  15
  16 .. code-block:: shell
  17
  18     ./mach eslint path/to/component/
  19
  20
  21 Enabling JSDoc generation
  22 -------------------------
  23
  24 Here is a quick example, for the public AddonManager :ref:`API <AddonManager Reference>`
  25
  26 To use it for your own code:
  27
  28 #. Check that JSDoc generates the output you expect (you may need to use a @class annotation on "object initializer"-style class definitions for instance)
  29
  30 #. Create an `.rst file`, which may contain explanatory text as well as the API docs. The minimum will look something like
  31    `this <https://firefox-source-docs.mozilla.org/_sources/toolkit/mozapps/extensions/addon-manager/AddonManager.rst.txt>`__.
  32
  33 #. Ensure your component is on the js_source_path here in the sphinx
  34    config: https://hg.mozilla.org/mozilla-central/file/72ee4800d415/tools/docs/conf.py#l46
  35
  36 #. Run `mach doc` locally to generate the output and confirm that it looks correct.