jsdoc / jsdoc/jsdoc

Unable to generate members for const.

Open
#1,853 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
15.5k
Forks
1.5k
Avg merge
10d 23h
Merged PRs (30d)
1

Description

Hi,

I am unable to generate any member for exported consts. I see the const as a member but none of its members are generated i.e. function1, function2 ...

Input code
 /**
 * @const
 * @memberof Service.Configuration
 */
export const configuration = {
  /**
   * @function function1
   *  @returns {Boolean}
   */
  function1: () => true,
  /** @function
   *  @returns {Boolean}
   */
  function2: () => true,
  /** @function
   *  @returns {Boolean}
   */
  function3: () => true,
  /** @function
   *  @returns {Boolean}
   */
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the supplied JavaScript example and trace how JSDoc handles exported const objects and their members. Verify the behavior with this input; done means function1, function2, and function3 are generated as members of configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.