@exports
=============================

.. rst:directive:: @exports

   :Syntax: ``@exports <moduleName>``
   :Overview:

      In JSDoc 3.3.0 and later, ``<moduleName>`` may include the ``module:``
      prefix. In previous versions, you must omit this prefix.

      Use the @exports tag when documenting JavaScript modules that export
      anything other than the “exports” object or the “module.exports”
      property.

   :Examples:

      In modules where you are using the special “exports” object, the
      @exports tag is never needed. JSDoc automatically recognizes that this
      object’s members are being exported. Similarly, JSDoc automatically
      recognizes the special “module.exports” property in Node.js modules.

      .. code-block:: js
         :caption: CommonJS module

         /**
          * A module that says hello!
          * @module hello/world
          */

         /** Say hello. */
         exports.sayHello = function() {
             return 'Hello world';
         };

      .. code-block:: js
         :caption: Node.js module

         /**
          * A module that shouts hello!
          * @module hello/world
          */

         /** SAY HELLO. */
         module.exports = function() {
             return "HELLO WORLD";
         };

      .. code-block:: js
         :caption: AMD module that exports an object literal

         define(function() {

             /**
              * A module that whispers hello!
              * @module hello/world
              */
             var exports = {};

             /** say hello. */
             exports.sayHello = function() {
                 return 'hello world';
             };

             return exports;
         });

      .. code-block:: js
         :caption: AMD module that exports a constructor

         define(function() {
             /**
              * A module that creates greeters.
              * @module greeter
              */

             /**
              * @constructor
              * @param {string} subject - The subject to greet.
              */
             var exports = function(subject) {
                 this.subject = subject || 'world';
             };

             /** Say hello to the subject. */
             exports.prototype.sayHello = function() {
                 return 'Hello ' + this.subject;
             };

             return exports;
         });

      If your module exports an object named anything other than “exports” or
      “module.exports”, use the @exports tag to indicate what is being
      exported.

      .. code-block:: js
         :caption: AMD module that exports an object

         define(function () {

             /**
              * A module that says hello!
              * @exports hello/world
              */
             var ns = {};

             /** Say hello. */
             ns.sayHello = function() {
                 return 'Hello world';
             };

             return ns;
         });