Skip to content

How to document @property having spaces in name #1468

@vcshox

Description

@vcshox

As title, I am trying to document an object using @typedef and @Property, for example:

  /**
   * @typedef {object} theObj
   * @property Prop 1 {string} property one
   */
  const theObj = {
    'Prop 1': 'property 1'
  }

And the document table of theObj shows

Name Type Description
Prop string 1 property one

I have no idea how to make jsdoc display

Name Type Description
Prop 1 string property one

BTW, I am using template DocStrap, not sure if this relates to it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions