jsdoc / jsdoc/jsdoc

There is no table of contents for most items.

Open
#2,026 1 comment 0 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

/**
 *  @module doctest
 *
 *  @description This is a description of the doctest module.
 */

/**
 *  Description of first function.
 *
 *    @param a Parameter A.
 *    @param b Parameter B.
 *    @param c Parameter C.
 */
function exportedFunction1 (a, b, c) { }

/**
 *  Description of second function.
 *
 *    @param a Parameter A.
 *    @param b Parameter B.
 *    @param c Parameter C.
 */
function exportedFunction2 (a, b, c) { }

Expected: Generated documentation has either a table of contents or a list of documented functions somewhere.

Actual: Generated documentation provides no overview (in any form, other than a somewhat superfluous link to the single documented module from index.html) of the code being documented. This is in contrast to all other documentation generators, and to effective documentation in general.

Consequence: Output is only somewhat useful, especially for large bodies of code.

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 by reproducing the embedded doctest example and inspecting the generated documentation and index.html. Determine where documented functions are currently exposed, then add an overview such as a table of contents or function list; done means the generated output provides that overview for the example and larger documented modules.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.