No grouping when using CommonJS modules

[ahmehri]

When using CommonJS modules as the following example:

/**
 * Used to request web services.
 * @module client
 */
module.exports = {
  /**
   * requester.requestTransaction web service.
   *
   * @memberof client
   * @function
   * @param req Transaction request
   * @return {string} Signer id
   */
  requestTransaction: requestTransaction,
 
  /**
   * transactionSigner.requestOTP web service.
   *
   * @function
   * @param signerId the signer ID
   * @return {Object} the server response
   */
  requestOTP: requestOTP,
};

the generated html will be the following:

This is not the good grouping and I think that's because only ES2015 modules are supported. The same example when used with ESM:

/**
 * Used to request web services.
 * @module
 */
export default {
  requestTransaction: requestTransaction,
  requestOTP: requestOTP,
};
 
/**
 * requester.requestTransaction web service.
 *
 * @memberof client
 * @param req Transaction request
 * @return {string} Signer id
 */
async function requestTransaction(req) {
}
 
/**
 * transactionSigner.requestOTP web service.
 *
 * @memberof client
 * @param signerId the signer ID
 * @return {Object} the server response
 */
async function requestOTP(signerId) {
}

will generate the correct html:

[tmcw]

Thanks for the report!

Part of this was connected to #679 and will be fixed:

/**
 * Used to request web services.
 */
module.exports = {
  /**
   * requester.requestTransaction web service.
   *
   * @function
   * @param req Transaction request
   * @return {string} Signer id
   */
  requestTransaction: requestTransaction,
 
  /**
   * transactionSigner.requestOTP web service.
   *
   * @function
   * @param signerId the signer ID
   * @return {Object} the server response
   */
  requestOTP: requestOTP,
};

Properly nests and has membership. Looking into approaches for renaming the top-level module now.

[rejhgadellaa]

Hmm not sure if I like the idea of doing the documentation between the module.exports brackets.

I prefer writing my code like this:

/** @module mymod */

/** function 1 */
function fn1() {}

/** function 2 */
function fn2() {}

module.exports = {
  fn1: fn1,
  fn2: fn2,
};

instead of:

/** @module mymod */

function fn1() {}

function fn2() {}

module.exports = {
  /** function 1 */
  fn1: fn1,
  /** function 2 */
  fn2: fn2,
};

because in the 2nd example (and the one that does group everything correctly) my docblocks are not in the same place as the function they are describing..

Is there any progress on making the 1st example work?