Skip to content

@description seems to be ignored ? #341

@bojand

Description

@bojand

Looking at #9 it says @description tag is supported. I can't seem to get it to show up using either ~3.0.0 or ~4.0.0-beta and the default template.

Sample code:

/**
 * Returns number x 2
 *
 * @description Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut
 * labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
 * aliquip ex ea commodo consequat.
 *
 * @param {number} num - number to double
 * @returns {number} the number doubled
 */
module.exports = function(num) {
  return num * 2;
}

Should this work? Basically I would like to have a shorter description (ie @summary which doesn't seem to be supported yet?) and then once the documentation section expanded, the greater detail (@description). @desc also gets ignored.

Thanks

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy